AddDataSource
Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
Request Syntax
POST /2021-01-01/opensearch/domain/DomainName/dataSource HTTP/1.1
Content-type: application/json
{
"DataSourceType": { ... },
"Description": "string",
"Name": "string"
}URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The name of the domain to add the data source to.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- 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.
Required: Yes
- 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-]*$Required: No
- Name
-
A name for the data source.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 80.
Pattern:
[a-z][a-z0-9_]+Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Message": "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.
- Message
-
A message associated with creation of 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.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
