Skip to content
AWS for Query.Farm

aws.amplify.get_app

Example SQL Queries

SELECT * FROM
aws.amplify.get_app
WHERE
"app_id" = 'VALUE';

Description

Returns an existing Amplify app specified by an app ID.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The unique ID for an Amplify app. 

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
app

Represents the different branches of a repository for building, deploying, and hosting an Amplify app. 

STRUCT(
    "app_id" VARCHAR,
    "app_arn" VARCHAR,
    "name" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "description" VARCHAR,
    "repository" VARCHAR,
    "platform" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "iam_service_role_arn" VARCHAR,
    "environment_variables" MAP(VARCHAR, VARCHAR),
    "default_domain" VARCHAR,
    "enable_branch_auto_build" BOOLEAN,
    "enable_branch_auto_deletion" BOOLEAN,
    "enable_basic_auth" BOOLEAN,
    "basic_auth_credentials" VARCHAR,
    "custom_rules" STRUCT(
        "source" VARCHAR,
        "target" VARCHAR,
        "status" VARCHAR,
        "condition" VARCHAR
    )[],
    "production_branch" STRUCT(
        "last_deploy_time" TIMESTAMP_S,
        "status" VARCHAR,
        "thumbnail_url" VARCHAR,
        "branch_name" VARCHAR
    ),
    "build_spec" VARCHAR,
    "custom_headers" VARCHAR,
    "enable_auto_branch_creation" BOOLEAN,
    "auto_branch_creation_patterns" VARCHAR[],
    "auto_branch_creation_config" STRUCT(
        "stage" VARCHAR,
        "framework" VARCHAR,
        "enable_auto_build" BOOLEAN,
        "environment_variables" MAP(VARCHAR, VARCHAR),
        "basic_auth_credentials" VARCHAR,
        "enable_basic_auth" BOOLEAN,
        "enable_performance_mode" BOOLEAN,
        "build_spec" VARCHAR,
        "enable_pull_request_preview" BOOLEAN,
        "pull_request_environment_name" VARCHAR
    ),
    "repository_clone_method" VARCHAR,
    "cache_config" STRUCT(
        "type" VARCHAR
    )
)
Show child fields
app.app_arn

The Amazon Resource Name (ARN) of the Amplify app.

app.app_id

The unique ID of the Amplify app.

app.auto_branch_creation_config

Describes the automated branch creation configuration for the Amplify app.

Show child fields
app.auto_branch_creation_config.basic_auth_credentials

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

app.auto_branch_creation_config.build_spec

The build specification (build spec) for the autocreated branch.

app.auto_branch_creation_config.enable_auto_build

Enables auto building for the autocreated branch.

app.auto_branch_creation_config.enable_basic_auth

Enables basic authorization for the autocreated branch.

app.auto_branch_creation_config.enable_performance_mode

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

app.auto_branch_creation_config.enable_pull_request_preview

Enables pull request previews for the autocreated branch.

app.auto_branch_creation_config.environment_variables

The environment variables for the autocreated branch.

app.auto_branch_creation_config.framework

The framework for the autocreated branch.

app.auto_branch_creation_config.pull_request_environment_name

The Amplify environment name for the pull request.

app.auto_branch_creation_config.stage

Describes the current stage for the autocreated branch.

app.auto_branch_creation_patterns[]
app.basic_auth_credentials

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

app.build_spec

Describes the content of the build specification (build spec) for the Amplify app.

app.cache_config

The cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.

Show child fields
app.cache_config.type

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key.

app.create_time

Creates a date and time for the Amplify app.

app.custom_headers

Describes the custom HTTP headers for the Amplify app.

app.custom_rules[]
Show child fields
app.custom_rules[].condition

The condition for a URL rewrite or redirect rule, such as a country code.

app.custom_rules[].source

The source pattern for a URL rewrite or redirect rule.

app.custom_rules[].status

The status code for a URL rewrite or redirect rule.

200

Represents a 200 rewrite rule.

301

Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL.

302

Represents a 302 temporary redirect rule.

404

Represents a 404 redirect rule.

404-200

Represents a 404 rewrite rule.

app.custom_rules[].target

The target pattern for a URL rewrite or redirect rule.

app.default_domain

The default domain for the Amplify app.

app.description

The description for the Amplify app.

app.enable_auto_branch_creation

Enables automated branch creation for the Amplify app.

app.enable_basic_auth

Enables basic authorization for the Amplify app's branches.

app.enable_branch_auto_build

Enables the auto-building of branches for the Amplify app.

app.enable_branch_auto_deletion

Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.

app.environment_variables

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

app.iam_service_role_arn

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

app.name

The name for the Amplify app.

app.platform

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

app.production_branch

Describes the information about a production branch of the Amplify app.

Show child fields
app.production_branch.branch_name

The branch name for the production branch.

app.production_branch.last_deploy_time

The last deploy time of the production branch.

app.production_branch.status

The status of the production branch.

app.production_branch.thumbnail_url

The thumbnail URL for the production branch.

app.repository

The Git repository for the Amplify app.

app.repository_clone_method

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

app.tags

The tag for the Amplify app.

app.update_time

Updates the date and time for the Amplify app.