add_direct_query_data_source
¶
add_direct_query_data_source(
data_source_name: DirectQueryDataSourceName,
data_source_type: DirectQueryDataSourceType,
*,
config_overrides: Optional[OpenSearchClientConfig] = None,
description: Optional[DirectQueryDataSourceDescription] = None,
open_search_arns: Optional[DirectQueryOpenSearchARNList] = None,
data_source_access_policy: Optional[PolicyDocument] = None,
tag_list: Optional[TagList] = None,
) -> AddDirectQueryDataSourceResponse
Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.
Parameters:
-
data_source_name(DirectQueryDataSourceName) –A unique, user-defined label to identify the data source within your OpenSearch Service environment.
-
data_source_type(DirectQueryDataSourceType) –The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.
-
description(Optional[DirectQueryDataSourceDescription], default:None) –An optional text field for providing additional context and details about the data source.
-
open_search_arns(Optional[DirectQueryOpenSearchARNList], default:None) –An optional list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. This field is required for CloudWatchLogs and SecurityLake datasource types.
-
data_source_access_policy(Optional[PolicyDocument], default:None) –An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.
Raises:
-
BaseException–An error occurred while processing the request.
-
DisabledOperationException–An error occured because the client wanted to access an unsupported operation.
-
InternalException–Request processing failed because of an unknown error, exception, or internal failure.
-
LimitExceededException–An exception for trying to create more than the allowed number of resources or sub-resources.
-
ResourceNotFoundException–An exception for accessing or deleting a resource that doesn't exist.
-
ValidationException–An exception for accessing or deleting a resource that doesn't exist.
-
UnknownServiceError–The service returned an error code this client does not model.