OpenSearchService / Client / describe_data_source_attachment

describe_data_source_attachment¶

OpenSearchService.Client.describe_data_source_attachment(**kwargs)¶

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

response = client.describe_data_source_attachment(
    id='string',
    dataSourceArn='string'
)

Parameters:

id (string) –
[REQUIRED]

The unique identifier or name of the OpenSearch application.
dataSourceArn (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'attachmentId': 'string',
    'id': 'string',
    'arn': 'string',
    'dataSourceArn': 'string',
    'status': 'PENDING'|'ATTACHED'|'FAILED'
}

Response Structure

(dict) –
- attachmentId (string) –
  
  The unique identifier assigned to the data source attachment.
- id (string) –
  
  The unique identifier of the OpenSearch application.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
- dataSourceArn (string) –
  
  The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
- status (string) –
  
  The status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED.

Exceptions

OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException