OpenSearchService / Client / update_data_source
update_data_source#
- OpenSearchService.Client.update_data_source(**kwargs)#
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
response = client.update_data_source( DomainName='string', Name='string', DataSourceType={ 'S3GlueDataCatalog': { 'RoleArn': 'string' } }, Description='string', Status='ACTIVE'|'DISABLED' )
- Parameters:
DomainName (string) –
[REQUIRED]
The name of the domain.
Name (string) –
[REQUIRED]
The name of the data source to modify.
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 new description of the data source.
Status (string) – The status of the data source update request.
- Return type:
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.
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