OpenSearchService / Client / get_direct_query_data_source

get_direct_query_data_source

OpenSearchService.Client.get_direct_query_data_source(**kwargs)

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.get_direct_query_data_source(
    DataSourceName='string'
)
Parameters:

DataSourceName (string) –

[REQUIRED]

A unique, user-defined label that identifies the data source within your OpenSearch Service environment.

Return type:

dict

Returns:

Response Syntax

{
    'DataSourceName': 'string',
    'DataSourceType': {
        'CloudWatchLog': {
            'RoleArn': 'string'
        },
        'SecurityLake': {
            'RoleArn': 'string'
        }
    },
    'Description': 'string',
    'OpenSearchArns': [
        'string',
    ],
    'DataSourceArn': 'string'
}

Response Structure

  • (dict) –

    • DataSourceName (string) –

      A unique, user-defined label to identify the data source within your OpenSearch Service environment.

    • DataSourceType (dict) –

      The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: CloudWatchLog, SecurityLake. 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'}

      • CloudWatchLog (dict) –

        Specifies CloudWatch Logs as a type of data source for direct queries.

        • RoleArn (string) –

          The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source.

      • SecurityLake (dict) –

        Specifies Security Lake as a type of data source for direct queries.

        • RoleArn (string) –

          The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source.

    • Description (string) –

      A description that provides additional context and details about the data source.

    • OpenSearchArns (list) –

      A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.

      • (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 unique, system-generated identifier that represents the data source.

Exceptions