AssociatePackage - Amazon OpenSearch Service


Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Request Syntax

POST /2021-01-01/packages/associate/PackageID/DomainName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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


Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

Pattern: ^([FG][0-9]+)$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DomainPackageDetails": { "DomainName": "string", "DomainPackageStatus": "string", "ErrorDetails": { "ErrorMessage": "string", "ErrorType": "string" }, "LastUpdated": number, "PackageID": "string", "PackageName": "string", "PackageType": "string", "PackageVersion": "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.


Information about a package that is associated with a domain.

Type: DomainPackageDetails object


For information about the errors that are common to all actions, see Common Errors.


An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403


An error occurred while processing the request.

HTTP Status Code: 400


An error occurred because the client attempts to remove a resource that is currently in use.

HTTP Status Code: 409


Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409


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: