GetDirectQueryDataSource
Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.
Request Syntax
GET /2021-01-01/opensearch/directQueryDataSource/DataSourceName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DataSourceName
-
A unique, user-defined label that identifies the data source within your OpenSearch Service environment.
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
{
"DataSourceAccessPolicy": "string",
"DataSourceArn": "string",
"DataSourceName": "string",
"DataSourceType": { ... },
"Description": "string",
"OpenSearchArns": [ "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.
- DataSourceAccessPolicy
-
The IAM access policy document that defines the permissions for accessing the direct query data source. Returns the current policy configuration in JSON format, or null if no custom policy is configured.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 102400.
Pattern:
.* - DataSourceArn
-
The unique, system-generated identifier that represents the data source.
Type: String
- 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_]+ - DataSourceType
-
The supported AWS service that is used 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.
- Description
-
A description that provides 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-]*$ - OpenSearchArns
-
A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.
Type: Array of strings
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
