OpenSearchService / Client / list_data_source_attachments

list_data_source_attachments¶

OpenSearchService.Client.list_data_source_attachments(**kwargs)¶

Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states ( PENDING, ATTACHED, and FAILED).

Request Syntax

response = client.list_data_source_attachments(
    id='string',
    nextToken='string',
    maxResults=123
)

Parameters:

id (string) –
[REQUIRED]

The unique identifier or name of the OpenSearch application to list attachments for.
nextToken (string) – The pagination token from a previous call to retrieve the next set of results.
maxResults (integer) – The maximum number of results to return per page. The default is 50.

Return type:

dict

Returns:

Response Syntax

{
    'attachments': [
        {
            'attachmentId': 'string',
            'dataSourceArn': 'string',
            'status': 'PENDING'|'ATTACHED'|'FAILED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- attachments (list) –
  
  A list of data source attachment summaries for the specified application.
  - (dict) –
    
    Summary information about a data source attachment, including its identifier, data source ARN, and current status.
    - attachmentId (string) –
      
      The unique identifier assigned to the data source attachment.
    - 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 current status of the data source attachment. Valid values are PENDING, ATTACHED, and FAILED.
- nextToken (string) –
  
  The pagination token to use in a subsequent call to retrieve the next set of results.

Exceptions

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