[ aws . appsync ]

list-data-sources

Description

Lists the data sources for a given API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-data-sources is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: dataSources

Synopsis

  list-data-sources
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API ID.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

dataSources -> (list)

The DataSource objects.

(structure)

Describes a data source.

dataSourceArn -> (string)

The data source ARN.

name -> (string)

The name of the data source.

description -> (string)

The description of the data source.

type -> (string)

The type of the data source.

• AWS_LAMBDA : The data source is an Amazon Web Services 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.

• NONE : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.

• HTTP : The data source is an HTTP endpoint.

• RELATIONAL_DATABASE : The data source is a relational database.

serviceRoleArn -> (string)

The Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.

dynamodbConfig -> (structure)

Amazon DynamoDB settings.

tableName -> (string)

The table name.

awsRegion -> (string)

The Amazon Web Services Region.

useCallerCredentials -> (boolean)

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

deltaSyncConfig -> (structure)

The DeltaSyncConfig for a versioned datasource.

baseTableTTL -> (long)

The number of minutes an Item is stored in the datasource.

deltaSyncTableName -> (string)

The Delta Sync table name.

deltaSyncTableTTL -> (long)

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

versioned -> (boolean)

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

lambdaConfig -> (structure)

Amazon Web Services Lambda settings.

lambdaFunctionArn -> (string)

The ARN for the Lambda function.

elasticsearchConfig -> (structure)

Amazon OpenSearch Service settings.

endpoint -> (string)

The endpoint.

awsRegion -> (string)

The Amazon Web Services Region.

openSearchServiceConfig -> (structure)

Amazon OpenSearch Service settings.

endpoint -> (string)

The endpoint.

awsRegion -> (string)

The Amazon Web Services Region.

httpConfig -> (structure)

HTTP endpoint settings.

endpoint -> (string)

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

authorizationConfig -> (structure)

The authorization config in case the HTTP endpoint requires authorization.

authorizationType -> (string)

The authorization type required by the HTTP endpoint.

• AWS_IAM : The authorization type is Sigv4.

awsIamConfig -> (structure)

The Identity and Access Management settings.

signingRegion -> (string)

The signing region for Identity and Access Management authorization.

signingServiceName -> (string)

The signing service name for Identity and Access Management authorization.

relationalDatabaseConfig -> (structure)

Relational database settings.

relationalDatabaseSourceType -> (string)

Source type for the relational database.

• RDS_HTTP_ENDPOINT : The relational database source type is an Amazon RDS HTTP endpoint.

rdsHttpEndpointConfig -> (structure)

Amazon RDS HTTP endpoint settings.

awsRegion -> (string)

Amazon Web Services Region for RDS HTTP endpoint.

dbClusterIdentifier -> (string)

Amazon RDS cluster ARN.

databaseName -> (string)

Logical database name.

schema -> (string)

Logical schema name.

awsSecretStoreArn -> (string)

Amazon Web Services secret store ARN for database credentials.

nextToken -> (string)

An identifier to be passed in the next request to this operation to return the next set of items in the list.