Amazon OpenSearch Service

2023/11/29 - Amazon OpenSearch Service - 5 new api methods

Changes  Launching Amazon OpenSearch Service support for new zero-ETL integration with Amazon S3. Customers can now manage their direct query data sources to Amazon S3 programatically

UpdateDataSource (new) Link ¶

Updates the data source on the domain.

See also: AWS API Documentation

Request Syntax

client.update_data_source(
    DomainName='string',
    Name='string',
    DataSourceType={
        'S3GlueDataCatalog': {
            'RoleArn': 'string'
        }
    },
    Description='string'
)
type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type Name

string

param Name

[REQUIRED]

The name of the data source.

type DataSourceType

dict

param DataSourceType

[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) --

    The data source for the AWS S3 Glue Data Catalog.

    • RoleArn (string) --

      The role ARN for the AWS S3 Glue Data Catalog.

type Description

string

param Description

A description of the data source.

rtype

dict

returns

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) --

    The result of an UpdateDataSource operation.

    • Message (string) --

      A message associated with the data source.

AddDataSource (new) Link ¶

Adds the data source on the domain.

See also: AWS API Documentation

Request Syntax

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

string

param DomainName

[REQUIRED]

The name of the domain.

type Name

string

param Name

[REQUIRED]

The name of the data source.

type DataSourceType

dict

param DataSourceType

[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) --

    The data source for the AWS S3 Glue Data Catalog.

    • RoleArn (string) --

      The role ARN for the AWS S3 Glue Data Catalog.

type Description

string

param Description

A description of the data source.

rtype

dict

returns

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) --

    The result of an AddDataSource operation.

    • Message (string) --

      A message associated with the data source.

GetDataSource (new) Link ¶

Describes the data source details.

See also: AWS API Documentation

Request Syntax

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

string

param DomainName

[REQUIRED]

The name of the domain.

type Name

string

param Name

[REQUIRED]

The name of the data source.

rtype

dict

returns

Response Syntax

{
    'DataSourceType': {
        'S3GlueDataCatalog': {
            'RoleArn': 'string'
        }
    },
    'Name': 'string',
    'Description': 'string'
}

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) --

        The data source for the AWS S3 Glue Data Catalog.

        • RoleArn (string) --

          The role ARN for the AWS S3 Glue Data Catalog.

    • Name (string) --

      The name of the data source.

    • Description (string) --

      A description of the data source.

DeleteDataSource (new) Link ¶

Deletes the data source.

See also: AWS API Documentation

Request Syntax

client.delete_data_source(
    DomainName='string',
    Name='string'
)
type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type Name

string

param Name

[REQUIRED]

The name of the data source.

rtype

dict

returns

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) --

    The result of a GetDataSource operation.

    • Message (string) --

      A message associated with the initiated request.

ListDataSources (new) Link ¶

A list of the data source details of the domain.

See also: AWS API Documentation

Request Syntax

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

string

param DomainName

[REQUIRED]

The name of the domain.

rtype

dict

returns

Response Syntax

{
    'DataSources': [
        {
            'DataSourceType': {
                'S3GlueDataCatalog': {
                    'RoleArn': 'string'
                }
            },
            'Name': 'string',
            'Description': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The result of a ListDataSources operation.

    • DataSources (list) --

      A list of the data sources.

      • (dict) --

        Details about the data sources.

        • 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) --

            The data source for the AWS S3 Glue Data Catalog.

            • RoleArn (string) --

              The role ARN for the AWS S3 Glue Data Catalog.

        • Name (string) --

          The name of the data source.

        • Description (string) --

          A description of the data source.