OpenSearchService / Client / list_direct_query_data_sources

list_direct_query_data_sources#

OpenSearchService.Client.list_direct_query_data_sources(**kwargs)#

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

Request Syntax

response = client.list_direct_query_data_sources(
    NextToken='string'
)

Parameters:

NextToken (string) – When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DirectQueryDataSources': [
        {
            'DataSourceName': 'string',
            'DataSourceType': {
                'CloudWatchLog': {
                    'RoleArn': 'string'
                },
                'SecurityLake': {
                    'RoleArn': 'string'
                }
            },
            'Description': 'string',
            'OpenSearchArns': [
                'string',
            ],
            'DataSourceArn': 'string',
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
- DirectQueryDataSources (list) –
  
  A list of the direct query data sources that are returned by the ListDirectQueryDataSources API operation.
  - (dict) –
    
    The configuration details for a data source that can be directly queried.
    - 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.
    - TagList (list) –
      
      A list of tags attached to a direct query data source.
      - (dict) –
        
        A tag (key-value pair) for an Amazon OpenSearch Service resource.
        
        Key (string) –
        
        The tag key. Tag keys must be unique for the domain to which they are attached.
        
        Value (string) –
        
        The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Exceptions

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