ListDataSources
Lists the data sources for a given API.
Request Syntax
GET /apis/apiId
/datasources?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- apiId
-
The API ID.
Required: Yes
- maxResults
-
The maximum number of results that you want the request to return.
Valid Range: Minimum value of 0. Maximum value of 25.
- nextToken
-
An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[\\S]+
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"dataSources": [
{
"dataSourceArn": "string",
"description": "string",
"dynamodbConfig": {
"awsRegion": "string",
"deltaSyncConfig": {
"baseTableTTL": number,
"deltaSyncTableName": "string",
"deltaSyncTableTTL": number
},
"tableName": "string",
"useCallerCredentials": boolean,
"versioned": boolean
},
"elasticsearchConfig": {
"awsRegion": "string",
"endpoint": "string"
},
"eventBridgeConfig": {
"eventBusArn": "string"
},
"httpConfig": {
"authorizationConfig": {
"authorizationType": "string",
"awsIamConfig": {
"signingRegion": "string",
"signingServiceName": "string"
}
},
"endpoint": "string"
},
"lambdaConfig": {
"lambdaFunctionArn": "string"
},
"metricsConfig": "string",
"name": "string",
"openSearchServiceConfig": {
"awsRegion": "string",
"endpoint": "string"
},
"relationalDatabaseConfig": {
"rdsHttpEndpointConfig": {
"awsRegion": "string",
"awsSecretStoreArn": "string",
"databaseName": "string",
"dbClusterIdentifier": "string",
"schema": "string"
},
"relationalDatabaseSourceType": "string"
},
"serviceRoleArn": "string",
"type": "string"
}
],
"nextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- dataSources
-
The
DataSource
objects.Type: Array of DataSource objects
- nextToken
-
An identifier to pass in the next request to this operation to return the next set of items in the list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[\\S]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
HTTP Status Code: 400
- InternalFailureException
-
An internal AWS AppSync error occurred. Try your request again.
HTTP Status Code: 500
- NotFoundException
-
The resource specified in the request was not found. Check the resource, and then try again.
HTTP Status Code: 404
- UnauthorizedException
-
You aren't authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: