Skip to content
AWS for Query.Farm

aws.amplifybackend.get_backend_api

Example SQL Queries

SELECT * FROM
aws.amplifybackend.get_backend_api
WHERE
"app_id" = 'VALUE'
AND "backend_environment_name" = 'VALUE'
AND "resource_name" = 'VALUE';

Description

Gets the details for a backend API.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

The app ID.

VARCHAR
backend_environment_name Required Input Column

The name of the backend environment.

VARCHAR
resource_name Required Input Column

The name of this resource.

VARCHAR
resource_config Input Column

The resource configuration for this response object.

STRUCT(
    "additional_auth_types" STRUCT(
        "mode" VARCHAR,
        "settings" STRUCT(
            "cognito_user_pool_id" VARCHAR,
            "description" VARCHAR,
            "expiration_time" DOUBLE,
            "open_id_auth_ttl" VARCHAR,
            "open_id_client_id" VARCHAR,
            "open_id_iat_ttl" VARCHAR,
            "open_id_issue_url" VARCHAR,
            "open_id_provider_name" VARCHAR
        )
    )[],
    "api_name" VARCHAR,
    "conflict_resolution" STRUCT(
        "resolution_strategy" VARCHAR
    ),
    "default_auth_type" STRUCT(
        "mode" VARCHAR,
        "settings" STRUCT(
            "cognito_user_pool_id" VARCHAR,
            "description" VARCHAR,
            "expiration_time" DOUBLE,
            "open_id_auth_ttl" VARCHAR,
            "open_id_client_id" VARCHAR,
            "open_id_iat_ttl" VARCHAR,
            "open_id_issue_url" VARCHAR,
            "open_id_provider_name" VARCHAR
        )
    ),
    "service" VARCHAR,
    "transform_schema" VARCHAR
)
Show child fields
resource_config.additional_auth_types[]
Show child fields
resource_config.additional_auth_types[].mode

Describes the authentication mode.

resource_config.additional_auth_types[].settings

Describes settings for the authentication mode.

Show child fields
resource_config.additional_auth_types[].settings.cognito_user_pool_id

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

resource_config.additional_auth_types[].settings.description

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

resource_config.additional_auth_types[].settings.expiration_time

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

resource_config.additional_auth_types[].settings.open_id_auth_ttl

The expiry time for the OpenID authentication mechanism.

resource_config.additional_auth_types[].settings.open_id_client_id

The clientID for openID, if openID was used as an authentication setting to access your data models.

resource_config.additional_auth_types[].settings.open_id_iat_ttl

The expiry time for the OpenID authentication mechanism.

resource_config.additional_auth_types[].settings.open_id_issue_url

The openID issuer URL, if openID was used as an authentication setting to access your data models.

resource_config.additional_auth_types[].settings.open_id_provider_name

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

resource_config.api_name

The API name used to interact with the data model, configured as a part of your Amplify project.

resource_config.conflict_resolution

The conflict resolution strategy for your data stored in the data models.

Show child fields
resource_config.conflict_resolution.resolution_strategy

The strategy for conflict resolution.

resource_config.default_auth_type

The default authentication type for interacting with the configured data models in your Amplify project.

Show child fields
resource_config.default_auth_type.mode

Describes the authentication mode.

resource_config.default_auth_type.settings

Describes settings for the authentication mode.

Show child fields
resource_config.default_auth_type.settings.cognito_user_pool_id

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

resource_config.default_auth_type.settings.description

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

resource_config.default_auth_type.settings.expiration_time

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

resource_config.default_auth_type.settings.open_id_auth_ttl

The expiry time for the OpenID authentication mechanism.

resource_config.default_auth_type.settings.open_id_client_id

The clientID for openID, if openID was used as an authentication setting to access your data models.

resource_config.default_auth_type.settings.open_id_iat_ttl

The expiry time for the OpenID authentication mechanism.

resource_config.default_auth_type.settings.open_id_issue_url

The openID issuer URL, if openID was used as an authentication setting to access your data models.

resource_config.default_auth_type.settings.open_id_provider_name

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

resource_config.service

The service used to provision and interact with the data model.

resource_config.transform_schema

The definition of the data model in the annotated transform of the GraphQL schema.

_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
error

If the request fails, this error is returned.

VARCHAR