Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDirectQueryDataSources

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

Request Syntax


GET /2021-01-01/opensearch/directQueryDataSource?nexttoken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken: When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DirectQueryDataSources": [ 
      { 
         "DataSourceArn": "string",
         "DataSourceName": "string",
         "DataSourceType": { ... },
         "Description": "string",
         "OpenSearchArns": [ "string" ],
         "TagList": [ 
            { 
               "Key": "string",
               "Value": "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.

DirectQueryDataSources

A list of the direct query data sources that are returned by the ListDirectQueryDataSources API operation.

Type: Array of DirectQueryDataSource objects

NextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

BaseException

An error occurred while processing the request.

message: A description of the error.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400