Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appsync ]



Retrieves a DataSource object.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--api-id <value>
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--api-id (string)


--name (string)

The name of the data source.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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


dataSource -> (structure)

The DataSource object.

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.

  • AMAZON_DYNAMODB : The data source is an Amazon DynamoDB table.
  • AMAZON_ELASTICSEARCH : The data source is an Amazon Elasticsearch Service domain.
  • AWS_LAMBDA : The data source is an AWS Lambda function.
  • NONE : There is no data source. This type is used when 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.

serviceRoleArn -> (string)

The IAM service role ARN for the data source. The system assumes this role when accessing the data source.

dynamodbConfig -> (structure)

DynamoDB settings.

tableName -> (string)

The table name.

awsRegion -> (string)

The AWS region.

useCallerCredentials -> (boolean)

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

lambdaConfig -> (structure)

Lambda settings.

lambdaFunctionArn -> (string)

The ARN for the Lambda function.

elasticsearchConfig -> (structure)

Amazon Elasticsearch settings.

endpoint -> (string)

The endpoint.

awsRegion -> (string)

The AWS 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(s). If the port is not specified, AWS AppSync will use the default port 80 for http endpoint and port 443 for https endpoints.