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

DescribeDataSourceAttachment

Returns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment record exists for the specified application and data source combination.

Request Syntax


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

{
   "dataSourceArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

id

The unique identifier or name of the OpenSearch application.

Pattern: [a-z0-9]{3,30}

Required: Yes

Request Body

The request accepts the following data in JSON format.

dataSourceArn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Type: String

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

Pattern: .*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "attachmentId": "string",
   "dataSourceArn": "string",
   "id": "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.

arn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Type: String

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

Pattern: .*

attachmentId

The unique identifier assigned to the data source attachment.

Type: String

dataSourceArn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Type: String

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

Pattern: .*

id

The unique identifier of the OpenSearch application.

Type: String

Pattern: [a-z0-9]{3,30}

status

The status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED.

Type: String

Valid Values: PENDING | ATTACHED | FAILED

Errors

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

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

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