OpenSearchService / Client / list_data_sources

list_data_sources#

OpenSearchService.Client.list_data_sources(**kwargs)#

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

Request Syntax

response = client.list_data_sources(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain.

Return type:

dict

Returns:

Response Syntax

{
    'DataSources': [
        {
            'DataSourceType': {
                'S3GlueDataCatalog': {
                    'RoleArn': 'string'
                }
            },
            'Name': 'string',
            'Description': 'string',
            'Status': 'ACTIVE'|'DISABLED'
        },
    ]
}

Response Structure

(dict) –

The result of a ListDataSources operation.
- DataSources (list) –
  
  A list of data sources associated with specified domain.
  - (dict) –
    
    Details about a direct-query data source.
    - DataSourceType (dict) –
      
      The type of data source.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: S3GlueDataCatalog. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - S3GlueDataCatalog (dict) –
        
        An Amazon S3 data source.
        
        RoleArn (string) –
        
        >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
    - Name (string) –
      
      The name of the data source.
    - Description (string) –
      
      A description of the data source.
    - Status (string) –
      
      The status of the data source.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.DisabledOperationException
OpenSearchService.Client.exceptions.DependencyFailureException