AWS API Changes

2024/05/22 - Amazon OpenSearch Service - 3 updated api methods

Changes This release adds support for enabling or disabling a data source configured as part of Zero-ETL integration with Amazon S3, by setting its status.

GetDataSource (updated)

Link ¶
Changes (response)

{'Status': 'ACTIVE | DISABLED'}

Retrieves information about a direct query data source.

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 to get information about.

rtype

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 response.

ListDataSources (updated)

Link ¶
Changes (response)

{'DataSources': {'Status': 'ACTIVE | DISABLED'}}

Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

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',
            'Status': 'ACTIVE'|'DISABLED'
        },
    ]
}

Response Structure

(dict) --

The result of a ListDataSources operation.
- DataSources (list) --
  
  A list of data sources associated with specified domain.
  - (dict) --
    
    Details about a direct-query data source.
    - 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.

UpdateDataSource (updated)

Link ¶
Changes (request)

{'Status': 'ACTIVE | DISABLED'}

Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

See also: AWS API Documentation

Request Syntax

client.update_data_source(
    DomainName='string',
    Name='string',
    DataSourceType={
        'S3GlueDataCatalog': {
            'RoleArn': 'string'
        }
    },
    Description='string',
    Status='ACTIVE'|'DISABLED'
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type Name

string

param Name

[REQUIRED]

The name of the data source to modify.

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

An Amazon S3 data source.
- RoleArn (string) --
  
  >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.

type Description

string

param Description

A new description of the data source.

type Status

string

param Status

The status of the data source update request.

rtype

dict

returns

Response Syntax

{
    'Message': 'string'
}

Response Structure

(dict) --

The result of an UpdateDataSource operation.
- Message (string) --
  
  A message associated with the updated data source.