Skip to content
AWS for Query.Farm

aws.appsync.get_source_api_association

Example SQL Queries

SELECT * FROM
aws.appsync.get_source_api_association
WHERE
"merged_api_identifier" = 'VALUE'
AND "association_id" = 'VALUE';

Description

Retrieves a SourceApiAssociation object.

Table Definition

Column NameColumn Data Type
association_id Required Input Column

The ID generated by the AppSync service for the source API association.

VARCHAR
merged_api_identifier Required Input Column

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

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
source_api_association

The SourceApiAssociation object data.

STRUCT(
    "association_id" VARCHAR,
    "association_arn" VARCHAR,
    "source_api_id" VARCHAR,
    "source_api_arn" VARCHAR,
    "merged_api_arn" VARCHAR,
    "merged_api_id" VARCHAR,
    "description" VARCHAR,
    "source_api_association_config" STRUCT(
        "merge_type" VARCHAR
    ),
    "source_api_association_status" VARCHAR,
    "source_api_association_status_detail" VARCHAR,
    "last_successful_merge_date" TIMESTAMP_S
)
Show child fields
source_api_association.association_arn

The Amazon Resource Name (ARN) of the source API association.

source_api_association.association_id

The ID generated by the AppSync service for the source API association.

source_api_association.description

The description field.

source_api_association.last_successful_merge_date

The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

source_api_association.merged_api_arn

The Amazon Resource Name (ARN) of the AppSync Merged API.

source_api_association.merged_api_id

The ID of the AppSync Merged API.

source_api_association.source_api_arn

The Amazon Resource Name (ARN) of the AppSync source API.

source_api_association.source_api_association_config

The SourceApiAssociationConfig object data.

Show child fields
source_api_association.source_api_association_config.merge_type

The property that indicates which merging option is enabled in the source API association.

Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

source_api_association.source_api_association_status

The state of the source API association.

source_api_association.source_api_association_status_detail

The detailed message related to the current state of the source API association.

source_api_association.source_api_id

The ID of the AppSync source API.