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

GetDataSource

Retrieves information about a direct query data source.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/dataSource/DataSourceName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the domain.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

DataSourceName

The name of the data source to get information about.

Length Constraints: Minimum length of 3. Maximum length of 80.

Pattern: [a-z][a-z0-9_]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataSourceType": { ... },
   "Description": "string",
   "Name": "string",
   "Status": "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.

DataSourceType

The type of data source.

Type: DataSourceType object

Note: This object is a Union. Only one member of this object can be specified or returned.

Description

A description of the data source.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: ^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$

Name

The name of the data source.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 80.

Pattern: [a-z][a-z0-9_]+

Status

The status of the data source.

Type: String

Valid Values: ACTIVE | DISABLED

Errors

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

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

DependencyFailureException

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

HTTP Status Code: 424

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