# Amazon OpenSearch Service The following actions are supported by Amazon OpenSearch Service: + [AcceptInboundConnection](API_AcceptInboundConnection.md) + [AddDataSource](API_AddDataSource.md) + [AddDirectQueryDataSource](API_AddDirectQueryDataSource.md) + [AddTags](API_AddTags.md) + [AssociatePackage](API_AssociatePackage.md) + [AssociatePackages](API_AssociatePackages.md) + [AuthorizeVpcEndpointAccess](API_AuthorizeVpcEndpointAccess.md) + [CancelDomainConfigChange](API_CancelDomainConfigChange.md) + [CancelServiceSoftwareUpdate](API_CancelServiceSoftwareUpdate.md) + [CreateApplication](API_CreateApplication.md) + [CreateDomain](API_CreateDomain.md) + [CreateIndex](API_CreateIndex.md) + [CreateOutboundConnection](API_CreateOutboundConnection.md) + [CreatePackage](API_CreatePackage.md) + [CreateVpcEndpoint](API_CreateVpcEndpoint.md) + [DeleteApplication](API_DeleteApplication.md) + [DeleteDataSource](API_DeleteDataSource.md) + [DeleteDirectQueryDataSource](API_DeleteDirectQueryDataSource.md) + [DeleteDomain](API_DeleteDomain.md) + [DeleteInboundConnection](API_DeleteInboundConnection.md) + [DeleteIndex](API_DeleteIndex.md) + [DeleteOutboundConnection](API_DeleteOutboundConnection.md) + [DeletePackage](API_DeletePackage.md) + [DeleteVpcEndpoint](API_DeleteVpcEndpoint.md) + [DeregisterCapability](API_DeregisterCapability.md) + [DescribeDomain](API_DescribeDomain.md) + [DescribeDomainAutoTunes](API_DescribeDomainAutoTunes.md) + [DescribeDomainChangeProgress](API_DescribeDomainChangeProgress.md) + [DescribeDomainConfig](API_DescribeDomainConfig.md) + [DescribeDomainHealth](API_DescribeDomainHealth.md) + [DescribeDomainNodes](API_DescribeDomainNodes.md) + [DescribeDomains](API_DescribeDomains.md) + [DescribeDryRunProgress](API_DescribeDryRunProgress.md) + [DescribeInboundConnections](API_DescribeInboundConnections.md) + [DescribeInsightDetails](API_DescribeInsightDetails.md) + [DescribeInstanceTypeLimits](API_DescribeInstanceTypeLimits.md) + [DescribeOutboundConnections](API_DescribeOutboundConnections.md) + [DescribePackages](API_DescribePackages.md) + [DescribeReservedInstanceOfferings](API_DescribeReservedInstanceOfferings.md) + [DescribeReservedInstances](API_DescribeReservedInstances.md) + [DescribeVpcEndpoints](API_DescribeVpcEndpoints.md) + [DissociatePackage](API_DissociatePackage.md) + [DissociatePackages](API_DissociatePackages.md) + [GetApplication](API_GetApplication.md) + [GetCapability](API_GetCapability.md) + [GetCompatibleVersions](API_GetCompatibleVersions.md) + [GetDataSource](API_GetDataSource.md) + [GetDefaultApplicationSetting](API_GetDefaultApplicationSetting.md) + [GetDirectQueryDataSource](API_GetDirectQueryDataSource.md) + [GetDomainMaintenanceStatus](API_GetDomainMaintenanceStatus.md) + [GetIndex](API_GetIndex.md) + [GetPackageVersionHistory](API_GetPackageVersionHistory.md) + [GetUpgradeHistory](API_GetUpgradeHistory.md) + [GetUpgradeStatus](API_GetUpgradeStatus.md) + [ListApplications](API_ListApplications.md) + [ListDataSources](API_ListDataSources.md) + [ListDirectQueryDataSources](API_ListDirectQueryDataSources.md) + [ListDomainMaintenances](API_ListDomainMaintenances.md) + [ListDomainNames](API_ListDomainNames.md) + [ListDomainsForPackage](API_ListDomainsForPackage.md) + [ListInsights](API_ListInsights.md) + [ListInstanceTypeDetails](API_ListInstanceTypeDetails.md) + [ListPackagesForDomain](API_ListPackagesForDomain.md) + [ListScheduledActions](API_ListScheduledActions.md) + [ListTags](API_ListTags.md) + [ListVersions](API_ListVersions.md) + [ListVpcEndpointAccess](API_ListVpcEndpointAccess.md) + [ListVpcEndpoints](API_ListVpcEndpoints.md) + [ListVpcEndpointsForDomain](API_ListVpcEndpointsForDomain.md) + [PurchaseReservedInstanceOffering](API_PurchaseReservedInstanceOffering.md) + [PutDefaultApplicationSetting](API_PutDefaultApplicationSetting.md) + [RegisterCapability](API_RegisterCapability.md) + [RejectInboundConnection](API_RejectInboundConnection.md) + [RemoveTags](API_RemoveTags.md) + [RevokeVpcEndpointAccess](API_RevokeVpcEndpointAccess.md) + [StartDomainMaintenance](API_StartDomainMaintenance.md) + [StartServiceSoftwareUpdate](API_StartServiceSoftwareUpdate.md) + [UpdateApplication](API_UpdateApplication.md) + [UpdateDataSource](API_UpdateDataSource.md) + [UpdateDirectQueryDataSource](API_UpdateDirectQueryDataSource.md) + [UpdateDomainConfig](API_UpdateDomainConfig.md) + [UpdateIndex](API_UpdateIndex.md) + [UpdatePackage](API_UpdatePackage.md) + [UpdatePackageScope](API_UpdatePackageScope.md) + [UpdateScheduledAction](API_UpdateScheduledAction.md) + [UpdateVpcEndpoint](API_UpdateVpcEndpoint.md) + [UpgradeDomain](API_UpgradeDomain.md) # AcceptInboundConnection Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` PUT /2021-01-01/opensearch/cc/inboundConnection/ConnectionId/accept HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ConnectionId](#API_AcceptInboundConnection_RequestSyntax) ** The ID of the inbound connection to accept. Length Constraints: Minimum length of 10. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connection": { "ConnectionId": "string", "ConnectionMode": "string", "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connection](#API_AcceptInboundConnection_ResponseSyntax) ** Information about the accepted inbound connection. Type: [InboundConnection](API_InboundConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** 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 ## See Also 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/AcceptInboundConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AcceptInboundConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AcceptInboundConnection) # AddDataSource Creates a new direct-query data source to the specified domain. For more information, see [Creating Amazon OpenSearch Service data source integrations with Amazon S3](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html). ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/dataSource HTTP/1.1 Content-type: application/json { "DataSourceType": { ... }, "Description": "string", "Name": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_AddDataSource_RequestSyntax) ** The name of the domain to add the data source to. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataSourceType](#API_AddDataSource_RequestSyntax) ** The type of data source. Type: [DataSourceType](API_DataSourceType.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [Description](#API_AddDataSource_RequestSyntax) ** A description of the data source. Type: String Length Constraints: Maximum length of 1000. Pattern: `^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$` Required: No ** [Name](#API_AddDataSource_RequestSyntax) ** A name for the data source. Type: String Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_AddDataSource_ResponseSyntax) ** A message associated with creation of the data source. Type: String ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 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/AddDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AddDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AddDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AddDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AddDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AddDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AddDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AddDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AddDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AddDataSource) # AddDirectQueryDataSource Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data. ## Request Syntax ``` 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 The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DataSourceAccessPolicy](#API_AddDirectQueryDataSource_RequestSyntax) ** 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 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) ** 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) ** 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) ** 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 list of tags attached to a domain. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataSourceArn": "string" } ``` ## Response Elements 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) ** The unique, system-generated identifier that represents the data source. Type: String ## Errors 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 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) # AddTags Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application. Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see [Tagging Amazon OpenSearch Service resources](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html). ## Request Syntax ``` POST /2021-01-01/tags HTTP/1.1 Content-type: application/json { "ARN": "string", "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ARN](#API_AddTags_RequestSyntax) ** Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or application to which you want to attach resource tags. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` Required: Yes ** [TagList](#API_AddTags_RequestSyntax) ** List of resource tags. Type: Array of [Tag](API_Tag.md) objects Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors 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 ** 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 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of AddTags. #### Sample Request ``` POST /2021-01-01/tags HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.add-tags X-Amz-Date: 20240212T212009Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-security-token, Signature=92f6df10a81b7b553dbdab348594794df6272ea6799e4e9bae8aec96cfa44510 Content-Length: 118 {"ARN": "arn:aws:es:us-east-1:123456789012:domain/marketing", "TagList": [{"Key": "department", "Value": "marketing"}]} ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: 6ab4cde74-63fg-4h65-1101-d1112f029bbb Content-Type: application/json Content-Length: 0 Date: Mon, 12 Feb 2024 21:20:10 GMT Connection: keep-alive ``` ## See Also 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/AddTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AddTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AddTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AddTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AddTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AddTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AddTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AddTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AddTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AddTags) # AssociatePackage Associates a package with an Amazon OpenSearch Service domain. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` POST /2021-01-01/packages/associate/PackageID/DomainName HTTP/1.1 Content-type: application/json { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "PrerequisitePackageIDList": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_AssociatePackage_RequestSyntax) ** Name of the domain to associate the package with. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PackageID](#API_AssociatePackage_RequestSyntax) ** Internal ID of the package to associate with a domain. Use `DescribePackages` to find this value. Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AssociationConfiguration](#API_AssociatePackage_RequestSyntax) ** The configuration for associating a package with an Amazon OpenSearch Service domain. Type: [PackageAssociationConfiguration](API_PackageAssociationConfiguration.md) object Required: No ** [PrerequisitePackageIDList](#API_AssociatePackage_RequestSyntax) ** A list of package IDs that must be associated with the domain before the package specified in the request can be associated. Type: Array of strings Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetails": { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetails](#API_AssociatePackage_ResponseSyntax) ** Information about a package that is associated with a domain. Type: [DomainPackageDetails](API_DomainPackageDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/AssociatePackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AssociatePackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AssociatePackage) # AssociatePackages Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously. ## Request Syntax ``` POST /2021-01-01/packages/associateMultiple HTTP/1.1 Content-type: application/json { "DomainName": "string", "PackageList": [ { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "PackageID": "string", "PrerequisitePackageIDList": [ "string" ] } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DomainName](#API_AssociatePackages_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PackageList](#API_AssociatePackages_RequestSyntax) ** A list of packages and their prerequisites to be associated with a domain. Type: Array of [PackageDetailsForAssociation](API_PackageDetailsForAssociation.md) objects Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetailsList": [ { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetailsList](#API_AssociatePackages_ResponseSyntax) ** List of information about packages that are associated with a domain. Type: Array of [DomainPackageDetails](API_DomainPackageDetails.md) objects ## Errors 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 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/AssociatePackages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AssociatePackages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AssociatePackages) # AuthorizeVpcEndpointAccess Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/authorizeVpcEndpointAccess HTTP/1.1 Content-type: application/json { "Account": "string", "Service": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_AuthorizeVpcEndpointAccess_RequestSyntax) ** The name of the OpenSearch Service domain to provide access to. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Account](#API_AuthorizeVpcEndpointAccess_RequestSyntax) ** The AWS account ID to grant access to. Type: String Pattern: `^[0-9]+$` Required: No ** [Service](#API_AuthorizeVpcEndpointAccess_RequestSyntax) ** The AWS service SP to grant access to. Type: String Valid Values: `application.opensearchservice.amazonaws.com` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AuthorizedPrincipal": { "Principal": "string", "PrincipalType": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedPrincipal](#API_AuthorizeVpcEndpointAccess_ResponseSyntax) ** Information about the AWS account or service that was provided access to the domain. Type: [AuthorizedPrincipal](API_AuthorizedPrincipal.md) object ## Errors 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 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/AuthorizeVpcEndpointAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/AuthorizeVpcEndpointAccess) # CancelDomainConfigChange Cancels a pending configuration change on an Amazon OpenSearch Service domain. ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/config/cancel HTTP/1.1 Content-type: application/json { "DryRun": boolean } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_CancelDomainConfigChange_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DryRun](#API_CancelDomainConfigChange_RequestSyntax) ** When set to `True`, returns the list of change IDs and properties that will be cancelled without actually cancelling the change. Type: Boolean Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CancelledChangeIds": [ "string" ], "CancelledChangeProperties": [ { "ActiveValue": "string", "CancelledValue": "string", "PropertyName": "string" } ], "DryRun": boolean } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CancelledChangeIds](#API_CancelDomainConfigChange_ResponseSyntax) ** The unique identifiers of the changes that were cancelled. Type: Array of strings Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ** [CancelledChangeProperties](#API_CancelDomainConfigChange_ResponseSyntax) ** The domain change properties that were cancelled. Type: Array of [CancelledChangeProperty](API_CancelledChangeProperty.md) objects ** [DryRun](#API_CancelDomainConfigChange_ResponseSyntax) ** Whether or not the request was a dry run. If `True`, the changes were not actually cancelled. Type: Boolean ## Errors 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 ** 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 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/CancelDomainConfigChange) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CancelDomainConfigChange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CancelDomainConfigChange) # CancelServiceSoftwareUpdate Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the `AutomatedUpdateDate` and when the domain's `UpdateStatus` is `PENDING_UPDATE`. For more information, see [Service software updates in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html). ## Request Syntax ``` POST /2021-01-01/opensearch/serviceSoftwareUpdate/cancel HTTP/1.1 Content-type: application/json { "DomainName": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DomainName](#API_CancelServiceSoftwareUpdate_RequestSyntax) ** Name of the OpenSearch Service domain that you want to cancel the service software update on. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ServiceSoftwareOptions](#API_CancelServiceSoftwareUpdate_ResponseSyntax) ** Container for the state of your domain relative to the latest service software. Type: [ServiceSoftwareOptions](API_ServiceSoftwareOptions.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/CancelServiceSoftwareUpdate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CancelServiceSoftwareUpdate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CancelServiceSoftwareUpdate) # CreateApplication Creates an OpenSearch UI application. For more information, see [Using the OpenSearch user interface in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html). ## Request Syntax ``` POST /2021-01-01/opensearch/application HTTP/1.1 Content-type: application/json { "appConfigs": [ { "key": "string", "value": "string" } ], "clientToken": "string", "dataSources": [ { "dataSourceArn": "string", "dataSourceDescription": "string", "iamRoleForDataSourceArn": "string" } ], "iamIdentityCenterOptions": { "enabled": boolean, "iamIdentityCenterInstanceArn": "string", "iamRoleForIdentityCenterApplicationArn": "string" }, "kmsKeyArn": "string", "name": "string", "tagList": [ { "Key": "string", "Value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [appConfigs](#API_CreateApplication_RequestSyntax) ** Configuration settings for the OpenSearch application, including administrative options. Type: Array of [AppConfig](API_AppConfig.md) objects Array Members: Maximum number of 200 items. Required: No ** [clientToken](#API_CreateApplication_RequestSyntax) ** Unique, case-sensitive identifier to ensure idempotency of the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [dataSources](#API_CreateApplication_RequestSyntax) ** The data sources to link to the OpenSearch application. Type: Array of [DataSource](API_DataSource.md) objects Required: No ** [iamIdentityCenterOptions](#API_CreateApplication_RequestSyntax) ** Configuration settings for integrating AWS IAM Identity Center with the OpenSearch application. Type: [IamIdentityCenterOptionsInput](API_IamIdentityCenterOptionsInput.md) object Required: No ** [kmsKeyArn](#API_CreateApplication_RequestSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. If provided, the application uses your customer-managed key for encryption. If omitted, the application uses an AWS-managed key. The KMS key must be in the same region as the application. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` Required: No ** [name](#API_CreateApplication_RequestSyntax) ** The unique name of the OpenSearch application. Names must be unique within an AWS Region for each account. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [tagList](#API_CreateApplication_RequestSyntax) ** A list of tags attached to a domain. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appConfigs": [ { "key": "string", "value": "string" } ], "arn": "string", "createdAt": number, "dataSources": [ { "dataSourceArn": "string", "dataSourceDescription": "string", "iamRoleForDataSourceArn": "string" } ], "iamIdentityCenterOptions": { "enabled": boolean, "iamIdentityCenterApplicationArn": "string", "iamIdentityCenterInstanceArn": "string", "iamRoleForIdentityCenterApplicationArn": "string" }, "id": "string", "kmsKeyArn": "string", "name": "string", "tagList": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [appConfigs](#API_CreateApplication_ResponseSyntax) ** Configuration settings for the OpenSearch application, including administrative options. Type: Array of [AppConfig](API_AppConfig.md) objects Array Members: Maximum number of 200 items. ** [arn](#API_CreateApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ** [createdAt](#API_CreateApplication_ResponseSyntax) ** The timestamp indicating when the OpenSearch application was created. Type: Timestamp ** [dataSources](#API_CreateApplication_ResponseSyntax) ** The data sources linked to the OpenSearch application. Type: Array of [DataSource](API_DataSource.md) objects ** [iamIdentityCenterOptions](#API_CreateApplication_ResponseSyntax) ** The IAM Identity Center settings configured for the OpenSearch application. Type: [IamIdentityCenterOptions](API_IamIdentityCenterOptions.md) object ** [id](#API_CreateApplication_ResponseSyntax) ** The unique identifier assigned to the OpenSearch application. Type: String Pattern: `[a-z0-9]{3,30}` ** [kmsKeyArn](#API_CreateApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` ** [name](#API_CreateApplication_ResponseSyntax) ** The name of the OpenSearch application. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `[a-z][a-z0-9\-]+` ** [tagList](#API_CreateApplication_ResponseSyntax) ** A list of tags attached to a domain. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/CreateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreateApplication) # CreateDomain Creates an Amazon OpenSearch Service domain. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html). ## Request Syntax ``` POST /2021-01-01/opensearch/domain HTTP/1.1 Content-type: application/json { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "MasterUserOptions": { "MasterUserARN": "string", "MasterUserName": "string", "MasterUserPassword": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "MasterBackendRole": "string", "MasterUserName": "string", "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "AutoTuneOptions": { "DesiredState": "string", "MaintenanceSchedules": [ { "CronExpressionForRecurrence": "string", "Duration": { "Unit": "string", "Value": number }, "StartAt": number } ], "UseOffPeakWindow": boolean }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainName": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterInstanceARN": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "TagList": [ { "Key": "string", "Value": "string" } ], "VPCOptions": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AccessPolicies](#API_CreateDomain_RequestSyntax) ** Identity and Access Management (IAM) policy document specifying the access policies for the new domain. Type: String Length Constraints: Minimum length of 0. Maximum length of 102400. Pattern: `.*` Required: No ** [AdvancedOptions](#API_CreateDomain_RequestSyntax) ** Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: + `"rest.action.multi.allow_explicit_index": "true" | "false"` - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. + `"indices.fielddata.cache.size": "80" ` - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. + `"indices.query.bool.max_clause_count": "1024"` - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a `TooManyClauses` error. + `"override_main_response_version": "true" | "false"` - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see [Advanced cluster parameters](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). Type: String to string map Required: No ** [AdvancedSecurityOptions](#API_CreateDomain_RequestSyntax) ** Options for fine-grained access control. Type: [AdvancedSecurityOptionsInput](API_AdvancedSecurityOptionsInput.md) object Required: No ** [AIMLOptions](#API_CreateDomain_RequestSyntax) ** Options for all machine learning features for the specified domain. Type: [AIMLOptionsInput](API_AIMLOptionsInput.md) object Required: No ** [AutoTuneOptions](#API_CreateDomain_RequestSyntax) ** Options for Auto-Tune. Type: [AutoTuneOptionsInput](API_AutoTuneOptionsInput.md) object Required: No ** [ClusterConfig](#API_CreateDomain_RequestSyntax) ** Container for the cluster configuration of a domain. Type: [ClusterConfig](API_ClusterConfig.md) object Required: No ** [CognitoOptions](#API_CreateDomain_RequestSyntax) ** Key-value pairs to configure Amazon Cognito authentication. For more information, see [Configuring Amazon Cognito authentication for OpenSearch Dashboards](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html). Type: [CognitoOptions](API_CognitoOptions.md) object Required: No ** [DeploymentStrategyOptions](#API_CreateDomain_RequestSyntax) ** Specifies the deployment strategy options for the domain. Type: [DeploymentStrategyOptions](API_DeploymentStrategyOptions.md) object Required: No ** [DomainEndpointOptions](#API_CreateDomain_RequestSyntax) ** Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. Type: [DomainEndpointOptions](API_DomainEndpointOptions.md) object Required: No ** [DomainName](#API_CreateDomain_RequestSyntax) ** Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an AWS Region. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [EBSOptions](#API_CreateDomain_RequestSyntax) ** Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. Type: [EBSOptions](API_EBSOptions.md) object Required: No ** [EncryptionAtRestOptions](#API_CreateDomain_RequestSyntax) ** Key-value pairs to enable encryption at rest. Type: [EncryptionAtRestOptions](API_EncryptionAtRestOptions.md) object Required: No ** [EngineVersion](#API_CreateDomain_RequestSyntax) ** String of format Elasticsearch\$1X.Y or OpenSearch\$1X.Y to specify the engine version for the OpenSearch Service domain. For example, `OpenSearch_1.0` or `Elasticsearch_7.9`. For more information, see [Creating and managing Amazon OpenSearch Service domains](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains). Type: String Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` Required: No ** [IdentityCenterOptions](#API_CreateDomain_RequestSyntax) ** Configuration options for enabling and managing IAM Identity Center integration within a domain. Type: [IdentityCenterOptionsInput](API_IdentityCenterOptionsInput.md) object Required: No ** [IPAddressType](#API_CreateDomain_RequestSyntax) ** Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [LogPublishingOptions](#API_CreateDomain_RequestSyntax) ** Key-value pairs to configure log publishing. Type: String to [LogPublishingOption](API_LogPublishingOption.md) object map Valid Keys: `INDEX_SLOW_LOGS | SEARCH_SLOW_LOGS | ES_APPLICATION_LOGS | AUDIT_LOGS` Required: No ** [NodeToNodeEncryptionOptions](#API_CreateDomain_RequestSyntax) ** Enables node-to-node encryption. Type: [NodeToNodeEncryptionOptions](API_NodeToNodeEncryptionOptions.md) object Required: No ** [OffPeakWindowOptions](#API_CreateDomain_RequestSyntax) ** Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used. Type: [OffPeakWindowOptions](API_OffPeakWindowOptions.md) object Required: No ** [SnapshotOptions](#API_CreateDomain_RequestSyntax) ** DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. Type: [SnapshotOptions](API_SnapshotOptions.md) object Required: No ** [SoftwareUpdateOptions](#API_CreateDomain_RequestSyntax) ** Software update options for the domain. Type: [SoftwareUpdateOptions](API_SoftwareUpdateOptions.md) object Required: No ** [TagList](#API_CreateDomain_RequestSyntax) ** List of tags to add to the domain upon creation. Type: Array of [Tag](API_Tag.md) objects Required: No ** [VPCOptions](#API_CreateDomain_RequestSyntax) ** Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). Type: [VPCOptions](API_VPCOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainStatus": { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "ARN": "string", "AutoTuneOptions": { "ErrorMessage": "string", "State": "string", "UseOffPeakWindow": boolean }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Created": boolean, "Deleted": boolean, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainEndpointV2HostedZoneId": "string", "DomainId": "string", "DomainName": "string", "DomainProcessingStatus": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "Endpoint": "string", "Endpoints": { "string" : "string" }, "EndpointV2": "string", "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Processing": boolean, "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "UpgradeProcessing": boolean, "VPCOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainStatus](#API_CreateDomain_ResponseSyntax) ** The status of the newly created domain. Type: [DomainStatus](API_DomainStatus.md) object ## Errors 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 ** InvalidTypeException ** An exception for trying to create or access a sub-resource that's either invalid or not supported. HTTP Status Code: 409 ** LimitExceededException ** An exception for trying to create more than the allowed number of resources or sub-resources. HTTP Status Code: 409 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. HTTP Status Code: 409 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of CreateDomain. #### Sample Request ``` POST /2021-01-01/opensearch/domain HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.15.0 Python/3.11.6 Darwin/23.3.0 exe/x86_64 prompt/off command/opensearch.create-domain X-Amz-Date: 20240212T202032Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-security-token, Signature=dfbf9b8975a263d23a24fead9c4a409a6c7ef1c42e67c96252bf9bb794d1ea52 Content-Length: 645 {"DomainName": "my-domain", "EngineVersion": "OpenSearch_2.11", "ClusterConfig": {"InstanceType": "r6g.xlarge.search", "InstanceCount": 10, "DedicatedMasterEnabled": true, "DedicatedMasterType": "r6g.large.search", "DedicatedMasterCount": 3}, "EBSOptions": {"EBSEnabled": true, "VolumeType": "io1", "VolumeSize": 100, "Iops": 1000}, "AccessPolicies": "{\"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::123456789012:root\" }, \"Action\": \"es:*\", \"Resource\": \"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\" } ] }", "AutoTuneOptions": {"DesiredState": "ENABLED"}} ``` #### Sample Response ``` { "DomainStatus": { "ARN": "arn:aws:es:us-east-1:123456789012:domain/my-domain", "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::478253424788:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}", "AdvancedOptions": { "override_main_response_version": "false", "rest.action.multi.allow_explicit_index": "true" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": null, "AnonymousAuthEnabled": false, "Enabled": false, "InternalUserDatabaseEnabled": false, "SAMLOptions": null }, "AutoTuneOptions": { "ErrorMessage": null, "State": "ENABLE_IN_PROGRESS", "UseOffPeakWindow": false }, "ChangeProgressDetails": { "ChangeId": "388f35e8-5d0c-44ae-bcd1-ffd468df9908", "ConfigChangeStatus": "Pending", "InitiatedBy": "CUSTOMER", "LastUpdatedTime": 1.707769234762E9, "Message": null, "StartTime": 1.707769234762E9 }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": false }, "DedicatedMasterCount": 3, "DedicatedMasterEnabled": true, "DedicatedMasterType": "r6g.large.search", "InstanceCount": 10, "InstanceType": "r6g.xlarge.search", "MultiAZWithStandbyEnabled": false, "WarmCount": null, "WarmEnabled": false, "WarmStorage": null, "WarmType": null, "ZoneAwarenessConfig": null, "ZoneAwarenessEnabled": false }, "CognitoOptions": { "Enabled": false, "IdentityPoolId": null, "RoleArn": null, "UserPoolId": null }, "Created": true, "Deleted": false, "DeploymentStrategyOptions": { "DeploymentStrategy": "Default" }, "DomainEndpointOptions": { "CustomEndpoint": null, "CustomEndpointCertificateArn": null, "CustomEndpointEnabled": false, "EnforceHTTPS": false, "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07" }, "DomainId": "123456789012/my-domain", "DomainName": "my-domain", "DomainProcessingStatus": "Creating", "EBSOptions": { "EBSEnabled": true, "Iops": 1000, "Throughput": null, "VolumeSize": 100, "VolumeType": "io1" }, "EncryptionAtRestOptions": { "Enabled": false, "KmsKeyId": null }, "Endpoint": null, "Endpoints": null, "EngineVersion": "OpenSearch_2.11", "IPAddressType": "ipv4", "LogPublishingOptions": null, "ModifyingProperties": [{ "ActiveValue": "", "Name": "AccessPolicies", "PendingValue": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"123456789012\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/my-domain/*\"}]}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "AdvancedOptions", "PendingValue": "{\"override_main_response_version\":\"false\",\"rest.action.multi.allow_explicit_index\":\"true\"}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "AdvancedSecurityOptions.AnonymousAuthDisableDate", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "AdvancedSecurityOptions.AnonymousAuthEnabled", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "AdvancedSecurityOptions.InternalUserDatabaseEnabled", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "AdvancedSecurityOptions.MasterUserOptions", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "AdvancedSecurityOptions.SAMLOptions", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.ColdStorageOptions", "PendingValue": "{\"Enabled\":false}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "ClusterConfig.DedicatedMasterCount", "PendingValue": "3", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.DedicatedMasterEnabled", "PendingValue": "true", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.DedicatedMasterType", "PendingValue": "r6g.large.search", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.InstanceCount", "PendingValue": "10", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.InstanceType", "PendingValue": "r6g.xlarge.search", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.MultiAZWithStandbyEnabled", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.WarmCount", "PendingValue": "", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "ClusterConfig.WarmEnabled", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "ClusterConfig.WarmStorage", "PendingValue": "", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "ClusterConfig.WarmType", "PendingValue": "", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "ClusterConfig.ZoneAwarenessEnabled", "PendingValue": "false", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "EngineVersion", "PendingValue": "OpenSearch_2.11", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "IPAddressType", "PendingValue": "ipv4", "ValueType": "PLAIN_TEXT" }, { "ActiveValue": "", "Name": "TAGS", "PendingValue": "", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "DomainEndpointOptions", "PendingValue": "{\"CustomEndpointEnabled\":false,\"EnforceHTTPS\":false,\"TLSSecurityPolicy\":\"Policy-Min-TLS-1-0-2019-07\"}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "EBSOptions", "PendingValue": "{\"EBSEnabled\":true,\"Iops\":1000,\"VolumeSize\":100,\"VolumeType\":\"io1\"}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "EncryptionAtRestOptions", "PendingValue": "{\"Enabled\":false}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "NodeToNodeEncryptionOptions", "PendingValue": "{\"Enabled\":false}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "OffPeakWindowOptions", "PendingValue": "{\"Enabled\":true,\"OffPeakWindow\":{\"WindowStartTime\":{\"Hours\":3,\"Minutes\":0}}}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "SnapshotOptions", "PendingValue": "{\"AutomatedSnapshotStartHour\":0}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "SoftwareUpdateOptions", "PendingValue": "{\"AutoSoftwareUpdateEnabled\":false}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "AutoTuneOptions", "PendingValue": "{\"desiredState\":\"ENABLED\",\"rollbackOnDisable\":\"NO_ROLLBACK\",\"state\":\"ENABLE_IN_PROGRESS\",\"rollbackState\":\"ROLLBACK_OFF\",\"maintenanceSchedules\":[],\"useOffPeakWindow\":false}", "ValueType": "STRINGIFIED_JSON" }, { "ActiveValue": "", "Name": "DeploymentStrategyOptions", "PendingValue": "{\"DeploymentStrategy\":\"Default\"}", "ValueType": "STRINGIFIED_JSON" }], "NodeToNodeEncryptionOptions": { "Enabled": false }, "OffPeakWindowOptions": { "Enabled": true, "OffPeakWindow": { "WindowStartTime": { "Hours": 3, "Minutes": 0 } } }, "Processing": true, "ServiceSoftwareOptions": { "AutomatedUpdateDate": 0.0, "Cancellable": false, "CurrentVersion": "", "Description": "There is no software update available for this domain.", "NewVersion": "", "OptionalDeployment": true, "UpdateAvailable": false, "UpdateStatus": "COMPLETED" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": 0 }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": false }, "UpgradeProcessing": false, "VPCOptions": null } } ``` ## See Also 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/CreateDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreateDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreateDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreateDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreateDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreateDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreateDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreateDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreateDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreateDomain) # CreateIndex Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see [Automatic semantic enrichment](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-semantic-enrichment.html). ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/index HTTP/1.1 Content-type: application/json { "IndexName": "string", "IndexSchema": JSON value } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_CreateIndex_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [IndexName](#API_CreateIndex_RequestSyntax) ** The name of the index to create. Must be between 1 and 255 characters and follow OpenSearch naming conventions. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?!\.\.?$)[^_ ,:"+/*\\|?#> The JSON schema defining index mappings, settings, and semantic enrichment configuration. The schema specifies which text fields should be automatically enriched for semantic search capabilities and includes OpenSearch index configuration parameters. Type: JSON value Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Status](#API_CreateIndex_ResponseSyntax) ** The status of the index creation operation. Type: String Valid Values: `CREATED | UPDATED | DELETED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. HTTP Status Code: 409 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ** ThrottlingException ** The request was denied due to request throttling. Reduce the frequency of your requests and try again. HTTP Status Code: 429 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/CreateIndex) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreateIndex) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreateIndex) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreateIndex) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreateIndex) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreateIndex) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreateIndex) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreateIndex) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreateIndex) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreateIndex) # CreateOutboundConnection Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` POST /2021-01-01/opensearch/cc/outboundConnection HTTP/1.1 Content-type: application/json { "ConnectionAlias": "string", "ConnectionMode": "string", "ConnectionProperties": { "CrossClusterSearch": { "SkipUnavailable": "string" }, "Endpoint": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ConnectionAlias](#API_CreateOutboundConnection_RequestSyntax) ** Name of the connection. Type: String Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: `[a-zA-Z][a-zA-Z0-9\-\_]+` Required: Yes ** [ConnectionMode](#API_CreateOutboundConnection_RequestSyntax) ** The connection mode. Type: String Valid Values: `DIRECT | VPC_ENDPOINT` Required: No ** [ConnectionProperties](#API_CreateOutboundConnection_RequestSyntax) ** The `ConnectionProperties` for the outbound connection. Type: [ConnectionProperties](API_ConnectionProperties.md) object Required: No ** [LocalDomainInfo](#API_CreateOutboundConnection_RequestSyntax) ** Name and Region of the source (local) domain. Type: [DomainInformationContainer](API_DomainInformationContainer.md) object Required: Yes ** [RemoteDomainInfo](#API_CreateOutboundConnection_RequestSyntax) ** Name and Region of the destination (remote) domain. Type: [DomainInformationContainer](API_DomainInformationContainer.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ConnectionAlias": "string", "ConnectionId": "string", "ConnectionMode": "string", "ConnectionProperties": { "CrossClusterSearch": { "SkipUnavailable": "string" }, "Endpoint": "string" }, "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConnectionAlias](#API_CreateOutboundConnection_ResponseSyntax) ** Name of the connection. Type: String Length Constraints: Minimum length of 2. Maximum length of 100. Pattern: `[a-zA-Z][a-zA-Z0-9\-\_]+` ** [ConnectionId](#API_CreateOutboundConnection_ResponseSyntax) ** The unique identifier for the created outbound connection, which is used for subsequent operations on the connection. Type: String Length Constraints: Minimum length of 10. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` ** [ConnectionMode](#API_CreateOutboundConnection_ResponseSyntax) ** The connection mode. Type: String Valid Values: `DIRECT | VPC_ENDPOINT` ** [ConnectionProperties](#API_CreateOutboundConnection_ResponseSyntax) ** The `ConnectionProperties` for the newly created connection. Type: [ConnectionProperties](API_ConnectionProperties.md) object ** [ConnectionStatus](#API_CreateOutboundConnection_ResponseSyntax) ** The status of the connection. Type: [OutboundConnectionStatus](API_OutboundConnectionStatus.md) object ** [LocalDomainInfo](#API_CreateOutboundConnection_ResponseSyntax) ** Information about the source (local) domain. Type: [DomainInformationContainer](API_DomainInformationContainer.md) object ** [RemoteDomainInfo](#API_CreateOutboundConnection_ResponseSyntax) ** Information about the destination (remote) domain. Type: [DomainInformationContainer](API_DomainInformationContainer.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. HTTP Status Code: 409 ## See Also 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/CreateOutboundConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreateOutboundConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreateOutboundConnection) # CreatePackage Creates a package for use with Amazon OpenSearch Service domains. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` POST /2021-01-01/packages HTTP/1.1 Content-type: application/json { "EngineVersion": "string", "PackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageName": "string", "PackageSource": { "S3BucketName": "string", "S3Key": "string" }, "PackageType": "string", "PackageVendingOptions": { "VendingEnabled": boolean } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [EngineVersion](#API_CreatePackage_RequestSyntax) ** The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type `ZIP-PLUGIN` Type: String Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` Required: No ** [PackageConfiguration](#API_CreatePackage_RequestSyntax) ** The configuration parameters for the package being created. Type: [PackageConfiguration](API_PackageConfiguration.md) object Required: No ** [PackageDescription](#API_CreatePackage_RequestSyntax) ** Description of the package. Type: String Length Constraints: Maximum length of 1024. Required: No ** [PackageEncryptionOptions](#API_CreatePackage_RequestSyntax) ** The encryption parameters for the package being created. Type: [PackageEncryptionOptions](API_PackageEncryptionOptions.md) object Required: No ** [PackageName](#API_CreatePackage_RequestSyntax) ** Unique name for the package. Type: String Length Constraints: Minimum length of 3. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PackageSource](#API_CreatePackage_RequestSyntax) ** The Amazon S3 location from which to import the package. Type: [PackageSource](API_PackageSource.md) object Required: Yes ** [PackageType](#API_CreatePackage_RequestSyntax) ** The type of package. Type: String Valid Values: `TXT-DICTIONARY | ZIP-PLUGIN | PACKAGE-LICENSE | PACKAGE-CONFIG` Required: Yes ** [PackageVendingOptions](#API_CreatePackage_RequestSyntax) ** The vending options for the package being created. They determine if the package can be vended to other users. Type: [PackageVendingOptions](API_PackageVendingOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "PackageDetails": { "AllowListedUserList": [ "string" ], "AvailablePackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "AvailablePackageVersion": "string", "AvailablePluginProperties": { "ClassName": "string", "Description": "string", "Name": "string", "UncompressedSizeInBytes": number, "Version": "string" }, "CreatedAt": number, "EngineVersion": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdatedAt": number, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageID": "string", "PackageName": "string", "PackageOwner": "string", "PackageStatus": "string", "PackageType": "string", "PackageVendingOptions": { "VendingEnabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PackageDetails](#API_CreatePackage_ResponseSyntax) ** Basic information about an OpenSearch Service package. Type: [PackageDetails](API_PackageDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** InvalidTypeException ** An exception for trying to create or access a sub-resource that's either invalid or not supported. HTTP Status Code: 409 ** LimitExceededException ** An exception for trying to create more than the allowed number of resources or sub-resources. HTTP Status Code: 409 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. HTTP Status Code: 409 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/CreatePackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreatePackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreatePackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreatePackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreatePackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreatePackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreatePackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreatePackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreatePackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreatePackage) # CreateVpcEndpoint Creates an Amazon OpenSearch Service-managed VPC endpoint. ## Request Syntax ``` POST /2021-01-01/opensearch/vpcEndpoints HTTP/1.1 Content-type: application/json { "ClientToken": "string", "DomainArn": "string", "VpcOptions": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ClientToken](#API_CreateVpcEndpoint_RequestSyntax) ** Unique, case-sensitive identifier to ensure idempotency of the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ** [DomainArn](#API_CreateVpcEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the domain to create the endpoint for. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: `arn:aws[a-z\-]*:[a-z]+:[a-z0-9\-]+:[0-9]+:domain\/[a-z0-9\-]+` Required: Yes ** [VpcOptions](#API_CreateVpcEndpoint_RequestSyntax) ** Options to specify the subnets and security groups for the endpoint. Type: [VPCOptions](API_VPCOptions.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "VpcEndpoint": { "DomainArn": "string", "Endpoint": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string", "VpcOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [VpcEndpoint](#API_CreateVpcEndpoint_ResponseSyntax) ** Information about the newly created VPC endpoint. Type: [VpcEndpoint](API_VpcEndpoint.md) object ## Errors 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 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/CreateVpcEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/CreateVpcEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/CreateVpcEndpoint) # DeleteApplication Deletes a specified OpenSearch application. ## Request Syntax ``` DELETE /2021-01-01/opensearch/application/id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_DeleteApplication_RequestSyntax) ** The unique identifier of the OpenSearch application to delete. Pattern: `[a-z0-9]{3,30}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/DeleteApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteApplication) # DeleteDataSource Deletes a direct-query data source. For more information, see [Deleting an Amazon OpenSearch Service data source with Amazon S3](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html). ## Request Syntax ``` DELETE /2021-01-01/opensearch/domain/DomainName/dataSource/DataSourceName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DeleteDataSource_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [DataSourceName](#API_DeleteDataSource_RequestSyntax) ** The name of the data source to delete. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_DeleteDataSource_ResponseSyntax) ** A message associated with deletion of the data source. Type: String ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** 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 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/DeleteDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteDataSource) # DeleteDirectQueryDataSource Deletes a previously configured direct query data source from Amazon OpenSearch Service. ## Request Syntax ``` DELETE /2021-01-01/opensearch/directQueryDataSource/DataSourceName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DataSourceName](#API_DeleteDirectQueryDataSource_RequestSyntax) ** A unique, user-defined label to identify the data source within your OpenSearch Service environment. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors 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 ** 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 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/DeleteDirectQueryDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteDirectQueryDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteDirectQueryDataSource) # DeleteDomain Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it. ## Request Syntax ``` DELETE /2021-01-01/opensearch/domain/DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DeleteDomain_RequestSyntax) ** The name of the domain you want to permanently delete. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainStatus": { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "ARN": "string", "AutoTuneOptions": { "ErrorMessage": "string", "State": "string", "UseOffPeakWindow": boolean }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Created": boolean, "Deleted": boolean, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainEndpointV2HostedZoneId": "string", "DomainId": "string", "DomainName": "string", "DomainProcessingStatus": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "Endpoint": "string", "Endpoints": { "string" : "string" }, "EndpointV2": "string", "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Processing": boolean, "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "UpgradeProcessing": boolean, "VPCOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainStatus](#API_DeleteDomain_ResponseSyntax) ** The status of the domain being deleted. Type: [DomainStatus](API_DomainStatus.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DeleteDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteDomain) # DeleteInboundConnection Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` DELETE /2021-01-01/opensearch/cc/inboundConnection/ConnectionId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ConnectionId](#API_DeleteInboundConnection_RequestSyntax) ** The ID of the inbound connection to permanently delete. Length Constraints: Minimum length of 10. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connection": { "ConnectionId": "string", "ConnectionMode": "string", "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connection](#API_DeleteInboundConnection_ResponseSyntax) ** The deleted inbound connection. Type: [InboundConnection](API_InboundConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/DeleteInboundConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteInboundConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteInboundConnection) # DeleteIndex Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone. ## Request Syntax ``` DELETE /2021-01-01/opensearch/domain/DomainName/index/IndexName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DeleteIndex_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [IndexName](#API_DeleteIndex_RequestSyntax) ** The name of the index to delete. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?!\.\.?$)[^_ ,:"+/*\\|?#> The status of the index deletion operation. Type: String Valid Values: `CREATED | UPDATED | DELETED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ** ThrottlingException ** The request was denied due to request throttling. Reduce the frequency of your requests and try again. HTTP Status Code: 429 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/DeleteIndex) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteIndex) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteIndex) # DeleteOutboundConnection Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` DELETE /2021-01-01/opensearch/cc/outboundConnection/ConnectionId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ConnectionId](#API_DeleteOutboundConnection_RequestSyntax) ** The ID of the outbound connection you want to permanently delete. Length Constraints: Minimum length of 10. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connection": { "ConnectionAlias": "string", "ConnectionId": "string", "ConnectionMode": "string", "ConnectionProperties": { "CrossClusterSearch": { "SkipUnavailable": "string" }, "Endpoint": "string" }, "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connection](#API_DeleteOutboundConnection_ResponseSyntax) ** The deleted inbound connection. Type: [OutboundConnection](API_OutboundConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/DeleteOutboundConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteOutboundConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteOutboundConnection) # DeletePackage Deletes an Amazon OpenSearch Service package. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` DELETE /2021-01-01/packages/PackageID HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [PackageID](#API_DeletePackage_RequestSyntax) ** The internal ID of the package you want to delete. Use `DescribePackages` to find this value. Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "PackageDetails": { "AllowListedUserList": [ "string" ], "AvailablePackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "AvailablePackageVersion": "string", "AvailablePluginProperties": { "ClassName": "string", "Description": "string", "Name": "string", "UncompressedSizeInBytes": number, "Version": "string" }, "CreatedAt": number, "EngineVersion": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdatedAt": number, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageID": "string", "PackageName": "string", "PackageOwner": "string", "PackageStatus": "string", "PackageType": "string", "PackageVendingOptions": { "VendingEnabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PackageDetails](#API_DeletePackage_ResponseSyntax) ** Information about the deleted package. Type: [PackageDetails](API_PackageDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DeletePackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeletePackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeletePackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeletePackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeletePackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeletePackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeletePackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeletePackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeletePackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeletePackage) # DeleteVpcEndpoint Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. ## Request Syntax ``` DELETE /2021-01-01/opensearch/vpcEndpoints/VpcEndpointId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [VpcEndpointId](#API_DeleteVpcEndpoint_RequestSyntax) ** The unique identifier of the endpoint. Length Constraints: Minimum length of 5. Maximum length of 256. Pattern: `^aos-[a-zA-Z0-9]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "VpcEndpointSummary": { "DomainArn": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [VpcEndpointSummary](#API_DeleteVpcEndpoint_ResponseSyntax) ** Information about the deleted endpoint, including its current status (`DELETING` or `DELETE_FAILED`). Type: [VpcEndpointSummary](API_VpcEndpointSummary.md) object ## Errors 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/DeleteVpcEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeleteVpcEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeleteVpcEndpoint) # DeregisterCapability Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration. ## Request Syntax ``` DELETE /2021-01-01/opensearch/application/ApplicationId/capability/deregister/CapabilityName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ApplicationId](#API_DeregisterCapability_RequestSyntax) ** The unique identifier of the OpenSearch UI application to deregister the capability from. Pattern: `[a-z0-9]{3,30}` Required: Yes ** [CapabilityName](#API_DeregisterCapability_RequestSyntax) ** The name of the capability to deregister. Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `^[a-zA-Z0-9-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [status](#API_DeregisterCapability_ResponseSyntax) ** The status of the deregistration operation. Returns `deleting` when the capability is being removed. Type: String Valid Values: `creating | create_failed | active | updating | update_failed | deleting | delete_failed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/DeregisterCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DeregisterCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DeregisterCapability) # DescribeDomain Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDomain_RequestSyntax) ** The name of the domain that you want information about. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainStatus": { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "ARN": "string", "AutoTuneOptions": { "ErrorMessage": "string", "State": "string", "UseOffPeakWindow": boolean }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Created": boolean, "Deleted": boolean, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainEndpointV2HostedZoneId": "string", "DomainId": "string", "DomainName": "string", "DomainProcessingStatus": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "Endpoint": "string", "Endpoints": { "string" : "string" }, "EndpointV2": "string", "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Processing": boolean, "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "UpgradeProcessing": boolean, "VPCOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainStatus](#API_DescribeDomain_ResponseSyntax) ** List that contains the status of each specified OpenSearch Service domain. Type: [DomainStatus](API_DomainStatus.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 ## Examples ### Example This example illustrates one usage of DescribeDomain. #### Sample Request ``` GET /2021-01-01/opensearch/domain/movies HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-domain X-Amz-Date: 20240209T222243Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=30d6a7dc73d1e649559866aff99b074e516e06e5e0b5d94f103ef608356c7d4e ``` #### Sample Response ``` { "DomainStatus":{ "ARN":"arn:aws:es:us-east-1:123456789012:domain/movies", "AccessPolicies":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/movies/*\"}]}", "AdvancedOptions":{ "indices.fielddata.cache.size":"20", "indices.query.bool.max_clause_count":"1024", "override_main_response_version":"true", "rest.action.multi.allow_explicit_index":"true" }, "AdvancedSecurityOptions":{ "AnonymousAuthDisableDate":null, "AnonymousAuthEnabled":false, "Enabled":true, "InternalUserDatabaseEnabled":true, "SAMLOptions":null }, "AutoTuneOptions":{ "ErrorMessage":null, "State":"ENABLE_IN_PROGRESS", "UseOffPeakWindow":false }, "ChangeProgressDetails":{ "ChangeId":"c5cba9b5-1083-45a9-836e-bb2e1ccf4347", "LastUpdatedTime":1.682350123826E9, "Message":null, "StartTime":1.682348498501E9 }, "ClusterConfig":{ "ColdStorageOptions":{ "Enabled":false }, "DedicatedMasterCount":null, "DedicatedMasterEnabled":false, "DedicatedMasterType":null, "InstanceCount":3, "InstanceType":"t3.small.search", "WarmCount":null, "WarmEnabled":false, "WarmStorage":null, "WarmType":null, "ZoneAwarenessConfig":{ "AvailabilityZoneCount":3 }, "ZoneAwarenessEnabled":true }, "CognitoOptions":{ "Enabled":false, "IdentityPoolId":null, "RoleArn":null, "UserPoolId":null }, "Created":true, "Deleted":false, "DeploymentStrategyOptions":{ "DeploymentStrategy":"Default" }, "DomainEndpointOptions":{ "CustomEndpoint":null, "CustomEndpointCertificateArn":null, "CustomEndpointEnabled":false, "EnforceHTTPS":true, "TLSSecurityPolicy":"Policy-Min-TLS-1-0-2019-07" }, "DomainId":"123456789012/movies", "DomainName":"movies", "DomainProcessingStatus":"Active", "EBSOptions":{ "EBSEnabled":true, "Iops":null, "Throughput":null, "VolumeSize":10, "VolumeType":"gp2" }, "EncryptionAtRestOptions":{ "Enabled":true, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "Endpoint":"search-movies-o36agaraperqwzp7s7vv6xfzwa.us-east-1.es.amazonaws.com", "Endpoints":null, "EngineVersion":"OpenSearch_1.3", "IPAddressType":"ipv4", "LogPublishingOptions":null, "ModifyingProperties":[ ], "NodeToNodeEncryptionOptions":{ "Enabled":true }, "OffPeakWindowOptions":{ "Enabled":false, "OffPeakWindow":{ "WindowStartTime":{ "Hours":0, "Minutes":0 } } }, "Processing":false, "ServiceSoftwareOptions":{ "AutomatedUpdateDate":0.0, "Cancellable":false, "CurrentVersion":"R20221114-P3", "Description":"A newer release OpenSearch_1_3_R20230928-P3 is available.", "NewVersion":"OpenSearch_1_3_R20230928-P3", "OptionalDeployment":true, "UpdateAvailable":true, "UpdateStatus":"ELIGIBLE" }, "SnapshotOptions":{ "AutomatedSnapshotStartHour":null }, "SoftwareUpdateOptions":{ "AutoSoftwareUpdateEnabled":false }, "UpgradeProcessing":false, "VPCOptions":null } } ``` ## See Also 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/DescribeDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomain) # DescribeDomainAutoTunes Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see [Auto-Tune for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html). ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/autoTunes?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDomainAutoTunes_RequestSyntax) ** Name of the domain that you want Auto-Tune details about. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaxResults](#API_DescribeDomainAutoTunes_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_DescribeDomainAutoTunes_RequestSyntax) ** If your initial `DescribeDomainAutoTunes` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribeDomainAutoTunes` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AutoTunes": [ { "AutoTuneDetails": { "ScheduledAutoTuneDetails": { "Action": "string", "ActionType": "string", "Date": number, "Severity": "string" } }, "AutoTuneType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AutoTunes](#API_DescribeDomainAutoTunes_ResponseSyntax) ** The list of setting adjustments that Auto-Tune has made to the domain. Type: Array of [AutoTune](API_AutoTune.md) objects ** [NextToken](#API_DescribeDomainAutoTunes_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DescribeDomainAutoTunes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomainAutoTunes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomainAutoTunes) # DescribeDomainChangeProgress Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see [Making configuration changes in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html). ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/progress?changeid=ChangeId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ChangeId](#API_DescribeDomainChangeProgress_RequestSyntax) ** The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change. Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ** [DomainName](#API_DescribeDomainChangeProgress_RequestSyntax) ** The name of the domain to get progress information for. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ChangeProgressStatus": { "ChangeId": "string", "ChangeProgressStages": [ { "Description": "string", "LastUpdated": number, "Name": "string", "Status": "string" } ], "CompletedProperties": [ "string" ], "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "PendingProperties": [ "string" ], "StartTime": number, "Status": "string", "TotalNumberOfStages": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ChangeProgressStatus](#API_DescribeDomainChangeProgress_ResponseSyntax) ** Container for information about the stages of a configuration change happening on a domain. Type: [ChangeProgressStatusDetails](API_ChangeProgressStatusDetails.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DescribeDomainChangeProgress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomainChangeProgress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomainChangeProgress) # DescribeDomainConfig Returns the configuration of an Amazon OpenSearch Service domain. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/config HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDomainConfig_RequestSyntax) ** Name of the OpenSearch Service domain configuration that you want to describe. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainConfig": { "AccessPolicies": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AdvancedOptions": { "Options": { "string" : "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AdvancedSecurityOptions": { "Options": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AIMLOptions": { "Options": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AutoTuneOptions": { "Options": { "DesiredState": "string", "MaintenanceSchedules": [ { "CronExpressionForRecurrence": "string", "Duration": { "Unit": "string", "Value": number }, "StartAt": number } ], "RollbackOnDisable": "string", "UseOffPeakWindow": boolean }, "Status": { "CreationDate": number, "ErrorMessage": "string", "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "Options": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "CognitoOptions": { "Options": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "DeploymentStrategyOptions": { "Options": { "DeploymentStrategy": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "DomainEndpointOptions": { "Options": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EBSOptions": { "Options": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EncryptionAtRestOptions": { "Options": { "Enabled": boolean, "KmsKeyId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EngineVersion": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "IdentityCenterOptions": { "Options": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "IPAddressType": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "LogPublishingOptions": { "Options": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Options": { "Enabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "OffPeakWindowOptions": { "Options": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "SnapshotOptions": { "Options": { "AutomatedSnapshotStartHour": number }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "SoftwareUpdateOptions": { "Options": { "AutoSoftwareUpdateEnabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "VPCOptions": { "Options": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainConfig](#API_DescribeDomainConfig_ResponseSyntax) ** Container for the configuration of the OpenSearch Service domain. Type: [DomainConfig](API_DomainConfig.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 ## Examples ### Example This example illustrates one usage of DescribeDomainConfig. #### Sample Request ``` GET /2021-01-01/opensearch/domain/movies/config HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-domain-config X-Amz-Date: 20240209T222604Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=9fe055358029051fbcedaf0b82da320529af57cc6efadc35fb9c187b65252704 ``` #### Sample Response ``` { "DomainConfig":{ "AccessPolicies":{ "Options":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/movies/*\"}]}", "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "AdvancedOptions":{ "Options":{ "indices.fielddata.cache.size":"20", "indices.query.bool.max_clause_count":"1024", "override_main_response_version":"true", "rest.action.multi.allow_explicit_index":"true" }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.660244135078E9, "UpdateVersion":23 } }, "AdvancedSecurityOptions":{ "Options":{ "AnonymousAuthDisableDate":null, "AnonymousAuthEnabled":false, "Enabled":true, "InternalUserDatabaseEnabled":true, "SAMLOptions":null }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "AutoTuneOptions":{ "Options":{ "DesiredState":"ENABLED", "MaintenanceSchedules":[ ], "RollbackOnDisable":"NO_ROLLBACK", "UseOffPeakWindow":false }, "Status":{ "CreationDate":1.655753311082E9, "ErrorMessage":null, "PendingDeletion":false, "State":"ENABLE_IN_PROGRESS", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "ChangeProgressDetails":{ "ChangeId":"c5cba9b5-1083-45a9-836e-bb2e1ccf4347", "LastUpdatedTime":1.682350123826E9, "Message":null, "StartTime":1.682348498501E9 }, "DeploymentStrategyOptions":{ "Options":{ "DeploymentStrategy":"Default" }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "ClusterConfig":{ "Options":{ "ColdStorageOptions":{ "Enabled":false }, "DedicatedMasterCount":null, "DedicatedMasterEnabled":false, "DedicatedMasterType":null, "InstanceCount":3, "InstanceType":"t3.small.search", "WarmCount":null, "WarmEnabled":false, "WarmStorage":null, "WarmType":null, "ZoneAwarenessConfig":{ "AvailabilityZoneCount":3 }, "ZoneAwarenessEnabled":true }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "CognitoOptions":{ "Options":{ "Enabled":false, "IdentityPoolId":null, "RoleArn":null, "UserPoolId":null }, "Status":{ "CreationDate":1.707517564627E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564627E9, "UpdateVersion":33 } }, "DomainEndpointOptions":{ "Options":{ "CustomEndpoint":null, "CustomEndpointCertificateArn":null, "CustomEndpointEnabled":false, "EnforceHTTPS":true, "TLSSecurityPolicy":"Policy-Min-TLS-1-0-2019-07" }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "EBSOptions":{ "Options":{ "EBSEnabled":true, "Iops":null, "Throughput":null, "VolumeSize":10, "VolumeType":"gp2" }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "EncryptionAtRestOptions":{ "Options":{ "Enabled":true, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "EngineVersion":{ "Options":"OpenSearch_1.3", "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.660245682561E9, "UpdateVersion":28 } }, "IPAddressType":{ "Options":"ipv4", "Status":{ "CreationDate":1.707517564625E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564625E9, "UpdateVersion":33 } }, "LogPublishingOptions":{ "Options":{ }, "Status":{ "CreationDate":1.707517564636E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564636E9, "UpdateVersion":33 } }, "ModifyingProperties":[ ], "NodeToNodeEncryptionOptions":{ "Options":{ "Enabled":true }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "OffPeakWindowOptions":{ "Options":{ "Enabled":false, "OffPeakWindow":{ "WindowStartTime":{ "Hours":0, "Minutes":0 } } }, "Status":{ "CreationDate":1.707517564647E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564647E9, "UpdateVersion":33 } }, "SnapshotOptions":{ "Options":{ "AutomatedSnapshotStartHour":0 }, "Status":{ "CreationDate":1.655753311082E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.655754278102E9, "UpdateVersion":7 } }, "SoftwareUpdateOptions":{ "Options":{ "AutoSoftwareUpdateEnabled":false }, "Status":{ "CreationDate":1.707517564648E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564648E9, "UpdateVersion":33 } }, "VPCOptions":{ "Options":{ "AvailabilityZones":null, "SecurityGroupIds":null, "SubnetIds":null, "VPCId":null }, "Status":{ "CreationDate":1.707517564626E9, "PendingDeletion":false, "State":"Active", "UpdateDate":1.707517564626E9, "UpdateVersion":33 } } } } ``` ## See Also 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/DescribeDomainConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomainConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomainConfig) # DescribeDomainHealth Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/health HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDomainHealth_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ActiveAvailabilityZoneCount": "string", "AvailabilityZoneCount": "string", "ClusterHealth": "string", "DataNodeCount": "string", "DedicatedMaster": boolean, "DomainState": "string", "EnvironmentInformation": [ { "AvailabilityZoneInformation": [ { "AvailabilityZoneName": "string", "AvailableDataNodeCount": "string", "ConfiguredDataNodeCount": "string", "TotalShards": "string", "TotalUnAssignedShards": "string", "ZoneStatus": "string" } ] } ], "MasterEligibleNodeCount": "string", "MasterNode": "string", "StandByAvailabilityZoneCount": "string", "TotalShards": "string", "TotalUnAssignedShards": "string", "WarmNodeCount": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ActiveAvailabilityZoneCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return `NotAvailable`. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [AvailabilityZoneCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return `NotAvailable`. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [ClusterHealth](#API_DescribeDomainHealth_ResponseSyntax) ** The current health status of your cluster. + `Red` - At least one primary shard is not allocated to any node. + `Yellow` - All primary shards are allocated to nodes, but some replicas aren’t. + `Green` - All primary shards and their replicas are allocated to nodes. + `NotAvailable` - Unable to retrieve cluster health. Type: String Valid Values: `Red | Yellow | Green | NotAvailable` ** [DataNodeCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return `NotAvailable`. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [DedicatedMaster](#API_DescribeDomainHealth_ResponseSyntax) ** A boolean that indicates if dedicated master nodes are activated for the domain. Type: Boolean ** [DomainState](#API_DescribeDomainHealth_ResponseSyntax) ** The current state of the domain. + `Processing` - The domain has updates in progress. + `Active` - Requested changes have been processed and deployed to the domain. Type: String Valid Values: `Active | Processing | NotAvailable` ** [EnvironmentInformation](#API_DescribeDomainHealth_ResponseSyntax) ** A list of `EnvironmentInfo` for the domain. Type: Array of [EnvironmentInfo](API_EnvironmentInfo.md) objects ** [MasterEligibleNodeCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return `NotAvailable`. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [MasterNode](#API_DescribeDomainHealth_ResponseSyntax) ** Indicates whether the domain has an elected master node. + **Available** - The domain has an elected master node. + **UnAvailable** - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached. Type: String Valid Values: `Available | UnAvailable` ** [StandByAvailabilityZoneCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return `NotAvailable`. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [TotalShards](#API_DescribeDomainHealth_ResponseSyntax) ** The total number of primary and replica shards for the domain. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [TotalUnAssignedShards](#API_DescribeDomainHealth_ResponseSyntax) ** The total number of primary and replica shards not allocated to any of the nodes for the cluster. Type: String Pattern: `^((\d+)|(NotAvailable))$` ** [WarmNodeCount](#API_DescribeDomainHealth_ResponseSyntax) ** The number of warm nodes configured for the domain. Type: String Pattern: `^((\d+)|(NotAvailable))$` ## Errors 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 ** 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 ## Examples ### Example This example illustrates one usage of DescribeDomainHealth. #### Sample Request ``` GET /2021-01-01/opensearch/domain/amazonrocks/health HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-domain-health X-Amz-Date: 20240209T222820Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=786d6e7ab6725d07b29cde81430b8e57dc2e87e4667c2879de84ab1b94dea451 ``` #### Sample Response ``` { "ActiveAvailabilityZoneCount":"3", "AvailabilityZoneCount":"3", "ClusterHealth":"Green", "DataNodeCount":"3", "DedicatedMaster":false, "DomainState":"Active", "EnvironmentInformation":[ { "AvailabilityZoneInformation":[ { "AvailabilityZoneName":"us-east-1b", "AvailableDataNodeCount":"1", "ConfiguredDataNodeCount":"1", "TotalShards":"6", "TotalUnAssignedShards":"NotAvailable", "ZoneStatus":"Active" }, { "AvailabilityZoneName":"us-east-1c", "AvailableDataNodeCount":"1", "ConfiguredDataNodeCount":"1", "TotalShards":"7", "TotalUnAssignedShards":"NotAvailable", "ZoneStatus":"Active" }, { "AvailabilityZoneName":"us-east-1d", "AvailableDataNodeCount":"1", "ConfiguredDataNodeCount":"1", "TotalShards":"6", "TotalUnAssignedShards":"NotAvailable", "ZoneStatus":"Active" } ] } ], "MasterEligibleNodeCount":"3", "MasterNode":"Available", "StandByAvailabilityZoneCount":"0", "TotalShards":"19", "TotalUnAssignedShards":"0", "WarmNodeCount":"0" } ``` ## See Also 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/DescribeDomainHealth) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomainHealth) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomainHealth) # DescribeDomainNodes Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/nodes HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDomainNodes_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainNodesStatusList": [ { "AvailabilityZone": "string", "InstanceType": "string", "NodeId": "string", "NodeStatus": "string", "NodeType": "string", "StorageSize": "string", "StorageType": "string", "StorageVolumeType": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainNodesStatusList](#API_DescribeDomainNodes_ResponseSyntax) ** Contains nodes information list `DomainNodesStatusList` with details about the all nodes on the requested domain. Type: Array of [DomainNodesStatus](API_DomainNodesStatus.md) objects ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** 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 ## Examples ### Example This example illustrates one usage of DescribeDomainNodes. #### Sample Request ``` GET /2021-01-01/opensearch/domain/amazonrocks/nodes HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-domain-nodes X-Amz-Date: 20240209T222942Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=6cc839c3e9dcf0a11a52de4e0c0b9c07ffb0fed0e60a76d01062e3de18502927 ``` #### Sample Response ``` { "DomainNodesStatusList":[ { "AvailabilityZone":"us-east-1d", "InstanceType":"r6g.large", "NodeId":"MRJ8TdTEQBuaMp9kmR9i6Q", "NodeStatus":"Active", "NodeType":"Data", "StorageSize":"10", "StorageType":"EBS", "StorageVolumeType":"gp2" }, { "AvailabilityZone":"us-east-1c", "InstanceType":"r6g.large", "NodeId":"-Rx5kkj3RAuf3h2WlS0cpw", "NodeStatus":"Active", "NodeType":"Data", "StorageSize":"10", "StorageType":"EBS", "StorageVolumeType":"gp2" }, { "AvailabilityZone":"us-east-1b", "InstanceType":"r6g.large", "NodeId":"VLEn_jYTTzSapI54pdnBtA", "NodeStatus":"Active", "NodeType":"Data", "StorageSize":"10", "StorageType":"EBS", "StorageVolumeType":"gp2" } ] } ``` ## See Also 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/DescribeDomainNodes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomainNodes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomainNodes) # DescribeDomains Returns domain configuration information about the specified Amazon OpenSearch Service domains. ## Request Syntax ``` POST /2021-01-01/opensearch/domain-info HTTP/1.1 Content-type: application/json { "DomainNames": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DomainNames](#API_DescribeDomains_RequestSyntax) ** Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name. Type: Array of strings Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainStatusList": [ { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "ARN": "string", "AutoTuneOptions": { "ErrorMessage": "string", "State": "string", "UseOffPeakWindow": boolean }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Created": boolean, "Deleted": boolean, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainEndpointV2HostedZoneId": "string", "DomainId": "string", "DomainName": "string", "DomainProcessingStatus": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "Endpoint": "string", "Endpoints": { "string" : "string" }, "EndpointV2": "string", "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Processing": boolean, "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "UpgradeProcessing": boolean, "VPCOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainStatusList](#API_DescribeDomains_ResponseSyntax) ** The status of the requested domains. Type: Array of [DomainStatus](API_DomainStatus.md) objects ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of DescribeDomains. #### Sample Request ``` POST /2021-01-01/opensearch/domain-info HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-domains X-Amz-Date: 20240209T222038Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-security-token, Signature=584535086b2616bb3c1acf1bab39229d2d079327c05c84a0b65b76bed909ed15 Content-Length: 32 {"DomainNames": ["amazonrocks"]} ``` #### Sample Response ``` { "DomainStatusList":[ { "ARN":"arn:aws:es:us-east-1:123456789012:domain/amazonrocks", "AccessPolicies":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-east-1:123456789012:domain/amazonrocks/*\"}]}", "AdvancedOptions":{ "indices.fielddata.cache.size":"20", "indices.query.bool.max_clause_count":"1024", "override_main_response_version":"true", "rest.action.multi.allow_explicit_index":"true" }, "AdvancedSecurityOptions":{ "AnonymousAuthDisableDate":null, "AnonymousAuthEnabled":false, "Enabled":true, "InternalUserDatabaseEnabled":true, "SAMLOptions":null }, "AutoTuneOptions":{ "ErrorMessage":null, "State":"ENABLED", "UseOffPeakWindow":false }, "ChangeProgressDetails":{ "ChangeId":"42e55b10-16d3-4a49-a54f-0cf5e9a42244", "LastUpdatedTime":1.682458752907E9, "Message":null, "StartTime":1.682456512645E9 }, "ClusterConfig":{ "ColdStorageOptions":{ "Enabled":false }, "DedicatedMasterCount":null, "DedicatedMasterEnabled":false, "DedicatedMasterType":null, "InstanceCount":3, "InstanceType":"r6g.large.search", "WarmCount":null, "WarmEnabled":false, "WarmStorage":null, "WarmType":null, "ZoneAwarenessConfig":{ "AvailabilityZoneCount":3 }, "ZoneAwarenessEnabled":true }, "CognitoOptions":{ "Enabled":false, "IdentityPoolId":null, "RoleArn":null, "UserPoolId":null }, "Created":true, "Deleted":false, "DomainEndpointOptions":{ "CustomEndpoint":null, "CustomEndpointCertificateArn":null, "CustomEndpointEnabled":false, "EnforceHTTPS":true, "TLSSecurityPolicy":"Policy-Min-TLS-1-0-2019-07" }, "DomainId":"123456789012/amazonrocks", "DomainName":"amazonrocks", "DomainProcessingStatus":"Active", "EBSOptions":{ "EBSEnabled":true, "Iops":null, "Throughput":null, "VolumeSize":10, "VolumeType":"gp2" }, "EncryptionAtRestOptions":{ "Enabled":true, "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, "Endpoint":"search-amazonrocks-scuclckuu7bjkhxo6du557d4da.us-east-1.es.amazonaws.com", "Endpoints":null, "EngineVersion":"OpenSearch_1.3", "IPAddressType":"ipv4", "LogPublishingOptions":null, "ModifyingProperties":[ ], "NodeToNodeEncryptionOptions":{ "Enabled":true }, "OffPeakWindowOptions":{ "Enabled":false, "OffPeakWindow":{ "WindowStartTime":{ "Hours":0, "Minutes":0 } } }, "Processing":false, "ServiceSoftwareOptions":{ "AutomatedUpdateDate":0.0, "Cancellable":false, "CurrentVersion":"R20221114-P3", "Description":"A newer release OpenSearch_1_3_R20230928-P3 is available.", "NewVersion":"OpenSearch_1_3_R20230928-P3", "OptionalDeployment":true, "UpdateAvailable":true, "UpdateStatus":"ELIGIBLE" }, "SnapshotOptions":{ "AutomatedSnapshotStartHour":null }, "SoftwareUpdateOptions":{ "AutoSoftwareUpdateEnabled":false }, "UpgradeProcessing":false, "VPCOptions":null } ] } ``` ## See Also 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/DescribeDomains) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDomains) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDomains) # DescribeDryRunProgress Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see [Determining whether a change will cause a blue/green deployment](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun). ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/dryRun?dryRunId=DryRunId&loadDryRunConfig=LoadDryRunConfig HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeDryRunProgress_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [DryRunId](#API_DescribeDryRunProgress_RequestSyntax) ** The unique identifier of the dry run. Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ** [LoadDryRunConfig](#API_DescribeDryRunProgress_RequestSyntax) ** Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DryRunConfig": { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "ARN": "string", "AutoTuneOptions": { "ErrorMessage": "string", "State": "string", "UseOffPeakWindow": boolean }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Created": boolean, "Deleted": boolean, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DomainEndpointV2HostedZoneId": "string", "DomainId": "string", "DomainName": "string", "DomainProcessingStatus": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "Endpoint": "string", "Endpoints": { "string" : "string" }, "EndpointV2": "string", "EngineVersion": "string", "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Processing": boolean, "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "UpgradeProcessing": boolean, "VPCOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } }, "DryRunProgressStatus": { "CreationDate": "string", "DryRunId": "string", "DryRunStatus": "string", "UpdateDate": "string", "ValidationFailures": [ { "Code": "string", "Message": "string" } ] }, "DryRunResults": { "DeploymentType": "string", "Message": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DryRunConfig](#API_DescribeDryRunProgress_ResponseSyntax) ** Details about the changes you're planning to make on the domain. Type: [DomainStatus](API_DomainStatus.md) object ** [DryRunProgressStatus](#API_DescribeDryRunProgress_ResponseSyntax) ** The current status of the dry run, including any validation errors. Type: [DryRunProgressStatus](API_DryRunProgressStatus.md) object ** [DryRunResults](#API_DescribeDryRunProgress_ResponseSyntax) ** The results of the dry run. Type: [DryRunResults](API_DryRunResults.md) object ## Errors 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 ** 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 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/DescribeDryRunProgress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeDryRunProgress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeDryRunProgress) # DescribeInboundConnections Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` POST /2021-01-01/opensearch/cc/inboundConnection/search HTTP/1.1 Content-type: application/json { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Filters](#API_DescribeInboundConnections_RequestSyntax) ** A list of filters used to match properties for inbound cross-cluster connections. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_DescribeInboundConnections_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Type: Integer Valid Range: Maximum value of 100. Required: No ** [NextToken](#API_DescribeInboundConnections_RequestSyntax) ** If your initial `DescribeInboundConnections` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribeInboundConnections` operations, which returns results in the next page. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connections": [ { "ConnectionId": "string", "ConnectionMode": "string", "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connections](#API_DescribeInboundConnections_ResponseSyntax) ** List of inbound connections. Type: Array of [InboundConnection](API_InboundConnection.md) objects ** [NextToken](#API_DescribeInboundConnections_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** InvalidPaginationTokenException ** Request processing failed because you provided an invalid pagination token. HTTP Status Code: 400 ## See Also 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/DescribeInboundConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeInboundConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeInboundConnections) # DescribeInsightDetails Describes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as text descriptions and metric data. ## Request Syntax ``` POST /2021-01-01/opensearch/insight-details HTTP/1.1 Content-type: application/json { "Entity": { "Type": "string", "Value": "string" }, "InsightId": "string", "ShowHtmlContent": boolean } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Entity](#API_DescribeInsightDetails_RequestSyntax) ** The entity for which to retrieve insight details. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID. Type: [InsightEntity](API_InsightEntity.md) object Required: Yes ** [InsightId](#API_DescribeInsightDetails_RequestSyntax) ** The unique identifier of the insight to describe. Type: String Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` Required: Yes ** [ShowHtmlContent](#API_DescribeInsightDetails_RequestSyntax) ** Specifies whether to show response with HTML content in response or not. Type: Boolean Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Fields": [ { "Name": "string", "Type": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Fields](#API_DescribeInsightDetails_ResponseSyntax) ** The list of fields that contain detailed information about the insight. Type: Array of [InsightField](API_InsightField.md) objects ## Errors 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 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/DescribeInsightDetails) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeInsightDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeInsightDetails) # DescribeInstanceTypeLimits Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type. ## Request Syntax ``` GET /2021-01-01/opensearch/instanceTypeLimits/EngineVersion/InstanceType?domainName=DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DescribeInstanceTypeLimits_RequestSyntax) ** The name of the domain. Only specify if you need the limits for an existing domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` ** [EngineVersion](#API_DescribeInstanceTypeLimits_RequestSyntax) ** Version of OpenSearch or Elasticsearch, in the format Elasticsearch\$1X.Y or OpenSearch\$1X.Y. Defaults to the latest version of OpenSearch. Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` Required: Yes ** [InstanceType](#API_DescribeInstanceTypeLimits_RequestSyntax) ** The OpenSearch Service instance type for which you need limit information. Valid Values: `m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "LimitsByRole": { "string" : { "AdditionalLimits": [ { "LimitName": "string", "LimitValues": [ "string" ] } ], "InstanceLimits": { "InstanceCountLimits": { "MaximumInstanceCount": number, "MinimumInstanceCount": number } }, "StorageTypes": [ { "StorageSubTypeName": "string", "StorageTypeLimits": [ { "LimitName": "string", "LimitValues": [ "string" ] } ], "StorageTypeName": "string" } ] } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [LimitsByRole](#API_DescribeInstanceTypeLimits_ResponseSyntax) ** Map that contains all applicable instance type limits.`data` refers to data nodes.`master` refers to dedicated master nodes. Type: String to [Limits](API_Limits.md) object map ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** InvalidTypeException ** An exception for trying to create or access a sub-resource that's either invalid or not supported. HTTP Status Code: 409 ** 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 ## Examples ### Example This example illustrates one usage of DescribeInstanceTypeLimits. #### Sample Request ``` GET /2021-01-01/opensearch/instanceTypeLimits/OpenSearch_1.0/c5.large.search?domainName=mydomain HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.0 Python/3.11.6 Darwin/23.2.0 exe/x86_64 prompt/off command/opensearch.describe-instance-type-limits X-Amz-Date: 20240118T183818Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240118/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=b8e8474eba198ee0a30b422c5196860943c1ed944a599160aa070268db1c17fa ``` #### Sample Response ``` { "LimitsByRole": { "data": { "AdditionalLimits": [{ "LimitName": "MaximumNumberOfDataNodesWithoutMasterNode", "LimitValues": ["10"] }], "InstanceLimits": { "InstanceCountLimits": { "MaximumInstanceCount": 80, "MinimumInstanceCount": 1 } }, "StorageTypes": [{ "StorageSubTypeName": "standard", "StorageTypeLimits": [{ "LimitName": "MaximumVolumeSize", "LimitValues": ["100"] }, { "LimitName": "MinimumVolumeSize", "LimitValues": ["10"] }], "StorageTypeName": "ebs" }, { "StorageSubTypeName": "io1", "StorageTypeLimits": [{ "LimitName": "MaximumVolumeSize", "LimitValues": ["256"] }, { "LimitName": "MinimumVolumeSize", "LimitValues": ["35"] }, { "LimitName": "MaximumIops", "LimitValues": ["16000"] }, { "LimitName": "MinimumIops", "LimitValues": ["1000"] }], "StorageTypeName": "ebs" }, { "StorageSubTypeName": "gp2", "StorageTypeLimits": [{ "LimitName": "MaximumVolumeSize", "LimitValues": ["256"] }, { "LimitName": "MinimumVolumeSize", "LimitValues": ["10"] }], "StorageTypeName": "ebs" }, { "StorageSubTypeName": "gp3", "StorageTypeLimits": [{ "LimitName": "MaximumVolumeSize", "LimitValues": ["256"] }, { "LimitName": "MinimumVolumeSize", "LimitValues": ["10"] }, { "LimitName": "MaximumIops", "LimitValues": ["20000"] }, { "LimitName": "MinimumIops", "LimitValues": ["3000"] }, { "LimitName": "MaximumThroughput", "LimitValues": ["593"] }, { "LimitName": "MinimumThroughput", "LimitValues": ["125"] }], "StorageTypeName": "ebs" }] }, "master": { "AdditionalLimits": [{ "LimitName": "MaximumNumberOfDataNodesSupported", "LimitValues": ["200"] }], "InstanceLimits": { "InstanceCountLimits": { "MaximumInstanceCount": 5, "MinimumInstanceCount": 2 } }, "StorageTypes": null } } } ``` ## See Also 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/DescribeInstanceTypeLimits) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeInstanceTypeLimits) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeInstanceTypeLimits) # DescribeOutboundConnections Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see [Cross-cluster search for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html). ## Request Syntax ``` POST /2021-01-01/opensearch/cc/outboundConnection/search HTTP/1.1 Content-type: application/json { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Filters](#API_DescribeOutboundConnections_RequestSyntax) ** List of filter names and values that you can use for requests. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_DescribeOutboundConnections_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Type: Integer Valid Range: Maximum value of 100. Required: No ** [NextToken](#API_DescribeOutboundConnections_RequestSyntax) ** If your initial `DescribeOutboundConnections` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribeOutboundConnections` operations, which returns results in the next page. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connections": [ { "ConnectionAlias": "string", "ConnectionId": "string", "ConnectionMode": "string", "ConnectionProperties": { "CrossClusterSearch": { "SkipUnavailable": "string" }, "Endpoint": "string" }, "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connections](#API_DescribeOutboundConnections_ResponseSyntax) ** List of outbound connections that match the filter criteria. Type: Array of [OutboundConnection](API_OutboundConnection.md) objects ** [NextToken](#API_DescribeOutboundConnections_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** InvalidPaginationTokenException ** Request processing failed because you provided an invalid pagination token. HTTP Status Code: 400 ## See Also 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/DescribeOutboundConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeOutboundConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeOutboundConnections) # DescribePackages Describes all packages available to OpenSearch Service. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` POST /2021-01-01/packages/describe HTTP/1.1 Content-type: application/json { "Filters": [ { "Name": "string", "Value": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Filters](#API_DescribePackages_RequestSyntax) ** Only returns packages that match the `DescribePackagesFilterList` values. Type: Array of [DescribePackagesFilter](API_DescribePackagesFilter.md) objects Required: No ** [MaxResults](#API_DescribePackages_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Type: Integer Valid Range: Maximum value of 100. Required: No ** [NextToken](#API_DescribePackages_RequestSyntax) ** If your initial `DescribePackageFilters` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribePackageFilters` operations, which returns results in the next page. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "PackageDetailsList": [ { "AllowListedUserList": [ "string" ], "AvailablePackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "AvailablePackageVersion": "string", "AvailablePluginProperties": { "ClassName": "string", "Description": "string", "Name": "string", "UncompressedSizeInBytes": number, "Version": "string" }, "CreatedAt": number, "EngineVersion": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdatedAt": number, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageID": "string", "PackageName": "string", "PackageOwner": "string", "PackageStatus": "string", "PackageType": "string", "PackageVendingOptions": { "VendingEnabled": boolean } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribePackages_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [PackageDetailsList](#API_DescribePackages_ResponseSyntax) ** Basic information about a package. Type: Array of [PackageDetails](API_PackageDetails.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DescribePackages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribePackages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribePackages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribePackages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribePackages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribePackages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribePackages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribePackages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribePackages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribePackages) # DescribeReservedInstanceOfferings Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see [Reserved Instances in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html). ## Request Syntax ``` GET /2021-01-01/opensearch/reservedInstanceOfferings?maxResults=MaxResults&nextToken=NextToken&offeringId=ReservedInstanceOfferingId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_DescribeReservedInstanceOfferings_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_DescribeReservedInstanceOfferings_RequestSyntax) ** If your initial `DescribeReservedInstanceOfferings` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribeReservedInstanceOfferings` operations, which returns results in the next page. ** [ReservedInstanceOfferingId](#API_DescribeReservedInstanceOfferings_RequestSyntax) ** The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier. Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ReservedInstanceOfferings": [ { "CurrencyCode": "string", "Duration": number, "FixedPrice": number, "InstanceType": "string", "PaymentOption": "string", "RecurringCharges": [ { "RecurringChargeAmount": number, "RecurringChargeFrequency": "string" } ], "ReservedInstanceOfferingId": "string", "UsagePrice": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeReservedInstanceOfferings_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [ReservedInstanceOfferings](#API_DescribeReservedInstanceOfferings_ResponseSyntax) ** List of Reserved Instance offerings. Type: Array of [ReservedInstanceOffering](API_ReservedInstanceOffering.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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 ## Examples ### Example This example illustrates one usage of DescribeReservedInstanceOfferings. #### Sample Request ``` GET /2021-01-01/opensearch/reservedInstanceOfferings HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.describe-reserved-instance-offerings X-Amz-Date: 20240124T220658Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240124/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=783312e88bf3347692920c6ad8ad623076adad31ba9163f1eeb8bc4d13f18af1 ``` #### Sample Response ``` { "NextToken": "AAIAAbxp74VqN95JGZaj8LVBCCmsvixjjXg69X568WWf4AB16hLb26cZK8txZe5-JzDAB4SXGW5fOTI=", "ReservedInstanceOfferings": [{ "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 17587.89, "InstanceType": "r6g.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.669, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "015f676e-ec97-4d63-9a5b-7f47fe4f3591", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "m6g.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.706, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "01cd94a4-8540-44b5-9cc6-a9e2121b4689", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 12811.29, "InstanceType": "im4gn.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.462, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "01e3d453-f2b3-4e00-8750-ef3a1af1f156", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "r5.12xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 2.319, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "02c3becc-bb0c-42c0-b0b3-caf3c59ee2e0", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 25703.0, "InstanceType": "c5.18xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0345b77e-8f40-480c-926c-fdfa853c256b", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 13247.0, "InstanceType": "c5.18xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.512, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "03cee79c-9727-4a0d-90eb-cd76fb10236b", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1473.0, "InstanceType": "c5.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.168, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "04c5179c-0382-4374-b583-7a6903cd9b74", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 6623.0, "InstanceType": "c5.9xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.756, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "066bdd2f-0012-43d4-a2c0-6f70ffecc0e0", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1611.0, "InstanceType": "m5.xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0688f67d-1085-4fbd-aca6-03739928ae52", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 6721.11, "InstanceType": "m6g.4xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.256, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "07027a1d-8435-4d21-80e5-4fca0804a7d0", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "c6g.large.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.059, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "073dbec3-4dba-49d2-9003-3ea1dc979b4f", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "c4.large.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.077, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "076da64d-9a9b-43b6-a1c2-236081704c59", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 11371.0, "InstanceType": "i3.4xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "081c153a-a3dc-401d-84c8-7837281d2c55", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 1484.82, "InstanceType": "c6g.xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.057, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "08784d80-853d-4b78-891c-384afbd4286c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "or1.16xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 4.611, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "08e7ab36-cf38-4c89-aac3-4b81c49a1423", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1499.581, "InstanceType": "m6g.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.171, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "097d13c1-0669-45e2-b5a9-1efc885afa2c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 14340.996, "InstanceType": "im4gn.4xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.546, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0a91faeb-75ee-4607-8edc-1fe3d715d583", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1326.439, "InstanceType": "c6g.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.151, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0ade739a-3ee7-4a3b-a41c-5644cf398c7e", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 9212.0, "InstanceType": "r4.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.052, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0b38d87c-90fb-4fc5-969b-2520baf4b8e6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 2509.74, "InstanceType": "r6gd.xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.096, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0ce36cbf-d16e-4792-b1c4-571bb514d197", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 8934.0, "InstanceType": "r4.4xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0cf79ea1-38a6-4675-8b57-3aa123f34b2b", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "i3.8xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 2.756, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "0df4f876-9fea-4bb0-b98d-c620e55ca8f8", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 5824.962, "InstanceType": "m6g.4xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "105cb1e1-dbae-4854-935c-33cd225521c8", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "m4.10xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.569, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "112f905a-29a0-49df-b21a-6324e556f6a5", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "r4.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.083, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "116a750e-1e71-4422-a1ea-0e8d392f5e4a", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "r5.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.773, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "11c85dc7-1545-4c83-8862-244eafd7f818", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 821.0, "InstanceType": "c5.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.031, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1212edd1-2ee7-465b-9d4e-7d8b9c1ea30d", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 992.0, "InstanceType": "m4.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.038, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1338aa00-2414-413a-bf40-2b09fe638675", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 4470.0, "InstanceType": "r4.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "13db2214-36dd-4c1c-b5db-5cc8abb365ea", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "m4.10xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 2.082, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "14677ece-7a9f-4ee4-8526-c70eb261a69c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "or1.12xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 2.61, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "153e62b0-cd23-4e85-821c-f1e3f368950c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 17423.64, "InstanceType": "r6gd.8xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "15b57aa7-dee6-4c0f-bc60-cbdba1851710", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 19822.0, "InstanceType": "m4.10xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.754, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "15fa414b-3e2e-4544-a38b-56615fa7d2b3", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "or1.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.87, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "16335325-2b2a-40f6-9363-26f8e4ec4061", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 28583.88, "InstanceType": "or1.12xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "16c59680-2efc-4b51-bc75-97b4c53bb07d", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 256.0, "InstanceType": "t3.medium.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.029, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "16f88f6e-2306-4906-85fd-2cf527c31543", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "r6g.2xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.462, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "18420266-f2bc-4391-9acb-72776fde40c4", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1286.844, "InstanceType": "c6g.xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1898e1d0-60d3-4804-93df-0be7e056d178", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 7713.0, "InstanceType": "c4.4xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.294, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1a5c5d1f-9503-409f-a46c-9cc098bf6c4d", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 3357.27, "InstanceType": "m6g.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.128, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1c542365-2862-4be3-9c3b-af946c152deb", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1661.0, "InstanceType": "m5.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.19, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1c71d96c-d7a3-4327-aa51-a44a8bed21ea", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 2444.0, "InstanceType": "r5.xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.093, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1c740f32-41af-4f95-b009-cb9554b15b3f", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1116.0, "InstanceType": "r4.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1c95d898-f905-44a0-8a5c-678fd6e18d1b", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 79193.0, "InstanceType": "r4.16xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1d3fbb87-f303-4cfa-904d-6744fcd73035", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 7405.0, "InstanceType": "c4.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1d5a729c-cd3a-4a1f-b673-d1e44deac503", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 9972.0, "InstanceType": "m5.12xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.138, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1d893473-bf0c-4ae3-a11e-795acbcfed0d", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 2858.0, "InstanceType": "c5.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1d96e496-089f-4e7b-a1e2-f45de2667637", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 490.078, "InstanceType": "r6g.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.056, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1e3258c4-015d-4c7c-9d16-d600ccd17009", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 7170.498, "InstanceType": "im4gn.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.273, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1e665757-1104-4a31-ab6e-a9de908a3105", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 3229.286, "InstanceType": "m6g.xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1ea3acb7-83f9-4461-8116-040f101c43fe", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1190.046, "InstanceType": "or1.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1f5d54e9-0ec9-4ca7-a87d-9b34bc04ea45", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "c5.2xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.261, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1fe732c5-6cd2-4ce0-b2ba-cfd2d347eaea", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 19052.124, "InstanceType": "or1.8xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "1ff80eab-b0a3-4cc4-b900-c9c3fb51a4c8", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "m6g.xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.177, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "202bc81a-05dd-42c5-8ed1-9c6e4502dc23", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 50659.43, "InstanceType": "r6g.12xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "205c1007-d5a0-456e-bbc1-9308ffbbbf63", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "c6g.xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.156, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2146577c-010d-4422-b03e-b5f4fee65c42", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 4604.0, "InstanceType": "r4.4xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.526, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "22b1be5c-1e8f-4283-b8e7-7f8ee41b1236", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 2452.8, "InstanceType": "or1.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.28, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "22f1caa7-5831-4828-83c3-2b57d4de64b6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "r4.16xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 3.265, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2340e872-66d0-44a4-8e03-7d22eb0e5895", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 40201.83, "InstanceType": "r6gd.16xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.53, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2357617f-da8b-4eb5-a91e-9d115ed9b479", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 15425.046, "InstanceType": "c6g.12xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "23902774-1cba-44b0-9ac7-da616c70cc12", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 28681.992, "InstanceType": "im4gn.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.091, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "245da32c-86a5-4a48-9f74-77f0a41cb300", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 712.0, "InstanceType": "c5.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "24d2f163-105f-4360-8f25-2419a304c26a", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "r6gd.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.796, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "24f0be5e-513b-4b3b-bee8-ec474d8c8689", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1907.49, "InstanceType": "r6g.xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2500d63d-f25d-49c7-a028-61ec2455b874", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 840.96, "InstanceType": "m6g.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.032, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "26614ac7-2d46-4cae-afad-740d191fc788", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 5701.709, "InstanceType": "c6g.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2682174d-11e4-44f2-bce1-b3441e19abdf", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "m5.large.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.098, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "26f0a787-8714-4611-8bfb-550f94e647f4", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 6001.257, "InstanceType": "m6g.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.685, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2703ebe7-32c0-4333-942a-ccc66ee4742f", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 546.0, "InstanceType": "r5.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.062, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "270e7bdb-0954-4b32-9ffe-c79ceba20ec4", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 20104.2, "InstanceType": "r6gd.8xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.765, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "27386c75-5c25-4fa7-b09e-93ba6a98bdab", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 883.0, "InstanceType": "m4.xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.101, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "27624678-306d-4994-80e5-5831a4bd6267", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 597.87, "InstanceType": "or1.medium.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2787cbb4-3900-44ac-895c-381be095eac6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 12589.0, "InstanceType": "i3.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "289ec817-9479-4a93-87f0-b168e8e05acc", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 38053.002, "InstanceType": "or1.16xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "28b0e66b-e754-4907-9e37-e6c3005c2a56", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "m6g.4xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.532, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "29875713-058a-44e6-93e3-9e9adb2c9893", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "r5.2xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.513, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "29bb322a-8795-4c1a-a568-86657989a31e", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 7624.266, "InstanceType": "r6g.4xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2a5013f1-9a4a-4378-ac10-d529dc71136c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 575.0, "InstanceType": "r4.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.066, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2ae48c42-c556-43e4-af03-af472b3d579f", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "r5.12xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 3.077, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2b3098fc-7fec-4bb8-8f7b-43e454c5be78", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 10052.1, "InstanceType": "r6gd.4xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.383, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2b7743ec-ce93-4ae1-827d-83192cba0610", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 10545.638, "InstanceType": "or1.2xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2bdc713e-7240-4b26-82f7-986294e5c489", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1087.554, "InstanceType": "r6gd.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2ccd9263-7d0e-4e83-b70b-8f0a259a881a", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 39597.0, "InstanceType": "r4.8xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2d995bb3-00bd-4924-ba5a-aa50630506b6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 1097.19, "InstanceType": "r6g.large.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.042, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2e380e6e-130b-4cfb-8da3-e458defba6f6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 2244.969, "InstanceType": "r6gd.2xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.256, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2ee4c7c1-f162-40e8-91b9-6a015409f6a2", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 5285.434, "InstanceType": "or1.xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2f36cb75-ef17-4ce2-9082-8b48dd3fd9e9", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "r4.xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.204, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2f36f1af-4a75-4736-b4d2-c96c747c0f09", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "i3.xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.259, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "2fa008d1-6f07-4f6a-8602-56c0b24ee8a1", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "m6g.large.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.067, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "314ab470-5920-4efb-9ceb-12c3fe3b14ac", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 1425.427, "InstanceType": "c6g.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "317dfe20-f11d-4524-97cd-360c09f6caa6", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 1859.0, "InstanceType": "m5.xlarge.search", "PaymentOption": "PARTIAL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.071, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "32215331-1366-4bed-bd07-f345ad3a24eb", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 6685.0, "InstanceType": "c4.4xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "32977df3-b9a3-48b2-af6d-1cd6dc64902d", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 1614.643, "InstanceType": "m6g.large.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "32a8e2e4-877c-49bb-aca2-8ac004783acb", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 22781.606, "InstanceType": "c6g.8xlarge.search", "PaymentOption": "ALL_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.0, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "3559397a-10cc-4e30-a8e8-8c105cd2572c", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "r6gd.16xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 4.222, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "35d3c0cc-d935-4847-96f5-240149fd35e3", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "m6g.2xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.353, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "3612dd00-b132-43ee-adb8-71666412ca89", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "c6g.8xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 1.246, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "361ad9aa-d816-4de5-a5a5-8a129558a1da", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 0.0, "InstanceType": "c5.2xlarge.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.346, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "365cfbb6-2d5c-4973-ad73-b511cebe907a", "UsagePrice": 0.0 }, { "CurrencyCode": "USD", "Duration": 94608000, "FixedPrice": 0.0, "InstanceType": "c5.large.search", "PaymentOption": "NO_UPFRONT", "RecurringCharges": [{ "RecurringChargeAmount": 0.065, "RecurringChargeFrequency": "Hourly" }], "ReservedInstanceOfferingId": "36b7e031-8778-421a-9eb3-232ddfc14ef6", "UsagePrice": 0.0 }] } ``` ## See Also 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/DescribeReservedInstanceOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeReservedInstanceOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeReservedInstanceOfferings) # DescribeReservedInstances Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see [Reserved Instances in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html). ## Request Syntax ``` GET /2021-01-01/opensearch/reservedInstances?maxResults=MaxResults&nextToken=NextToken&reservationId=ReservedInstanceId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_DescribeReservedInstances_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_DescribeReservedInstances_RequestSyntax) ** If your initial `DescribeReservedInstances` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `DescribeReservedInstances` operations, which returns results in the next page. ** [ReservedInstanceId](#API_DescribeReservedInstances_RequestSyntax) ** The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID. Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ReservedInstances": [ { "BillingSubscriptionId": number, "CurrencyCode": "string", "Duration": number, "FixedPrice": number, "InstanceCount": number, "InstanceType": "string", "PaymentOption": "string", "RecurringCharges": [ { "RecurringChargeAmount": number, "RecurringChargeFrequency": "string" } ], "ReservationName": "string", "ReservedInstanceId": "string", "ReservedInstanceOfferingId": "string", "StartTime": number, "State": "string", "UsagePrice": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeReservedInstances_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [ReservedInstances](#API_DescribeReservedInstances_ResponseSyntax) ** List of Reserved Instances in the current Region. Type: Array of [ReservedInstance](API_ReservedInstance.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** 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 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/DescribeReservedInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeReservedInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeReservedInstances) # DescribeVpcEndpoints Describes one or more Amazon OpenSearch Service-managed VPC endpoints. ## Request Syntax ``` POST /2021-01-01/opensearch/vpcEndpoints/describe HTTP/1.1 Content-type: application/json { "VpcEndpointIds": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [VpcEndpointIds](#API_DescribeVpcEndpoints_RequestSyntax) ** The unique identifiers of the endpoints to get information about. Type: Array of strings Length Constraints: Minimum length of 5. Maximum length of 256. Pattern: `^aos-[a-zA-Z0-9]*$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "VpcEndpointErrors": [ { "ErrorCode": "string", "ErrorMessage": "string", "VpcEndpointId": "string" } ], "VpcEndpoints": [ { "DomainArn": "string", "Endpoint": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string", "VpcOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [VpcEndpointErrors](#API_DescribeVpcEndpoints_ResponseSyntax) ** Any errors associated with the request. Type: Array of [VpcEndpointError](API_VpcEndpointError.md) objects ** [VpcEndpoints](#API_DescribeVpcEndpoints_ResponseSyntax) ** Information about each requested VPC endpoint. Type: Array of [VpcEndpoint](API_VpcEndpoint.md) objects ## Errors 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 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/DescribeVpcEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DescribeVpcEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DescribeVpcEndpoints) # DissociatePackage Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` POST /2021-01-01/packages/dissociate/PackageID/DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_DissociatePackage_RequestSyntax) ** Name of the domain to dissociate the package from. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PackageID](#API_DissociatePackage_RequestSyntax) ** Internal ID of the package to dissociate from the domain. Use `ListPackagesForDomain` to find this value. Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetails": { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetails](#API_DissociatePackage_ResponseSyntax) ** Information about a package that has been dissociated from the domain. Type: [DomainPackageDetails](API_DomainPackageDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/DissociatePackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DissociatePackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DissociatePackage) # DissociatePackages Dissociates multiple packages from a domain simultaneously. ## Request Syntax ``` POST /2021-01-01/packages/dissociateMultiple HTTP/1.1 Content-type: application/json { "DomainName": "string", "PackageList": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DomainName](#API_DissociatePackages_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PackageList](#API_DissociatePackages_RequestSyntax) ** A list of package IDs to be dissociated from a domain. Type: Array of strings Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetailsList": [ { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetailsList](#API_DissociatePackages_ResponseSyntax) ** A list of package details for the packages that were dissociated from the domain. Type: Array of [DomainPackageDetails](API_DomainPackageDetails.md) objects ## Errors 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 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/DissociatePackages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/DissociatePackages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/DissociatePackages) # GetApplication Retrieves the configuration and status of an existing OpenSearch application. ## Request Syntax ``` GET /2021-01-01/opensearch/application/id HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_GetApplication_RequestSyntax) ** The unique identifier of the OpenSearch application to retrieve. Pattern: `[a-z0-9]{3,30}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appConfigs": [ { "key": "string", "value": "string" } ], "arn": "string", "createdAt": number, "dataSources": [ { "dataSourceArn": "string", "dataSourceDescription": "string", "iamRoleForDataSourceArn": "string" } ], "endpoint": "string", "iamIdentityCenterOptions": { "enabled": boolean, "iamIdentityCenterApplicationArn": "string", "iamIdentityCenterInstanceArn": "string", "iamRoleForIdentityCenterApplicationArn": "string" }, "id": "string", "kmsKeyArn": "string", "lastUpdatedAt": number, "name": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [appConfigs](#API_GetApplication_ResponseSyntax) ** The configuration settings of the OpenSearch application. Type: Array of [AppConfig](API_AppConfig.md) objects Array Members: Maximum number of 200 items. ** [arn](#API_GetApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ** [createdAt](#API_GetApplication_ResponseSyntax) ** The timestamp when the OpenSearch application was created. Type: Timestamp ** [dataSources](#API_GetApplication_ResponseSyntax) ** The data sources associated with the OpenSearch application. Type: Array of [DataSource](API_DataSource.md) objects ** [endpoint](#API_GetApplication_ResponseSyntax) ** The endpoint URL of the OpenSearch application. Type: String ** [iamIdentityCenterOptions](#API_GetApplication_ResponseSyntax) ** The IAM Identity Center settings configured for the OpenSearch application. Type: [IamIdentityCenterOptions](API_IamIdentityCenterOptions.md) object ** [id](#API_GetApplication_ResponseSyntax) ** The unique identifier of the OpenSearch application. Type: String Pattern: `[a-z0-9]{3,30}` ** [kmsKeyArn](#API_GetApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the KMS key used to encrypt the application's data at rest. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` ** [lastUpdatedAt](#API_GetApplication_ResponseSyntax) ** The timestamp of the last update to the OpenSearch application. Type: Timestamp ** [name](#API_GetApplication_ResponseSyntax) ** The name of the OpenSearch application. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `[a-z][a-z0-9\-]+` ** [status](#API_GetApplication_ResponseSyntax) ** The current status of the OpenSearch application. Possible values: `CREATING`, `UPDATING`, `DELETING`, `FAILED`, `ACTIVE`, and `DELETED`. Type: String Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** 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 ** 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 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/GetApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetApplication) # GetCapability Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status. ## Request Syntax ``` GET /2021-01-01/opensearch/application/ApplicationId/capability/CapabilityName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ApplicationId](#API_GetCapability_RequestSyntax) ** The unique identifier of the OpenSearch UI application. Pattern: `[a-z0-9]{3,30}` Required: Yes ** [CapabilityName](#API_GetCapability_RequestSyntax) ** The name of the capability to retrieve information about. Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `^[a-zA-Z0-9-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "capabilityConfig": { ... }, "capabilityName": "string", "failures": [ { "details": "string", "reason": "string" } ], "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationId](#API_GetCapability_ResponseSyntax) ** The unique identifier of the OpenSearch UI application. Type: String Pattern: `[a-z0-9]{3,30}` ** [capabilityConfig](#API_GetCapability_ResponseSyntax) ** The configuration settings for the capability, including capability-specific settings such as AI configuration. Type: [CapabilityExtendedResponseConfig](API_CapabilityExtendedResponseConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [capabilityName](#API_GetCapability_ResponseSyntax) ** The name of the capability. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `^[a-zA-Z0-9-]+$` ** [failures](#API_GetCapability_ResponseSyntax) ** A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong. Type: Array of [CapabilityFailure](API_CapabilityFailure.md) objects ** [status](#API_GetCapability_ResponseSyntax) ** The current status of the capability. Possible values: `creating`, `create_failed`, `active`, `updating`, `update_failed`, `deleting`, `delete_failed`. Type: String Valid Values: `creating | create_failed | active | updating | update_failed | deleting | delete_failed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** 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 ** 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 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/GetCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetCapability) # GetCompatibleVersions Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. ## Request Syntax ``` GET /2021-01-01/opensearch/compatibleVersions?domainName=DomainName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetCompatibleVersions_RequestSyntax) ** The name of an existing domain. Provide this parameter to limit the results to a single domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "CompatibleVersions": [ { "SourceVersion": "string", "TargetVersions": [ "string" ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [CompatibleVersions](#API_GetCompatibleVersions_ResponseSyntax) ** A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. Type: Array of [CompatibleVersionsMap](API_CompatibleVersionsMap.md) objects ## Errors 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 ** 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 ## Examples ### Example This example illustrates one usage of GetCompatibleVersions. #### Sample Request ``` GET /2021-01-01/opensearch/compatibleVersions HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.get-compatible-versions X-Amz-Date: 20240205T201155Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240205/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=5e11eba0d22362bc27334dd0143baa002edee9d967b2653fd9bd7d87bec71b8c ``` #### Sample Response ``` { "CompatibleVersions":[ { "SourceVersion":"Elasticsearch_7.7", "TargetVersions":[ "Elasticsearch_7.8", "Elasticsearch_7.9", "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_6.8", "TargetVersions":[ "Elasticsearch_7.1", "Elasticsearch_7.4", "Elasticsearch_7.7", "Elasticsearch_7.8", "Elasticsearch_7.9", "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_7.8", "TargetVersions":[ "Elasticsearch_7.9", "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_7.9", "TargetVersions":[ "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"OpenSearch_2.3", "TargetVersions":[ "OpenSearch_2.5", "OpenSearch_2.7", "OpenSearch_2.9", "OpenSearch_2.11" ] }, { "SourceVersion":"OpenSearch_2.5", "TargetVersions":[ "OpenSearch_2.7", "OpenSearch_2.9", "OpenSearch_2.11" ] }, { "SourceVersion":"OpenSearch_1.0", "TargetVersions":[ "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"OpenSearch_1.1", "TargetVersions":[ "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"OpenSearch_1.2", "TargetVersions":[ "OpenSearch_1.3" ] }, { "SourceVersion":"OpenSearch_1.3", "TargetVersions":[ "OpenSearch_2.3", "OpenSearch_2.5", "OpenSearch_2.7", "OpenSearch_2.9", "OpenSearch_2.11" ] }, { "SourceVersion":"OpenSearch_2.7", "TargetVersions":[ "OpenSearch_2.9", "OpenSearch_2.11" ] }, { "SourceVersion":"OpenSearch_2.9", "TargetVersions":[ "OpenSearch_2.11" ] }, { "SourceVersion":"Elasticsearch_7.10", "TargetVersions":[ "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_6.0", "TargetVersions":[ "Elasticsearch_6.3", "Elasticsearch_6.4", "Elasticsearch_6.5", "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_5.1", "TargetVersions":[ "Elasticsearch_5.6" ] }, { "SourceVersion":"Elasticsearch_7.1", "TargetVersions":[ "Elasticsearch_7.4", "Elasticsearch_7.7", "Elasticsearch_7.8", "Elasticsearch_7.9", "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_6.2", "TargetVersions":[ "Elasticsearch_6.3", "Elasticsearch_6.4", "Elasticsearch_6.5", "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_5.3", "TargetVersions":[ "Elasticsearch_5.6" ] }, { "SourceVersion":"Elasticsearch_6.3", "TargetVersions":[ "Elasticsearch_6.4", "Elasticsearch_6.5", "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_6.4", "TargetVersions":[ "Elasticsearch_6.5", "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_5.5", "TargetVersions":[ "Elasticsearch_5.6" ] }, { "SourceVersion":"Elasticsearch_7.4", "TargetVersions":[ "Elasticsearch_7.7", "Elasticsearch_7.8", "Elasticsearch_7.9", "Elasticsearch_7.10", "OpenSearch_1.0", "OpenSearch_1.1", "OpenSearch_1.2", "OpenSearch_1.3" ] }, { "SourceVersion":"Elasticsearch_6.5", "TargetVersions":[ "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_5.6", "TargetVersions":[ "Elasticsearch_6.3", "Elasticsearch_6.4", "Elasticsearch_6.5", "Elasticsearch_6.7", "Elasticsearch_6.8" ] }, { "SourceVersion":"Elasticsearch_6.7", "TargetVersions":[ "Elasticsearch_6.8" ] } ] } ``` ## See Also 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/GetCompatibleVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetCompatibleVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetCompatibleVersions) # GetDataSource Retrieves information about a direct query data source. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/dataSource/DataSourceName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetDataSource_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [DataSourceName](#API_GetDataSource_RequestSyntax) ** The name of the data source to get information about. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataSourceType": { ... }, "Description": "string", "Name": "string", "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DataSourceType](#API_GetDataSource_ResponseSyntax) ** The type of data source. Type: [DataSourceType](API_DataSourceType.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [Description](#API_GetDataSource_ResponseSyntax) ** A description of the data source. Type: String Length Constraints: Maximum length of 1000. Pattern: `^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$` ** [Name](#API_GetDataSource_ResponseSyntax) ** The name of the data source. Type: String Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` ** [Status](#API_GetDataSource_ResponseSyntax) ** The status of the data source. Type: String Valid Values: `ACTIVE | DISABLED` ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** 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 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/GetDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetDataSource) # GetDefaultApplicationSetting Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error. ## Request Syntax ``` GET /2021-01-01/opensearch/defaultApplicationSetting HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationArn](#API_GetDefaultApplicationSetting_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/GetDefaultApplicationSetting) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetDefaultApplicationSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetDefaultApplicationSetting) # GetDirectQueryDataSource Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service. ## Request Syntax ``` GET /2021-01-01/opensearch/directQueryDataSource/DataSourceName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DataSourceName](#API_GetDirectQueryDataSource_RequestSyntax) ** A unique, user-defined label that identifies the data source within your OpenSearch Service environment. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataSourceAccessPolicy": "string", "DataSourceArn": "string", "DataSourceName": "string", "DataSourceType": { ... }, "Description": "string", "OpenSearchArns": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DataSourceAccessPolicy](#API_GetDirectQueryDataSource_ResponseSyntax) ** The IAM access policy document that defines the permissions for accessing the direct query data source. Returns the current policy configuration in JSON format, or null if no custom policy is configured. Type: String Length Constraints: Minimum length of 0. Maximum length of 102400. Pattern: `.*` ** [DataSourceArn](#API_GetDirectQueryDataSource_ResponseSyntax) ** The unique, system-generated identifier that represents the data source. Type: String ** [DataSourceName](#API_GetDirectQueryDataSource_ResponseSyntax) ** 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_]+` ** [DataSourceType](#API_GetDirectQueryDataSource_ResponseSyntax) ** The supported AWS service that is used 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. ** [Description](#API_GetDirectQueryDataSource_ResponseSyntax) ** A description that provides 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-]*$` ** [OpenSearchArns](#API_GetDirectQueryDataSource_ResponseSyntax) ** A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. Type: Array of strings Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ## Errors 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 ** 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 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/GetDirectQueryDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetDirectQueryDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetDirectQueryDataSource) # GetDomainMaintenanceStatus The status of the maintenance action. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/domainMaintenance?maintenanceId=MaintenanceId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetDomainMaintenanceStatus_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaintenanceId](#API_GetDomainMaintenanceStatus_RequestSyntax) ** The request ID of the maintenance action. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^([\s\S]*)$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Action": "string", "CreatedAt": number, "NodeId": "string", "Status": "string", "StatusMessage": "string", "UpdatedAt": number } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Action](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The action name. Type: String Valid Values: `REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD` ** [CreatedAt](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The time at which the action was created. Type: Timestamp ** [NodeId](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The node ID of the maintenance action. Type: String Length Constraints: Minimum length of 10. Maximum length of 40. ** [Status](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The status of the maintenance action. Type: String Valid Values: `PENDING | IN_PROGRESS | COMPLETED | FAILED | TIMED_OUT` ** [StatusMessage](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The status message of the maintenance action. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: `^([\s\S]*)$` ** [UpdatedAt](#API_GetDomainMaintenanceStatus_ResponseSyntax) ** The time at which the action was updated. Type: Timestamp ## Errors 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 ** 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 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/GetDomainMaintenanceStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetDomainMaintenanceStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetDomainMaintenanceStatus) # GetIndex Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/index/IndexName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetIndex_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [IndexName](#API_GetIndex_RequestSyntax) ** The name of the index to retrieve information about. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?!\.\.?$)[^_ ,:"+/*\\|?#> The JSON schema of the index including mappings, settings, and semantic enrichment configuration. Type: JSON value ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ** ThrottlingException ** The request was denied due to request throttling. Reduce the frequency of your requests and try again. HTTP Status Code: 429 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/GetIndex) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetIndex) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetIndex) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetIndex) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetIndex) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetIndex) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetIndex) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetIndex) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetIndex) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetIndex) # GetPackageVersionHistory Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` GET /2021-01-01/packages/PackageID/history?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_GetPackageVersionHistory_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_GetPackageVersionHistory_RequestSyntax) ** If your initial `GetPackageVersionHistory` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `GetPackageVersionHistory` operations, which returns results in the next page. ** [PackageID](#API_GetPackageVersionHistory_RequestSyntax) ** The unique identifier of the package. Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "PackageID": "string", "PackageVersionHistoryList": [ { "CommitMessage": "string", "CreatedAt": number, "PackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "PackageVersion": "string", "PluginProperties": { "ClassName": "string", "Description": "string", "Name": "string", "UncompressedSizeInBytes": number, "Version": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_GetPackageVersionHistory_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [PackageID](#API_GetPackageVersionHistory_ResponseSyntax) ** The unique identifier of the package. Type: String Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` ** [PackageVersionHistoryList](#API_GetPackageVersionHistory_ResponseSyntax) ** A list of package versions, along with their creation time and commit message. Type: Array of [PackageVersionHistory](API_PackageVersionHistory.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/GetPackageVersionHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetPackageVersionHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetPackageVersionHistory) # GetUpgradeHistory Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain. ## Request Syntax ``` GET /2021-01-01/opensearch/upgradeDomain/DomainName/history?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetUpgradeHistory_RequestSyntax) ** The name of an existing domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaxResults](#API_GetUpgradeHistory_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_GetUpgradeHistory_RequestSyntax) ** If your initial `GetUpgradeHistory` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `GetUpgradeHistory` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "UpgradeHistories": [ { "StartTimestamp": number, "StepsList": [ { "Issues": [ "string" ], "ProgressPercent": number, "UpgradeStep": "string", "UpgradeStepStatus": "string" } ], "UpgradeName": "string", "UpgradeStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_GetUpgradeHistory_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [UpgradeHistories](#API_GetUpgradeHistory_ResponseSyntax) ** A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain. Type: Array of [UpgradeHistory](API_UpgradeHistory.md) objects ## Errors 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 ** 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 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/GetUpgradeHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetUpgradeHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetUpgradeHistory) # GetUpgradeStatus Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain. ## Request Syntax ``` GET /2021-01-01/opensearch/upgradeDomain/DomainName/status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_GetUpgradeStatus_RequestSyntax) ** The domain of the domain to get upgrade status information for. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "StepStatus": "string", "UpgradeName": "string", "UpgradeStep": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [StepStatus](#API_GetUpgradeStatus_ResponseSyntax) ** The status of the current step that an upgrade is on. Type: String Valid Values: `IN_PROGRESS | SUCCEEDED | SUCCEEDED_WITH_ISSUES | FAILED` ** [UpgradeName](#API_GetUpgradeStatus_ResponseSyntax) ** A string that describes the update. Type: String ** [UpgradeStep](#API_GetUpgradeStatus_ResponseSyntax) ** One of three steps that an upgrade or upgrade eligibility check goes through. Type: String Valid Values: `PRE_UPGRADE_CHECK | SNAPSHOT | UPGRADE` ## Errors 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 ** 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 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/GetUpgradeStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/GetUpgradeStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/GetUpgradeStatus) # ListApplications Lists all OpenSearch applications under your account. ## Request Syntax ``` GET /2021-01-01/opensearch/list-applications?maxResults=maxResults&nextToken=nextToken&statuses=statuses HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListApplications_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return for a given request. Valid Range: Maximum value of 100. ** [nextToken](#API_ListApplications_RequestSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. ** [statuses](#API_ListApplications_RequestSyntax) ** Filters the list of OpenSearch applications by status. Possible values: `CREATING`, `UPDATING`, `DELETING`, `FAILED`, `ACTIVE`, and `DELETED`. Valid Values: `CREATING | UPDATING | DELETING | ACTIVE | FAILED` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ApplicationSummaries": [ { "arn": "string", "createdAt": number, "endpoint": "string", "id": "string", "lastUpdatedAt": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ApplicationSummaries](#API_ListApplications_ResponseSyntax) ** Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time. Type: Array of [ApplicationSummary](API_ApplicationSummary.md) objects ** [nextToken](#API_ListApplications_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** 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 ** 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 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/ListApplications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListApplications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListApplications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListApplications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListApplications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListApplications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListApplications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListApplications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListApplications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListApplications) # ListDataSources 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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html). ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/dataSource HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListDataSources_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataSources": [ { "DataSourceType": { ... }, "Description": "string", "Name": "string", "Status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DataSources](#API_ListDataSources_ResponseSyntax) ** A list of data sources associated with specified domain. Type: Array of [DataSourceDetails](API_DataSourceDetails.md) objects ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** 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 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/ListDataSources) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListDataSources) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListDataSources) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListDataSources) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListDataSources) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListDataSources) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListDataSources) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListDataSources) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListDataSources) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListDataSources) # ListDirectQueryDataSources Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service. ## Request Syntax ``` GET /2021-01-01/opensearch/directQueryDataSource?nexttoken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [NextToken](#API_ListDirectQueryDataSources_RequestSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DirectQueryDataSources": [ { "DataSourceArn": "string", "DataSourceName": "string", "DataSourceType": { ... }, "Description": "string", "OpenSearchArns": [ "string" ], "TagList": [ { "Key": "string", "Value": "string" } ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DirectQueryDataSources](#API_ListDirectQueryDataSources_ResponseSyntax) ** A list of the direct query data sources that are returned by the `ListDirectQueryDataSources` API operation. Type: Array of [DirectQueryDataSource](API_DirectQueryDataSource.md) objects ** [NextToken](#API_ListDirectQueryDataSources_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 ** 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 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/ListDirectQueryDataSources) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListDirectQueryDataSources) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListDirectQueryDataSources) # ListDomainMaintenances A list of maintenance actions for the domain. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/domainMaintenances?action=Action&maxResults=MaxResults&nextToken=NextToken&status=Status HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [Action](#API_ListDomainMaintenances_RequestSyntax) ** The name of the action. Valid Values: `REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD` ** [DomainName](#API_ListDomainMaintenances_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaxResults](#API_ListDomainMaintenances_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListDomainMaintenances_RequestSyntax) ** If your initial `ListDomainMaintenances` operation returns a `nextToken`, include the returned `nextToken` in subsequent `ListDomainMaintenances` operations, which returns results in the next page. ** [Status](#API_ListDomainMaintenances_RequestSyntax) ** The status of the action. Valid Values: `PENDING | IN_PROGRESS | COMPLETED | FAILED | TIMED_OUT` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainMaintenances": [ { "Action": "string", "CreatedAt": number, "DomainName": "string", "MaintenanceId": "string", "NodeId": "string", "Status": "string", "StatusMessage": "string", "UpdatedAt": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainMaintenances](#API_ListDomainMaintenances_ResponseSyntax) ** A list of the submitted maintenance actions. Type: Array of [DomainMaintenanceDetails](API_DomainMaintenanceDetails.md) objects ** [NextToken](#API_ListDomainMaintenances_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 ** 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 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/ListDomainMaintenances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListDomainMaintenances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListDomainMaintenances) # ListDomainNames Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region. ## Request Syntax ``` GET /2021-01-01/domain?engineType=EngineType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [EngineType](#API_ListDomainNames_RequestSyntax) ** Filters the output by domain engine type. Valid Values: `OpenSearch | Elasticsearch` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainNames": [ { "DomainName": "string", "EngineType": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainNames](#API_ListDomainNames_ResponseSyntax) ** The names of all OpenSearch Service domains owned by the current user and their respective engine types. Type: Array of [DomainInfo](API_DomainInfo.md) objects ## Errors 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 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of ListDomainNames. #### Sample Request ``` GET /2021-01-01/domain HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-domain-names X-Amz-Date: 20240209T223114Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEEcaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240209/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=47e588909eb82143e199bb6e4ec3c0cae11f20e4778fda277d68b0518bca962a ``` #### Sample Response ``` { "DomainNames":[ { "DomainName":"my-domain-1", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-2", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-3", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-4", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-5", "EngineType":"OpenSearch" }, { "DomainName":"my-domain-6", "EngineType":"OpenSearch" } ] } ``` ## See Also 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/ListDomainNames) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListDomainNames) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListDomainNames) # ListDomainsForPackage Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` GET /2021-01-01/packages/PackageID/domains?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListDomainsForPackage_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListDomainsForPackage_RequestSyntax) ** If your initial `ListDomainsForPackage` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListDomainsForPackage` operations, which returns results in the next page. ** [PackageID](#API_ListDomainsForPackage_RequestSyntax) ** The unique identifier of the package for which to list associated domains. Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetailsList": [ { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetailsList](#API_ListDomainsForPackage_ResponseSyntax) ** Information about all domains associated with a package. Type: Array of [DomainPackageDetails](API_DomainPackageDetails.md) objects ** [NextToken](#API_ListDomainsForPackage_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/ListDomainsForPackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListDomainsForPackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListDomainsForPackage) # ListInsights Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account. Returns a paginated list of insights based on the specified entity, filters, time range, and sort order. ## Request Syntax ``` POST /2021-01-01/opensearch/insights HTTP/1.1 Content-type: application/json { "Entity": { "Type": "string", "Value": "string" }, "MaxResults": number, "NextToken": "string", "SortOrder": "string", "TimeRange": { "From": number, "To": number } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Entity](#API_ListInsights_RequestSyntax) ** The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID. Type: [InsightEntity](API_InsightEntity.md) object Required: Yes ** [MaxResults](#API_ListInsights_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `NextToken` to get the next page of results. Valid values are 1 to 500. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No ** [NextToken](#API_ListInsights_RequestSyntax) ** If your initial `ListInsights` operation returns a `NextToken`, include the returned `NextToken` in subsequent `ListInsights` operations to retrieve the next page of results. Type: String Required: No ** [SortOrder](#API_ListInsights_RequestSyntax) ** The sort order for the results. Possible values are `ASC` (ascending) and `DESC` (descending). Type: String Valid Values: `ASC | DESC` Required: No ** [TimeRange](#API_ListInsights_RequestSyntax) ** The time range for filtering insights, specified as epoch millisecond timestamps. Type: [InsightTimeRange](API_InsightTimeRange.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Insights": [ { "CreationTime": number, "DisplayName": "string", "InsightId": "string", "IsExperimental": boolean, "Priority": "string", "Status": "string", "Type": "string", "UpdateTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Insights](#API_ListInsights_ResponseSyntax) ** The list of insights returned for the specified entity. Type: Array of [Insight](API_Insight.md) objects ** [NextToken](#API_ListInsights_ResponseSyntax) ** When `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 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/ListInsights) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListInsights) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListInsights) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListInsights) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListInsights) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListInsights) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListInsights) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListInsights) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListInsights) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListInsights) # ListInstanceTypeDetails Lists all instance types and available features for a given OpenSearch or Elasticsearch version. ## Request Syntax ``` GET /2021-01-01/opensearch/instanceTypeDetails/EngineVersion?domainName=DomainName&instanceType=InstanceType&maxResults=MaxResults&nextToken=NextToken&retrieveAZs=RetrieveAZs HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListInstanceTypeDetails_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` ** [EngineVersion](#API_ListInstanceTypeDetails_RequestSyntax) ** The version of OpenSearch or Elasticsearch, in the format Elasticsearch\$1X.Y or OpenSearch\$1X.Y. Defaults to the latest version of OpenSearch. Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` Required: Yes ** [InstanceType](#API_ListInstanceTypeDetails_RequestSyntax) ** An optional parameter that lists information for a given instance type. Length Constraints: Minimum length of 10. Maximum length of 40. Pattern: `^.*\..*\.search$` ** [MaxResults](#API_ListInstanceTypeDetails_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListInstanceTypeDetails_RequestSyntax) ** If your initial `ListInstanceTypeDetails` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListInstanceTypeDetails` operations, which returns results in the next page. ** [RetrieveAZs](#API_ListInstanceTypeDetails_RequestSyntax) ** An optional parameter that specifies the Availability Zones for the domain. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "InstanceTypeDetails": [ { "AdvancedSecurityEnabled": boolean, "AppLogsEnabled": boolean, "AvailabilityZones": [ "string" ], "CognitoEnabled": boolean, "EncryptionEnabled": boolean, "InstanceRole": [ "string" ], "InstanceType": "string", "WarmEnabled": boolean } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [InstanceTypeDetails](#API_ListInstanceTypeDetails_ResponseSyntax) ** Lists all supported instance types and features for the given OpenSearch or Elasticsearch version. Type: Array of [InstanceTypeDetails](API_InstanceTypeDetails.md) objects ** [NextToken](#API_ListInstanceTypeDetails_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 ## Examples ### Example This example illustrates one usage of ListInstanceTypeDetails. #### Sample Request ``` GET /2021-01-01/opensearch/instanceTypeDetails/OpenSearch_2.7 HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-instance-type-details X-Amz-Date: 20240205T214608Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEIwEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240205/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=ba339a65cce237509bf48253a8073a034173a5b198f693f9f29665d8bc6d4e48 ``` #### Sample Response ``` { "InstanceTypeDetails":[ { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r5.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c4.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m5.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m5.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c4.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.16xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r5.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i2.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r5.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"m3.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m5.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"r3.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r5.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.16xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.9xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c4.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m4.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"m3.medium.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"t3.medium.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"t3.small.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m5.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"r3.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "ultra_warm" ], "InstanceType":"ultrawarm1.large.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c4.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"r3.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"r3.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"t2.medium.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "ultra_warm" ], "InstanceType":"ultrawarm1.medium.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"t2.small.search", "WarmEnabled":false }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m4.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"m3.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.18xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i2.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m4.10xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c4.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r4.16xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c6g.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6g.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m4.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.12xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r5.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"r3.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"i3.8xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m5.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":false, "InstanceRole":[ "data", "master" ], "InstanceType":"m3.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"r6gd.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"im4gn.16xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m4.4xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"c5.2xlarge.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.large.search", "WarmEnabled":true }, { "AdvancedSecurityEnabled":true, "AppLogsEnabled":true, "AvailabilityZones":null, "CognitoEnabled":true, "EncryptionEnabled":true, "InstanceRole":[ "data", "master" ], "InstanceType":"m6g.8xlarge.search", "WarmEnabled":true } ], "NextToken":null } ``` ## See Also 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/ListInstanceTypeDetails) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListInstanceTypeDetails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListInstanceTypeDetails) # ListPackagesForDomain Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` GET /2021-01-01/domain/DomainName/packages?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListPackagesForDomain_RequestSyntax) ** The name of the domain for which you want to list associated packages. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaxResults](#API_ListPackagesForDomain_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListPackagesForDomain_RequestSyntax) ** If your initial `ListPackagesForDomain` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListPackagesForDomain` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainPackageDetailsList": [ { "AssociationConfiguration": { "KeyStoreAccessOption": { "KeyAccessRoleArn": "string", "KeyStoreAccessEnabled": boolean } }, "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "string", "PrerequisitePackageIDList": [ "string" ], "ReferencePath": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainPackageDetailsList](#API_ListPackagesForDomain_ResponseSyntax) ** List of all packages associated with a domain. Type: Array of [DomainPackageDetails](API_DomainPackageDetails.md) objects ** [NextToken](#API_ListPackagesForDomain_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/ListPackagesForDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListPackagesForDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListPackagesForDomain) # ListScheduledActions Retrieves a list of configuration changes that are scheduled for a domain. These changes can be [service software updates](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) or [blue/green Auto-Tune enhancements](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types). ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/scheduledActions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListScheduledActions_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [MaxResults](#API_ListScheduledActions_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListScheduledActions_RequestSyntax) ** If your initial `ListScheduledActions` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListScheduledActions` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ScheduledActions": [ { "Cancellable": boolean, "Description": "string", "Id": "string", "Mandatory": boolean, "ScheduledBy": "string", "ScheduledTime": number, "Severity": "string", "Status": "string", "Type": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListScheduledActions_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [ScheduledActions](#API_ListScheduledActions_ResponseSyntax) ** A list of actions that are scheduled for the domain. Type: Array of [ScheduledAction](API_ScheduledAction.md) objects ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** InvalidPaginationTokenException ** Request processing failed because you provided an invalid pagination token. HTTP Status Code: 400 ** 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 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/ListScheduledActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListScheduledActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListScheduledActions) # ListTags Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see [Tagging Amazon OpenSearch Service resources](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html). ## Request Syntax ``` GET /2021-01-01/tags/?arn=ARN HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ARN](#API_ListTags_RequestSyntax) ** Amazon Resource Name (ARN) for the domain, data source, or application to view tags for. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TagList](#API_ListTags_ResponseSyntax) ** List of resource tags associated with the specified domain, data source, or application. Type: Array of [Tag](API_Tag.md) objects ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 ## Examples ### Example This example illustrates one usage of ListTags. #### Sample Request ``` GET /2021-01-01/tags/?arn=arn%3Aaws%3Aes%3Aus-east-1%3A302040998751%3Adomain%2Fmarketing HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-tags X-Amz-Date: 20240212T221352Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEIwEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=8f19277a8b3e677b1f8efcfa58e419c04e83b6b79c2db3125b151c1c2f4c8539 ``` #### Sample Response ``` { "TagList": [ { "Key": "department", "Value": "marketing" } ] } ``` ## See Also 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/ListTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListTags) # ListVersions Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. ## Request Syntax ``` GET /2021-01-01/opensearch/versions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [MaxResults](#API_ListVersions_RequestSyntax) ** An optional parameter that specifies the maximum number of results to return. You can use `nextToken` to get the next page of results. Valid Range: Maximum value of 100. ** [NextToken](#API_ListVersions_RequestSyntax) ** If your initial `ListVersions` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListVersions` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Versions": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListVersions_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [Versions](#API_ListVersions_ResponseSyntax) ** A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. Type: Array of strings Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 ## Examples ### Example This example illustrates one usage of ListVersions. #### Sample Request ``` GET /2021-01-01/opensearch/versions HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-versions X-Amz-Date: 20240205T211126Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240205/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=10e4bd0052c108fb022e79d4f122329d00a6d376054dadefcd81bb8df728d808 ``` #### Sample Response ``` { "NextToken":null, "Versions":[ "OpenSearch_2.11", "OpenSearch_2.9", "OpenSearch_2.7", "OpenSearch_2.5", "OpenSearch_2.3", "OpenSearch_1.3", "OpenSearch_1.2", "OpenSearch_1.1", "OpenSearch_1.0", "Elasticsearch_7.10", "Elasticsearch_7.9", "Elasticsearch_7.8", "Elasticsearch_7.7", "Elasticsearch_7.4", "Elasticsearch_7.1", "Elasticsearch_6.8", "Elasticsearch_6.7", "Elasticsearch_6.5", "Elasticsearch_6.4", "Elasticsearch_6.3", "Elasticsearch_6.2", "Elasticsearch_6.0", "Elasticsearch_5.6", "Elasticsearch_5.5", "Elasticsearch_5.3", "Elasticsearch_5.1", "Elasticsearch_2.3", "Elasticsearch_1.5" ] } ``` ## See Also 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/ListVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListVersions) # ListVpcEndpointAccess Retrieves information about each AWS principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/listVpcEndpointAccess?nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListVpcEndpointAccess_RequestSyntax) ** The name of the OpenSearch Service domain to retrieve access information for. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [NextToken](#API_ListVpcEndpointAccess_RequestSyntax) ** If your initial `ListVpcEndpointAccess` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListVpcEndpointAccess` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AuthorizedPrincipalList": [ { "Principal": "string", "PrincipalType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AuthorizedPrincipalList](#API_ListVpcEndpointAccess_ResponseSyntax) ** A list of [IAM principals](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) that can currently access the domain. Type: Array of [AuthorizedPrincipal](API_AuthorizedPrincipal.md) objects ** [NextToken](#API_ListVpcEndpointAccess_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ## Errors 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/ListVpcEndpointAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListVpcEndpointAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListVpcEndpointAccess) # ListVpcEndpoints Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current AWS account and Region. ## Request Syntax ``` GET /2021-01-01/opensearch/vpcEndpoints?nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [NextToken](#API_ListVpcEndpoints_RequestSyntax) ** If your initial `ListVpcEndpoints` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListVpcEndpoints` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "VpcEndpointSummaryList": [ { "DomainArn": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListVpcEndpoints_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [VpcEndpointSummaryList](#API_ListVpcEndpoints_ResponseSyntax) ** Information about each endpoint. Type: Array of [VpcEndpointSummary](API_VpcEndpointSummary.md) objects ## Errors 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 ## See Also 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/ListVpcEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListVpcEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListVpcEndpoints) # ListVpcEndpointsForDomain Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. ## Request Syntax ``` GET /2021-01-01/opensearch/domain/DomainName/vpcEndpoints?nextToken=NextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_ListVpcEndpointsForDomain_RequestSyntax) ** The name of the domain to list associated VPC endpoints for. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [NextToken](#API_ListVpcEndpointsForDomain_RequestSyntax) ** If your initial `ListEndpointsForDomain` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListEndpointsForDomain` operations, which returns results in the next page. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "VpcEndpointSummaryList": [ { "DomainArn": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_ListVpcEndpointsForDomain_ResponseSyntax) ** When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Type: String ** [VpcEndpointSummaryList](#API_ListVpcEndpointsForDomain_ResponseSyntax) ** Information about each endpoint associated with the domain. Type: Array of [VpcEndpointSummary](API_VpcEndpointSummary.md) objects ## Errors 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/ListVpcEndpointsForDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/ListVpcEndpointsForDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/ListVpcEndpointsForDomain) # PurchaseReservedInstanceOffering Allows you to purchase Amazon OpenSearch Service Reserved Instances. ## Request Syntax ``` POST /2021-01-01/opensearch/purchaseReservedInstanceOffering HTTP/1.1 Content-type: application/json { "InstanceCount": number, "ReservationName": "string", "ReservedInstanceOfferingId": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [InstanceCount](#API_PurchaseReservedInstanceOffering_RequestSyntax) ** The number of OpenSearch instances to reserve. Type: Integer Valid Range: Minimum value of 1. Required: No ** [ReservationName](#API_PurchaseReservedInstanceOffering_RequestSyntax) ** A customer-specified identifier to track this reservation. Type: String Length Constraints: Minimum length of 5. Maximum length of 64. Pattern: `.*` Required: Yes ** [ReservedInstanceOfferingId](#API_PurchaseReservedInstanceOffering_RequestSyntax) ** The ID of the Reserved Instance offering to purchase. Type: String Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ReservationName": "string", "ReservedInstanceId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ReservationName](#API_PurchaseReservedInstanceOffering_ResponseSyntax) ** The customer-specified identifier used to track this reservation. Type: String Length Constraints: Minimum length of 5. Maximum length of 64. Pattern: `.*` ** [ReservedInstanceId](#API_PurchaseReservedInstanceOffering_ResponseSyntax) ** The ID of the Reserved Instance offering that was purchased. Type: String Length Constraints: Fixed length of 36. Pattern: `\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. 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 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/PurchaseReservedInstanceOffering) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/PurchaseReservedInstanceOffering) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/PurchaseReservedInstanceOffering) # PutDefaultApplicationSetting Sets the default application to the application with the specified ARN. To remove the default application, use the `GetDefaultApplicationSetting` operation to get the current default and then call the `PutDefaultApplicationSetting` with the current applications ARN and the `setAsDefault` parameter set to `false`. ## Request Syntax ``` PUT /2021-01-01/opensearch/defaultApplicationSetting HTTP/1.1 Content-type: application/json { "applicationArn": "string", "setAsDefault": boolean } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [applicationArn](#API_PutDefaultApplicationSetting_RequestSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` Required: Yes ** [setAsDefault](#API_PutDefaultApplicationSetting_RequestSyntax) ** Set to true to set the specified ARN as the default application. Set to false to clear the default application. Type: Boolean Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationArn](#API_PutDefaultApplicationSetting_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/PutDefaultApplicationSetting) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/PutDefaultApplicationSetting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/PutDefaultApplicationSetting) # RegisterCapability Registers a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The capability configuration defines the type and settings of the capability to register. For more information about the AI features, see [Agentic AI for OpenSearch UI](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application-ai-assistant.html). ## Request Syntax ``` POST /2021-01-01/opensearch/application/ApplicationId/capability/register HTTP/1.1 Content-type: application/json { "capabilityConfig": { ... }, "capabilityName": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [ApplicationId](#API_RegisterCapability_RequestSyntax) ** The unique identifier of the OpenSearch UI application to register the capability for. Pattern: `[a-z0-9]{3,30}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [capabilityConfig](#API_RegisterCapability_RequestSyntax) ** The configuration settings for the capability being registered. This includes capability-specific settings such as AI configuration. Type: [CapabilityBaseRequestConfig](API_CapabilityBaseRequestConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [capabilityName](#API_RegisterCapability_RequestSyntax) ** The name of the capability to register. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens. This identifies the type of capability being enabled for the application. For registering AI Assistant capability, use `ai-capability` Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `^[a-zA-Z0-9-]+$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationId": "string", "capabilityConfig": { ... }, "capabilityName": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationId](#API_RegisterCapability_ResponseSyntax) ** The unique identifier of the OpenSearch UI application. Type: String Pattern: `[a-z0-9]{3,30}` ** [capabilityConfig](#API_RegisterCapability_ResponseSyntax) ** The configuration settings for the registered capability. Type: [CapabilityBaseResponseConfig](API_CapabilityBaseResponseConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [capabilityName](#API_RegisterCapability_ResponseSyntax) ** The name of the registered capability. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `^[a-zA-Z0-9-]+$` ** [status](#API_RegisterCapability_ResponseSyntax) ** The current status of the capability. Possible values: `creating`, `create_failed`, `active`, `updating`, `update_failed`, `deleting`, `delete_failed`. Type: String Valid Values: `creating | create_failed | active | updating | update_failed | deleting | delete_failed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ** ServiceQuotaExceededException ** An exception for when a request would cause a service quota to be exceeded. HTTP Status Code: 402 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/RegisterCapability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/RegisterCapability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/RegisterCapability) # RejectInboundConnection Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request. ## Request Syntax ``` PUT /2021-01-01/opensearch/cc/inboundConnection/ConnectionId/reject HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [ConnectionId](#API_RejectInboundConnection_RequestSyntax) ** The unique identifier of the inbound connection to reject. Length Constraints: Minimum length of 10. Maximum length of 256. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Connection": { "ConnectionId": "string", "ConnectionMode": "string", "ConnectionStatus": { "Message": "string", "StatusCode": "string" }, "LocalDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } }, "RemoteDomainInfo": { "AWSDomainInformation": { "DomainName": "string", "OwnerId": "string", "Region": "string" } } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Connection](#API_RejectInboundConnection_ResponseSyntax) ** Contains details about the rejected inbound connection. Type: [InboundConnection](API_InboundConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DisabledOperationException ** An error occured because the client wanted to access an unsupported operation. HTTP Status Code: 409 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ## See Also 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/RejectInboundConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/RejectInboundConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/RejectInboundConnection) # RemoveTags Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see [ Tagging Amazon OpenSearch Service resources](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging). ## Request Syntax ``` POST /2021-01-01/tags-removal HTTP/1.1 Content-type: application/json { "ARN": "string", "TagKeys": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [ARN](#API_RemoveTags_RequestSyntax) ** The Amazon Resource Name (ARN) of the domain, data source, or application from which you want to delete the specified tags. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` Required: Yes ** [TagKeys](#API_RemoveTags_RequestSyntax) ** The list of tag keys to remove from the domain, data source, or application. Type: Array of strings Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of RemoveTags. #### Sample Request ``` POST /2021-01-01/tags-removal HTTP/1.1 Host: es.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.remove-tags X-Amz-Date: 20240212T221612Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-security-token, Signature=8fe55108204bb96b157bd4a5ca747c54264cb3c9c01a8137b1daffdf2eabb654 Content-Length: 100 {"ARN": "arn:aws:es:us-east-1:123456789012:domain/marketing", "TagKeys": ["department", "marketing"]} ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: ab0cd0ef-123g-4h5j-678k-l6m534no08p7 Content-Type: application/json Content-Length: 0 Date: Mon, 12 Feb 2024 22:16:12 GMT Connection: keep-alive ``` ## See Also 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/RemoveTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/RemoveTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/RemoveTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/RemoveTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/RemoveTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/RemoveTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/RemoveTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/RemoveTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/RemoveTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/RemoveTags) # RevokeVpcEndpointAccess Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/revokeVpcEndpointAccess HTTP/1.1 Content-type: application/json { "Account": "string", "Service": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_RevokeVpcEndpointAccess_RequestSyntax) ** The name of the OpenSearch Service domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Account](#API_RevokeVpcEndpointAccess_RequestSyntax) ** The account ID to revoke access from. Type: String Pattern: `^[0-9]+$` Required: No ** [Service](#API_RevokeVpcEndpointAccess_RequestSyntax) ** The service SP to revoke access from. Type: String Valid Values: `application.opensearchservice.amazonaws.com` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors 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 ** 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 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/RevokeVpcEndpointAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/RevokeVpcEndpointAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/RevokeVpcEndpointAccess) # StartDomainMaintenance Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart. ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/domainMaintenance HTTP/1.1 Content-type: application/json { "Action": "string", "NodeId": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_StartDomainMaintenance_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [Action](#API_StartDomainMaintenance_RequestSyntax) ** The name of the action. Type: String Valid Values: `REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD` Required: Yes ** [NodeId](#API_StartDomainMaintenance_RequestSyntax) ** The ID of the data node. Type: String Length Constraints: Minimum length of 10. Maximum length of 40. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "MaintenanceId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [MaintenanceId](#API_StartDomainMaintenance_ResponseSyntax) ** The request ID of requested action. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: `^([\s\S]*)$` ## Errors 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 ** 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 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/StartDomainMaintenance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/StartDomainMaintenance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/StartDomainMaintenance) # StartServiceSoftwareUpdate Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see [Service software updates in Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html). ## Request Syntax ``` POST /2021-01-01/opensearch/serviceSoftwareUpdate/start HTTP/1.1 Content-type: application/json { "DesiredStartTime": number, "DomainName": "string", "ScheduleAt": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [DesiredStartTime](#API_StartServiceSoftwareUpdate_RequestSyntax) ** The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set `ScheduleAt` to `TIMESTAMP`. Type: Long Required: No ** [DomainName](#API_StartServiceSoftwareUpdate_RequestSyntax) ** The name of the domain that you want to update to the latest service software. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [ScheduleAt](#API_StartServiceSoftwareUpdate_RequestSyntax) ** When to start the service software update. + `NOW` - Immediately schedules the update to happen in the current hour if there's capacity available. + `TIMESTAMP` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for `DesiredStartTime`. + `OFF_PEAK_WINDOW` - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days. Default: `NOW` if you don't specify a value for `DesiredStartTime`, and `TIMESTAMP` if you do. Type: String Valid Values: `NOW | TIMESTAMP | OFF_PEAK_WINDOW` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ServiceSoftwareOptions](#API_StartServiceSoftwareUpdate_ResponseSyntax) ** The current status of the OpenSearch Service software update. Type: [ServiceSoftwareOptions](API_ServiceSoftwareOptions.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** 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 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/StartServiceSoftwareUpdate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/StartServiceSoftwareUpdate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/StartServiceSoftwareUpdate) # UpdateApplication Updates the configuration and settings of an existing OpenSearch application. ## Request Syntax ``` PUT /2021-01-01/opensearch/application/id HTTP/1.1 Content-type: application/json { "appConfigs": [ { "key": "string", "value": "string" } ], "dataSources": [ { "dataSourceArn": "string", "dataSourceDescription": "string", "iamRoleForDataSourceArn": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [id](#API_UpdateApplication_RequestSyntax) ** The unique identifier for the OpenSearch application to be updated. Pattern: `[a-z0-9]{3,30}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [appConfigs](#API_UpdateApplication_RequestSyntax) ** The configuration settings to modify for the OpenSearch application. Type: Array of [AppConfig](API_AppConfig.md) objects Array Members: Maximum number of 200 items. Required: No ** [dataSources](#API_UpdateApplication_RequestSyntax) ** The data sources to associate with the OpenSearch application. Type: Array of [DataSource](API_DataSource.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "appConfigs": [ { "key": "string", "value": "string" } ], "arn": "string", "createdAt": number, "dataSources": [ { "dataSourceArn": "string", "dataSourceDescription": "string", "iamRoleForDataSourceArn": "string" } ], "iamIdentityCenterOptions": { "enabled": boolean, "iamIdentityCenterApplicationArn": "string", "iamIdentityCenterInstanceArn": "string", "iamRoleForIdentityCenterApplicationArn": "string" }, "id": "string", "lastUpdatedAt": number, "name": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [appConfigs](#API_UpdateApplication_ResponseSyntax) ** The configuration settings for the updated OpenSearch application. Type: Array of [AppConfig](API_AppConfig.md) objects Array Members: Maximum number of 200 items. ** [arn](#API_UpdateApplication_ResponseSyntax) ** The Amazon Resource Name (ARN) of the domain. See [Identifiers for IAM Entities ](https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in *Using AWS Identity and Access Management* for more information. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: `.*` ** [createdAt](#API_UpdateApplication_ResponseSyntax) ** The timestamp when the OpenSearch application was originally created. Type: Timestamp ** [dataSources](#API_UpdateApplication_ResponseSyntax) ** The data sources associated with the updated OpenSearch application. Type: Array of [DataSource](API_DataSource.md) objects ** [iamIdentityCenterOptions](#API_UpdateApplication_ResponseSyntax) ** The IAM Identity Center configuration for the updated OpenSearch application. Type: [IamIdentityCenterOptions](API_IamIdentityCenterOptions.md) object ** [id](#API_UpdateApplication_ResponseSyntax) ** The unique identifier of the updated OpenSearch application. Type: String Pattern: `[a-z0-9]{3,30}` ** [lastUpdatedAt](#API_UpdateApplication_ResponseSyntax) ** The timestamp when the OpenSearch application was last updated. Type: Timestamp ** [name](#API_UpdateApplication_ResponseSyntax) ** The name of the updated OpenSearch application. Type: String Length Constraints: Minimum length of 3. Maximum length of 30. Pattern: `[a-z][a-z0-9\-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/UpdateApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateApplication) # UpdateDataSource Updates a direct-query data source. For more information, see [Working with Amazon OpenSearch Service data source integrations with Amazon S3](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html). ## Request Syntax ``` PUT /2021-01-01/opensearch/domain/DomainName/dataSource/DataSourceName HTTP/1.1 Content-type: application/json { "DataSourceType": { ... }, "Description": "string", "Status": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_UpdateDataSource_RequestSyntax) ** The name of the domain. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [DataSourceName](#API_UpdateDataSource_RequestSyntax) ** The name of the data source to modify. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataSourceType](#API_UpdateDataSource_RequestSyntax) ** The type of data source. Type: [DataSourceType](API_DataSourceType.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [Description](#API_UpdateDataSource_RequestSyntax) ** A new description of the data source. Type: String Length Constraints: Maximum length of 1000. Pattern: `^([a-zA-Z0-9_])*[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$` Required: No ** [Status](#API_UpdateDataSource_RequestSyntax) ** The status of the data source update. Type: String Valid Values: `ACTIVE | DISABLED` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_UpdateDataSource_ResponseSyntax) ** A message associated with the updated data source. Type: String ## Errors 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 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** 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 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/UpdateDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateDataSource) # UpdateDirectQueryDataSource Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service. ## Request Syntax ``` PUT /2021-01-01/opensearch/directQueryDataSource/DataSourceName HTTP/1.1 Content-type: application/json { "DataSourceAccessPolicy": "string", "DataSourceType": { ... }, "Description": "string", "OpenSearchArns": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DataSourceName](#API_UpdateDirectQueryDataSource_RequestSyntax) ** A unique, user-defined label to identify the data source within your OpenSearch Service environment. Length Constraints: Minimum length of 3. Maximum length of 80. Pattern: `[a-z][a-z0-9_]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [DataSourceAccessPolicy](#API_UpdateDirectQueryDataSource_RequestSyntax) ** An optional IAM access policy document that defines the updated permissions for accessing the direct query data source. The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged. Type: String Length Constraints: Minimum length of 0. Maximum length of 102400. Pattern: `.*` Required: No ** [DataSourceType](#API_UpdateDirectQueryDataSource_RequestSyntax) ** 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_UpdateDirectQueryDataSource_RequestSyntax) ** 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_UpdateDirectQueryDataSource_RequestSyntax) ** 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 ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DataSourceArn": "string" } ``` ## Response Elements 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_UpdateDirectQueryDataSource_ResponseSyntax) ** The unique, system-generated identifier that represents the data source. Type: String ## Errors 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 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/UpdateDirectQueryDataSource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateDirectQueryDataSource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateDirectQueryDataSource) # UpdateDomainConfig Modifies the cluster configuration of the specified Amazon OpenSearch Service domain. ## Request Syntax ``` POST /2021-01-01/opensearch/domain/DomainName/config HTTP/1.1 Content-type: application/json { "AccessPolicies": "string", "AdvancedOptions": { "string" : "string" }, "AdvancedSecurityOptions": { "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "MasterUserOptions": { "MasterUserARN": "string", "MasterUserName": "string", "MasterUserPassword": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "MasterBackendRole": "string", "MasterUserName": "string", "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "AIMLOptions": { "NaturalLanguageQueryGenerationOptions": { "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "AutoTuneOptions": { "DesiredState": "string", "MaintenanceSchedules": [ { "CronExpressionForRecurrence": "string", "Duration": { "Unit": "string", "Value": number }, "StartAt": number } ], "RollbackOnDisable": "string", "UseOffPeakWindow": boolean }, "ClusterConfig": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "CognitoOptions": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "DeploymentStrategyOptions": { "DeploymentStrategy": "string" }, "DomainEndpointOptions": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "DryRun": boolean, "DryRunMode": "string", "EBSOptions": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "EncryptionAtRestOptions": { "Enabled": boolean, "KmsKeyId": "string" }, "IdentityCenterOptions": { "EnabledAPIAccess": boolean, "IdentityCenterInstanceARN": "string", "RolesKey": "string", "SubjectKey": "string" }, "IPAddressType": "string", "LogPublishingOptions": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "NodeToNodeEncryptionOptions": { "Enabled": boolean }, "OffPeakWindowOptions": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "SnapshotOptions": { "AutomatedSnapshotStartHour": number }, "SoftwareUpdateOptions": { "AutoSoftwareUpdateEnabled": boolean }, "VPCOptions": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_UpdateDomainConfig_RequestSyntax) ** The name of the domain that you're updating. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [AccessPolicies](#API_UpdateDomainConfig_RequestSyntax) ** Identity and Access Management (IAM) access policy as a JSON-formatted string. Type: String Length Constraints: Minimum length of 0. Maximum length of 102400. Pattern: `.*` Required: No ** [AdvancedOptions](#API_UpdateDomainConfig_RequestSyntax) ** Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: + `"rest.action.multi.allow_explicit_index": "true" | "false"` - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. + `"indices.fielddata.cache.size": "80" ` - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. + `"indices.query.bool.max_clause_count": "1024"` - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a `TooManyClauses` error. For more information, see [Advanced cluster parameters](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options). Type: String to string map Required: No ** [AdvancedSecurityOptions](#API_UpdateDomainConfig_RequestSyntax) ** Options for fine-grained access control. Type: [AdvancedSecurityOptionsInput](API_AdvancedSecurityOptionsInput.md) object Required: No ** [AIMLOptions](#API_UpdateDomainConfig_RequestSyntax) ** Options for all machine learning features for the specified domain. Type: [AIMLOptionsInput](API_AIMLOptionsInput.md) object Required: No ** [AutoTuneOptions](#API_UpdateDomainConfig_RequestSyntax) ** Options for Auto-Tune. Type: [AutoTuneOptions](API_AutoTuneOptions.md) object Required: No ** [ClusterConfig](#API_UpdateDomainConfig_RequestSyntax) ** Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances. Type: [ClusterConfig](API_ClusterConfig.md) object Required: No ** [CognitoOptions](#API_UpdateDomainConfig_RequestSyntax) ** Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. Type: [CognitoOptions](API_CognitoOptions.md) object Required: No ** [DeploymentStrategyOptions](#API_UpdateDomainConfig_RequestSyntax) ** Specifies the deployment strategy options for the domain. Type: [DeploymentStrategyOptions](API_DeploymentStrategyOptions.md) object Required: No ** [DomainEndpointOptions](#API_UpdateDomainConfig_RequestSyntax) ** Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. Type: [DomainEndpointOptions](API_DomainEndpointOptions.md) object Required: No ** [DryRun](#API_UpdateDomainConfig_RequestSyntax) ** This flag, when set to True, specifies whether the `UpdateDomain` request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause. Type: Boolean Required: No ** [DryRunMode](#API_UpdateDomainConfig_RequestSyntax) ** The type of dry run to perform. + `Basic` only returns the type of deployment (blue/green or dynamic) that the update will cause. + `Verbose` runs an additional check to validate the changes you're making. For more information, see [Validating a domain update](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check). Type: String Valid Values: `Basic | Verbose` Required: No ** [EBSOptions](#API_UpdateDomainConfig_RequestSyntax) ** The type and size of the EBS volume to attach to instances in the domain. Type: [EBSOptions](API_EBSOptions.md) object Required: No ** [EncryptionAtRestOptions](#API_UpdateDomainConfig_RequestSyntax) ** Encryption at rest options for the domain. Type: [EncryptionAtRestOptions](API_EncryptionAtRestOptions.md) object Required: No ** [IdentityCenterOptions](#API_UpdateDomainConfig_RequestSyntax) ** Configuration settings for enabling and managing IAM Identity Center. Type: [IdentityCenterOptionsInput](API_IdentityCenterOptionsInput.md) object Required: No ** [IPAddressType](#API_UpdateDomainConfig_RequestSyntax) ** Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it. Type: String Valid Values: `ipv4 | dualstack` Required: No ** [LogPublishingOptions](#API_UpdateDomainConfig_RequestSyntax) ** Options to publish OpenSearch logs to Amazon CloudWatch Logs. Type: String to [LogPublishingOption](API_LogPublishingOption.md) object map Valid Keys: `INDEX_SLOW_LOGS | SEARCH_SLOW_LOGS | ES_APPLICATION_LOGS | AUDIT_LOGS` Required: No ** [NodeToNodeEncryptionOptions](#API_UpdateDomainConfig_RequestSyntax) ** Node-to-node encryption options for the domain. Type: [NodeToNodeEncryptionOptions](API_NodeToNodeEncryptionOptions.md) object Required: No ** [OffPeakWindowOptions](#API_UpdateDomainConfig_RequestSyntax) ** Off-peak window options for the domain. Type: [OffPeakWindowOptions](API_OffPeakWindowOptions.md) object Required: No ** [SnapshotOptions](#API_UpdateDomainConfig_RequestSyntax) ** Option to set the time, in UTC format, for the daily automated snapshot. Default value is `0` hours. Type: [SnapshotOptions](API_SnapshotOptions.md) object Required: No ** [SoftwareUpdateOptions](#API_UpdateDomainConfig_RequestSyntax) ** Service software update options for the domain. Type: [SoftwareUpdateOptions](API_SoftwareUpdateOptions.md) object Required: No ** [VPCOptions](#API_UpdateDomainConfig_RequestSyntax) ** Options to specify the subnets and security groups for a VPC endpoint. For more information, see [Launching your Amazon OpenSearch Service domains using a VPC](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html). Type: [VPCOptions](API_VPCOptions.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "DomainConfig": { "AccessPolicies": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AdvancedOptions": { "Options": { "string" : "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AdvancedSecurityOptions": { "Options": { "AnonymousAuthDisableDate": number, "AnonymousAuthEnabled": boolean, "Enabled": boolean, "IAMFederationOptions": { "Enabled": boolean, "RolesKey": "string", "SubjectKey": "string" }, "InternalUserDatabaseEnabled": boolean, "JWTOptions": { "Enabled": boolean, "PublicKey": "string", "RolesKey": "string", "SubjectKey": "string" }, "SAMLOptions": { "Enabled": boolean, "Idp": { "EntityId": "string", "MetadataContent": "string" }, "RolesKey": "string", "SessionTimeoutMinutes": number, "SubjectKey": "string" } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AIMLOptions": { "Options": { "NaturalLanguageQueryGenerationOptions": { "CurrentState": "string", "DesiredState": "string" }, "S3VectorsEngine": { "Enabled": boolean }, "ServerlessVectorAcceleration": { "Enabled": boolean } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "AutoTuneOptions": { "Options": { "DesiredState": "string", "MaintenanceSchedules": [ { "CronExpressionForRecurrence": "string", "Duration": { "Unit": "string", "Value": number }, "StartAt": number } ], "RollbackOnDisable": "string", "UseOffPeakWindow": boolean }, "Status": { "CreationDate": number, "ErrorMessage": "string", "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "ClusterConfig": { "Options": { "ColdStorageOptions": { "Enabled": boolean }, "DedicatedMasterCount": number, "DedicatedMasterEnabled": boolean, "DedicatedMasterType": "string", "InstanceCount": number, "InstanceType": "string", "MultiAZWithStandbyEnabled": boolean, "NodeOptions": [ { "NodeConfig": { "Count": number, "Enabled": boolean, "Type": "string" }, "NodeType": "string" } ], "WarmCount": number, "WarmEnabled": boolean, "WarmType": "string", "ZoneAwarenessConfig": { "AvailabilityZoneCount": number }, "ZoneAwarenessEnabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "CognitoOptions": { "Options": { "Enabled": boolean, "IdentityPoolId": "string", "RoleArn": "string", "UserPoolId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "DeploymentStrategyOptions": { "Options": { "DeploymentStrategy": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "DomainEndpointOptions": { "Options": { "CustomEndpoint": "string", "CustomEndpointCertificateArn": "string", "CustomEndpointEnabled": boolean, "EnforceHTTPS": boolean, "TLSSecurityPolicy": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EBSOptions": { "Options": { "EBSEnabled": boolean, "Iops": number, "Throughput": number, "VolumeSize": number, "VolumeType": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EncryptionAtRestOptions": { "Options": { "Enabled": boolean, "KmsKeyId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "EngineVersion": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "IdentityCenterOptions": { "Options": { "EnabledAPIAccess": boolean, "IdentityCenterApplicationARN": "string", "IdentityCenterInstanceARN": "string", "IdentityStoreId": "string", "RolesKey": "string", "SubjectKey": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "IPAddressType": { "Options": "string", "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "LogPublishingOptions": { "Options": { "string" : { "CloudWatchLogsLogGroupArn": "string", "Enabled": boolean } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "ModifyingProperties": [ { "ActiveValue": "string", "Name": "string", "PendingValue": "string", "ValueType": "string" } ], "NodeToNodeEncryptionOptions": { "Options": { "Enabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "OffPeakWindowOptions": { "Options": { "Enabled": boolean, "OffPeakWindow": { "WindowStartTime": { "Hours": number, "Minutes": number } } }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "SnapshotOptions": { "Options": { "AutomatedSnapshotStartHour": number }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "SoftwareUpdateOptions": { "Options": { "AutoSoftwareUpdateEnabled": boolean }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } }, "VPCOptions": { "Options": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" }, "Status": { "CreationDate": number, "PendingDeletion": boolean, "State": "string", "UpdateDate": number, "UpdateVersion": number } } }, "DryRunProgressStatus": { "CreationDate": "string", "DryRunId": "string", "DryRunStatus": "string", "UpdateDate": "string", "ValidationFailures": [ { "Code": "string", "Message": "string" } ] }, "DryRunResults": { "DeploymentType": "string", "Message": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DomainConfig](#API_UpdateDomainConfig_ResponseSyntax) ** The status of the updated domain. Type: [DomainConfig](API_DomainConfig.md) object ** [DryRunProgressStatus](#API_UpdateDomainConfig_ResponseSyntax) ** The status of the dry run being performed on the domain, if any. Type: [DryRunProgressStatus](API_DryRunProgressStatus.md) object ** [DryRunResults](#API_UpdateDomainConfig_ResponseSyntax) ** Results of the dry run performed in the update domain request. Type: [DryRunResults](API_DryRunResults.md) object ## Errors 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 ** InternalException ** Request processing failed because of an unknown error, exception, or internal failure. HTTP Status Code: 500 ** InvalidTypeException ** An exception for trying to create or access a sub-resource that's either invalid or not supported. HTTP Status Code: 409 ** 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 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/UpdateDomainConfig) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateDomainConfig) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateDomainConfig) # UpdateIndex Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents. ## Request Syntax ``` PUT /2021-01-01/opensearch/domain/DomainName/index/IndexName HTTP/1.1 Content-type: application/json { "IndexSchema": JSON value } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_UpdateIndex_RequestSyntax) ** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an AWS Region. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [IndexName](#API_UpdateIndex_RequestSyntax) ** The name of the index to update. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^(?!\.\.?$)[^_ ,:"+/*\\|?#> The updated JSON schema for the index including any changes to mappings, settings, and semantic enrichment configuration. Type: JSON value Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Status](#API_UpdateIndex_ResponseSyntax) ** The status of the index update operation. Type: String Valid Values: `CREATED | UPDATED | DELETED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** DependencyFailureException ** An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource. HTTP Status Code: 424 ** 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 ** ResourceNotFoundException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 409 ** ThrottlingException ** The request was denied due to request throttling. Reduce the frequency of your requests and try again. HTTP Status Code: 429 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/UpdateIndex) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateIndex) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateIndex) # UpdatePackage Updates a package for use with Amazon OpenSearch Service domains. For more information, see [Custom packages for Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html). ## Request Syntax ``` POST /2021-01-01/packages/update HTTP/1.1 Content-type: application/json { "CommitMessage": "string", "PackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageID": "string", "PackageSource": { "S3BucketName": "string", "S3Key": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [CommitMessage](#API_UpdatePackage_RequestSyntax) ** Commit message for the updated file, which is shown as part of `GetPackageVersionHistoryResponse`. Type: String Length Constraints: Maximum length of 160. Required: No ** [PackageConfiguration](#API_UpdatePackage_RequestSyntax) ** The updated configuration details for a package. Type: [PackageConfiguration](API_PackageConfiguration.md) object Required: No ** [PackageDescription](#API_UpdatePackage_RequestSyntax) ** A new description of the package. Type: String Length Constraints: Maximum length of 1024. Required: No ** [PackageEncryptionOptions](#API_UpdatePackage_RequestSyntax) ** Encryption options for a package. Type: [PackageEncryptionOptions](API_PackageEncryptionOptions.md) object Required: No ** [PackageID](#API_UpdatePackage_RequestSyntax) ** The unique identifier for the package. Type: String Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ** [PackageSource](#API_UpdatePackage_RequestSyntax) ** Amazon S3 bucket and key for the package. Type: [PackageSource](API_PackageSource.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "PackageDetails": { "AllowListedUserList": [ "string" ], "AvailablePackageConfiguration": { "ConfigurationRequirement": "string", "LicenseFilepath": "string", "LicenseRequirement": "string", "RequiresRestartForConfigurationUpdate": boolean }, "AvailablePackageVersion": "string", "AvailablePluginProperties": { "ClassName": "string", "Description": "string", "Name": "string", "UncompressedSizeInBytes": number, "Version": "string" }, "CreatedAt": number, "EngineVersion": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdatedAt": number, "PackageDescription": "string", "PackageEncryptionOptions": { "EncryptionEnabled": boolean, "KmsKeyIdentifier": "string" }, "PackageID": "string", "PackageName": "string", "PackageOwner": "string", "PackageStatus": "string", "PackageType": "string", "PackageVendingOptions": { "VendingEnabled": boolean } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [PackageDetails](#API_UpdatePackage_ResponseSyntax) ** Information about a package. Type: [PackageDetails](API_PackageDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** An error occurred because you don't have permissions to access the resource. HTTP Status Code: 403 ** BaseException ** An error occurred while processing the request. ** message ** A description of the error. HTTP Status Code: 400 ** 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 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/UpdatePackage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdatePackage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdatePackage) # UpdatePackageScope Updates the scope of a package. Scope of the package defines users who can view and associate a package. ## Request Syntax ``` POST /2021-01-01/packages/updateScope HTTP/1.1 Content-type: application/json { "Operation": "string", "PackageID": "string", "PackageUserList": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [Operation](#API_UpdatePackageScope_RequestSyntax) ** The operation to perform on the package scope (e.g., add/remove/override users). Type: String Valid Values: `ADD | OVERRIDE | REMOVE` Required: Yes ** [PackageID](#API_UpdatePackageScope_RequestSyntax) ** ID of the package whose scope is being updated. Type: String Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` Required: Yes ** [PackageUserList](#API_UpdatePackageScope_RequestSyntax) ** List of users to be added or removed from the package scope. Type: Array of strings Length Constraints: Minimum length of 6. Maximum length of 12. Pattern: `^[0-9]{12}$|^GLOBAL$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "Operation": "string", "PackageID": "string", "PackageUserList": [ "string" ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Operation](#API_UpdatePackageScope_ResponseSyntax) ** The operation that was performed on the package scope. Type: String Valid Values: `ADD | OVERRIDE | REMOVE` ** [PackageID](#API_UpdatePackageScope_ResponseSyntax) ** ID of the package whose scope was updated. Type: String Pattern: `^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$` ** [PackageUserList](#API_UpdatePackageScope_ResponseSyntax) ** List of users who have access to the package after the scope update. Type: Array of strings Length Constraints: Minimum length of 6. Maximum length of 12. Pattern: `^[0-9]{12}$|^GLOBAL$` ## Errors 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 ** 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 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/UpdatePackageScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdatePackageScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdatePackageScope) # UpdateScheduledAction Reschedules a planned domain configuration change for a later time. This change can be a scheduled [service software update](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html) or a [blue/green Auto-Tune enhancement](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types). ## Request Syntax ``` PUT /2021-01-01/opensearch/domain/DomainName/scheduledAction/update HTTP/1.1 Content-type: application/json { "ActionID": "string", "ActionType": "string", "DesiredStartTime": number, "ScheduleAt": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DomainName](#API_UpdateScheduledAction_RequestSyntax) ** The name of the domain to reschedule an action for. Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [ActionID](#API_UpdateScheduledAction_RequestSyntax) ** The unique identifier of the action to reschedule. To retrieve this ID, send a [ListScheduledActions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) request. Type: String Required: Yes ** [ActionType](#API_UpdateScheduledAction_RequestSyntax) ** The type of action to reschedule. Can be one of `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a [ListScheduledActions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) request. Type: String Valid Values: `SERVICE_SOFTWARE_UPDATE | JVM_HEAP_SIZE_TUNING | JVM_YOUNG_GEN_TUNING` Required: Yes ** [DesiredStartTime](#API_UpdateScheduledAction_RequestSyntax) ** The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set `ScheduleAt` to `TIMESTAMP`. Type: Long Required: No ** [ScheduleAt](#API_UpdateScheduledAction_RequestSyntax) ** When to schedule the action. + `NOW` - Immediately schedules the update to happen in the current hour if there's capacity available. + `TIMESTAMP` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for `DesiredStartTime`. + `OFF_PEAK_WINDOW` - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days. Type: String Valid Values: `NOW | TIMESTAMP | OFF_PEAK_WINDOW` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "ScheduledAction": { "Cancellable": boolean, "Description": "string", "Id": "string", "Mandatory": boolean, "ScheduledBy": "string", "ScheduledTime": number, "Severity": "string", "Status": "string", "Type": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ScheduledAction](#API_UpdateScheduledAction_ResponseSyntax) ** Information about the rescheduled action. Type: [ScheduledAction](API_ScheduledAction.md) object ## Errors 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 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. 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 ** SlotNotAvailableException ** An exception for attempting to schedule a domain action during an unavailable time slot. ** SlotSuggestions ** Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action. HTTP Status Code: 409 ** ValidationException ** An exception for accessing or deleting a resource that doesn't exist. HTTP Status Code: 400 ## See Also 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/UpdateScheduledAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateScheduledAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateScheduledAction) # UpdateVpcEndpoint Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. ## Request Syntax ``` POST /2021-01-01/opensearch/vpcEndpoints/update HTTP/1.1 Content-type: application/json { "VpcEndpointId": "string", "VpcOptions": { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [VpcEndpointId](#API_UpdateVpcEndpoint_RequestSyntax) ** The unique identifier of the endpoint. Type: String Length Constraints: Minimum length of 5. Maximum length of 256. Pattern: `^aos-[a-zA-Z0-9]*$` Required: Yes ** [VpcOptions](#API_UpdateVpcEndpoint_RequestSyntax) ** The security groups and/or subnets to add, remove, or modify. Type: [VPCOptions](API_VPCOptions.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "VpcEndpoint": { "DomainArn": "string", "Endpoint": "string", "Status": "string", "VpcEndpointId": "string", "VpcEndpointOwner": "string", "VpcOptions": { "AvailabilityZones": [ "string" ], "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VPCId": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [VpcEndpoint](#API_UpdateVpcEndpoint_ResponseSyntax) ** The endpoint to be updated. Type: [VpcEndpoint](API_VpcEndpoint.md) object ## Errors 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 ** ConflictException ** An error occurred because the client attempts to remove a resource that is currently in use. HTTP Status Code: 409 ** 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 ** 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 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/UpdateVpcEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpdateVpcEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpdateVpcEndpoint) # UpgradeDomain Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch. ## Request Syntax ``` POST /2021-01-01/opensearch/upgradeDomain HTTP/1.1 Content-type: application/json { "AdvancedOptions": { "string" : "string" }, "DomainName": "string", "PerformCheckOnly": boolean, "TargetVersion": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [AdvancedOptions](#API_UpgradeDomain_RequestSyntax) ** Only supports the `override_main_response_version` parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins. Type: String to string map Required: No ** [DomainName](#API_UpgradeDomain_RequestSyntax) ** Name of the OpenSearch Service domain that you want to upgrade. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` Required: Yes ** [PerformCheckOnly](#API_UpgradeDomain_RequestSyntax) ** When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. Type: Boolean Required: No ** [TargetVersion](#API_UpgradeDomain_RequestSyntax) ** OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch\$1X.Y or Elasticsearch\$1X.Y. Type: String Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "AdvancedOptions": { "string" : "string" }, "ChangeProgressDetails": { "ChangeId": "string", "ConfigChangeStatus": "string", "InitiatedBy": "string", "LastUpdatedTime": number, "Message": "string", "StartTime": number }, "DomainName": "string", "PerformCheckOnly": boolean, "TargetVersion": "string", "UpgradeId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AdvancedOptions](#API_UpgradeDomain_ResponseSyntax) ** The advanced options configuration for the domain. Type: String to string map ** [ChangeProgressDetails](#API_UpgradeDomain_ResponseSyntax) ** Container for information about a configuration change happening on a domain. Type: [ChangeProgressDetails](API_ChangeProgressDetails.md) object ** [DomainName](#API_UpgradeDomain_ResponseSyntax) ** The name of the domain that was upgraded. Type: String Length Constraints: Minimum length of 3. Maximum length of 28. Pattern: `[a-z][a-z0-9\-]+` ** [PerformCheckOnly](#API_UpgradeDomain_ResponseSyntax) ** When true, indicates that an upgrade eligibility check was performed. Type: Boolean ** [TargetVersion](#API_UpgradeDomain_ResponseSyntax) ** OpenSearch or Elasticsearch version that the domain was upgraded to. Type: String Length Constraints: Minimum length of 14. Maximum length of 18. Pattern: `^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$` ** [UpgradeId](#API_UpgradeDomain_ResponseSyntax) ** The unique identifier of the domain upgrade. Type: String ## Errors 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 ** ResourceAlreadyExistsException ** An exception for creating a resource that already exists. 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 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/UpgradeDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/opensearch-2021-01-01/UpgradeDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/opensearch-2021-01-01/UpgradeDomain)