OpenSearchService / Client / get_data_source

get_data_source#

OpenSearchService.Client.get_data_source(**kwargs)#

Retrieves information about a direct query data source.

Request Syntax

response = client.get_data_source(
    DomainName='string',
    Name='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain.
Name (string) –
[REQUIRED]

The name of the data source to get information about.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

The result of a GetDataSource operation.
- 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