

# AddDirectQueryDataSource
<a name="API_AddDirectQueryDataSource"></a>

 Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data. 

## Request Syntax
<a name="API_AddDirectQueryDataSource_RequestSyntax"></a>

```
POST /2021-01-01/opensearch/directQueryDataSource HTTP/1.1
Content-type: application/json

{
   "DataSourceAccessPolicy": "string",
   "DataSourceName": "string",
   "DataSourceType": { ... },
   "Description": "string",
   "OpenSearchArns": [ "string" ],
   "TagList": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_AddDirectQueryDataSource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_AddDirectQueryDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataSourceAccessPolicy](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-DataSourceAccessPolicy"></a>
 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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 102400.  
Pattern: `.*`   
Required: No

 ** [DataSourceName](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-DataSourceName"></a>
 A unique, user-defined label to identify the data source within your OpenSearch Service environment.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 80.  
Pattern: `[a-z][a-z0-9_]+`   
Required: Yes

 ** [DataSourceType](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-DataSourceType"></a>
 The supported AWS service that you want to use as the source for direct queries in OpenSearch Service.   
Type: [DirectQueryDataSourceType](API_DirectQueryDataSourceType.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [Description](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-Description"></a>
 An optional text field for providing additional context and details about the data source.   
Type: String  
Length Constraints: Maximum length of 1000.  
Pattern: `^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$`   
Required: No

 ** [OpenSearchArns](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-OpenSearchArns"></a>
 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.   
Type: Array of strings  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** [TagList](#API_AddDirectQueryDataSource_RequestSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-request-TagList"></a>
A list of tags attached to a domain.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_AddDirectQueryDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataSourceArn": "string"
}
```

## Response Elements
<a name="API_AddDirectQueryDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataSourceArn](#API_AddDirectQueryDataSource_ResponseSyntax) **   <a name="opensearchservice-AddDirectQueryDataSource-response-DataSourceArn"></a>
 The unique, system-generated identifier that represents the data source.   
Type: String

## Errors
<a name="API_AddDirectQueryDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** BaseException **   
An error occurred while processing the request.    
 ** message **   
A description of the error.
HTTP Status Code: 400

 ** DisabledOperationException **   
An error occured because the client wanted to access an unsupported operation.  
HTTP Status Code: 409

 ** InternalException **   
Request processing failed because of an unknown error, exception, or internal failure.  
HTTP Status Code: 500

 ** LimitExceededException **   
An exception for trying to create more than the allowed number of resources or sub-resources.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
An exception for accessing or deleting a resource that doesn't exist.  
HTTP Status Code: 409

 ** ValidationException **   
An exception for accessing or deleting a resource that doesn't exist.  
HTTP Status Code: 400

## See Also
<a name="API_AddDirectQueryDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AddDirectQueryDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AddDirectQueryDataSource) 