Skip to content
AWS for Query.Farm

aws.amplify.get_backend_environment

Example SQL Queries

SELECT * FROM
aws.amplify.get_backend_environment
WHERE
"app_id" = 'VALUE'
AND "environment_name" = 'VALUE';

Description

Returns a backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The unique id for an Amplify app. 

VARCHAR
environment_name Required Input Column

The name for the backend environment. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
backend_environment

Describes the backend environment for an Amplify app. 

STRUCT(
    "backend_environment_arn" VARCHAR,
    "environment_name" VARCHAR,
    "stack_name" VARCHAR,
    "deployment_artifacts" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S
)
Show child fields
backend_environment.backend_environment_arn

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

backend_environment.create_time

The creation date and time for a backend environment that is part of an Amplify app.

backend_environment.deployment_artifacts

The name of deployment artifacts.

backend_environment.environment_name

The name for a backend environment that is part of an Amplify app.

backend_environment.stack_name

The AWS CloudFormation stack name of a backend environment.

backend_environment.update_time

The last updated date and time for a backend environment that is part of an Amplify app.