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

AddDirectQueryDataSource

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

Request Syntax


POST /2021-01-01/opensearch/directQueryDataSource HTTP/1.1
Content-type: application/json

{
   "DataSourceAccessPolicy": "string",
   "DataSourceName": "string",
   "DataSourceType": { ... },
   "Description": "string",
   "OpenSearchArns": [ "string" ],
   "TagList": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DataSourceAccessPolicy

An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 102400.

Pattern: .*

Required: No

DataSourceName

A unique, user-defined label to identify the data source within your OpenSearch Service environment.

Type: String

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

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

Required: Yes

DataSourceType

The supported AWS service that you want to use as the source for direct queries in OpenSearch Service.

Type: DirectQueryDataSourceType object

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

Required: Yes

Description

An optional text field for providing additional context and details about the data source.

Type: String

Length Constraints: Maximum length of 1000.

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

Required: No

OpenSearchArns

An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*

Required: No

TagList

A list of tags attached to a domain.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataSourceArn": "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.

DataSourceArn

The unique, system-generated identifier that represents the data source.

Type: String

Errors

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

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

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

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