Skip to content
AWS for Query.Farm

aws.amplify.list_branches

Example SQL Queries

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

Description

Lists the branches of an Amplify app.

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
active_job_id

The ID of the active job for a branch of an Amplify app. 

VARCHAR
associated_resources

A list of custom resources that are linked to this branch. 

VARCHAR[]
Show child fields
associated_resources[]
backend

Describes the backend associated with an Amplify Branch.

This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

STRUCT(
    "stack_arn" VARCHAR
)
Show child fields
backend.stack_arn

The Amazon Resource Name (ARN) for the CloudFormation stack.

backend_environment_arn

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

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

VARCHAR
basic_auth_credentials

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

VARCHAR
branch_arn

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

VARCHAR
branch_name

The name for the branch that is part of an Amplify app. 

VARCHAR
build_spec

The build specification (build spec) content for the branch of an Amplify app. 

VARCHAR
create_time

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

TIMESTAMP_S
custom_domains

The custom domains for a branch of an Amplify app. 

VARCHAR[]
Show child fields
custom_domains[]
description

The description for the branch that is part of an Amplify app. 

VARCHAR
destination_branch

The destination branch if the branch is a pull request branch. 

VARCHAR
display_name

The display name for the branch. This is used as the default domain prefix. 

VARCHAR
enable_auto_build

Enables auto-building on push for a branch of an Amplify app. 

BOOLEAN
enable_basic_auth

Enables basic authorization for a branch of an Amplify app. 

BOOLEAN
enable_notification

Enables notifications for a branch that is part of an Amplify app. 

BOOLEAN
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. 

BOOLEAN
enable_pull_request_preview

Enables pull request previews for the branch. 

BOOLEAN
environment_variables

The environment variables specific to a branch of an Amplify app. 

MAP(VARCHAR, VARCHAR)
framework

The framework for a branch of an Amplify app. 

VARCHAR
pull_request_environment_name

The Amplify environment name for the pull request. 

VARCHAR
source_branch

The source branch if the branch is a pull request branch. 

VARCHAR
stage

The current stage for the branch that is part of an Amplify app. 

VARCHAR
tags

The tag for the branch of an Amplify app. 

MAP(VARCHAR, VARCHAR)
thumbnail_url

The thumbnail URL for the branch of an Amplify app. 

VARCHAR
total_number_of_jobs

The total number of jobs that are part of an Amplify app. 

VARCHAR
ttl

The content Time to Live (TTL) for the website in seconds. 

VARCHAR
update_time

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

TIMESTAMP_S