OpenSearchService / Client / add_data_source

add_data_source#

OpenSearchService.Client.add_data_source(**kwargs)#

Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

See also: AWS API Documentation

Request Syntax

response = client.add_data_source(
    DomainName='string',
    Name='string',
    DataSourceType={
        'S3GlueDataCatalog': {
            'RoleArn': 'string'
        }
    },
    Description='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain to add the data source to.

  • Name (string) –

    [REQUIRED]

    A name for the data source.

  • DataSourceType (dict) –

    [REQUIRED]

    The type of data source.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: S3GlueDataCatalog.

    • S3GlueDataCatalog (dict) –

      An Amazon S3 data source.

      • RoleArn (string) –

        >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

  • Description (string) – A description of the data source.

Return type:

dict

Returns:

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) –

    The result of an AddDataSource operation.

    • Message (string) –

      A message associated with creation 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

  • OpenSearchService.Client.exceptions.LimitExceededException