Skip to content
AWS for Query.Farm

aws.appsync.list_data_sources

Example SQL Queries

SELECT * FROM
aws.appsync.list_data_sources
WHERE
"api_id" = 'VALUE';

Description

Lists the data sources for a given API.

Table Definition

Column NameColumn Data Type
api_id Required Input Column

The API ID.

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
data_source_arn

The data source Amazon Resource Name (ARN).

VARCHAR
description

The description of the data source.

VARCHAR
dynamodb_config

DynamoDB settings.

STRUCT(
    "table_name" VARCHAR,
    "aws_region" VARCHAR,
    "use_caller_credentials" BOOLEAN,
    "delta_sync_config" STRUCT(
        "base_table_ttl" BIGINT,
        "delta_sync_table_name" VARCHAR,
        "delta_sync_table_ttl" BIGINT
    ),
    "versioned" BOOLEAN
)
Show child fields
dynamodb_config.aws_region

The Amazon Web Services Region.

dynamodb_config.delta_sync_config

The DeltaSyncConfig for a versioned data source.

Show child fields
dynamodb_config.delta_sync_config.base_table_ttl

The number of minutes that an Item is stored in the data source.

dynamodb_config.delta_sync_config.delta_sync_table_name

The Delta Sync table name.

dynamodb_config.delta_sync_config.delta_sync_table_ttl

The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

dynamodb_config.table_name

The table name.

dynamodb_config.use_caller_credentials

Set to TRUE to use Amazon Cognito credentials with this data source.

dynamodb_config.versioned

Set to TRUE to use Conflict Detection and Resolution with this data source.

elasticsearch_config

Amazon OpenSearch Service settings.

STRUCT(
    "endpoint" VARCHAR,
    "aws_region" VARCHAR
)
Show child fields
elasticsearch_config.aws_region

The Amazon Web Services Region.

elasticsearch_config.endpoint

The endpoint.

event_bridge_config

Amazon EventBridge settings.

STRUCT(
    "event_bus_arn" VARCHAR
)
Show child fields
event_bridge_config.event_bus_arn

The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.

http_config

HTTP endpoint settings.

STRUCT(
    "endpoint" VARCHAR,
    "authorization_config" STRUCT(
        "authorization_type" VARCHAR,
        "aws_iam_config" STRUCT(
            "signing_region" VARCHAR,
            "signing_service_name" VARCHAR
        )
    )
)
Show child fields
http_config.authorization_config

The authorization configuration in case the HTTP endpoint requires authorization.

Show child fields
http_config.authorization_config.authorization_type

The authorization type that the HTTP endpoint requires.

  • AWS_IAM: The authorization type is Signature Version 4 (SigV4).

http_config.authorization_config.aws_iam_config

The Identity and Access Management (IAM) settings.

Show child fields
http_config.authorization_config.aws_iam_config.signing_region

The signing Amazon Web Services Region for IAM authorization.

http_config.authorization_config.aws_iam_config.signing_service_name

The signing service name for IAM authorization.

http_config.endpoint

The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

lambda_config

Lambda settings.

STRUCT(
    "lambda_function_arn" VARCHAR
)
Show child fields
lambda_config.lambda_function_arn

The Amazon Resource Name (ARN) for the Lambda function.

metrics_config

Enables or disables enhanced data source metrics for specified data sources. Note that metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However, you can still set its value.

metricsConfig can be ENABLED or DISABLED.

VARCHAR
name

The name of the data source.

VARCHAR
open_search_service_config

Amazon OpenSearch Service settings.

STRUCT(
    "endpoint" VARCHAR,
    "aws_region" VARCHAR
)
Show child fields
open_search_service_config.aws_region

The Amazon Web Services Region.

open_search_service_config.endpoint

The endpoint.

relational_database_config

Relational database settings.

STRUCT(
    "relational_database_source_type" VARCHAR,
    "rds_http_endpoint_config" STRUCT(
        "aws_region" VARCHAR,
        "db_cluster_identifier" VARCHAR,
        "database_name" VARCHAR,
        "schema" VARCHAR,
        "aws_secret_store_arn" VARCHAR
    )
)
Show child fields
relational_database_config.rds_http_endpoint_config

Amazon RDS HTTP endpoint settings.

Show child fields
relational_database_config.rds_http_endpoint_config.aws_region

Amazon Web Services Region for Amazon RDS HTTP endpoint.

relational_database_config.rds_http_endpoint_config.aws_secret_store_arn

Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.

relational_database_config.rds_http_endpoint_config.database_name

Logical database name.

relational_database_config.rds_http_endpoint_config.db_cluster_identifier

Amazon RDS cluster Amazon Resource Name (ARN).

relational_database_config.rds_http_endpoint_config.schema

Logical schema name.

relational_database_config.relational_database_source_type

Source type for the relational database.

  • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.

service_role_arn

The Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.

VARCHAR
type

The type of the data source.

  • AWS_LAMBDA: The data source is an Lambda function.

  • AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

  • AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.

  • AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.

  • AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

  • NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.

  • HTTP: The data source is an HTTP endpoint.

  • RELATIONAL_DATABASE: The data source is a relational database.

VARCHAR