Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociatePackage

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
Content-type: application/json

{
   "AssociationConfiguration": { 
      "KeyStoreAccessOption": { 
         "KeyAccessRoleArn": "string",
         "KeyStoreAccessEnabled": boolean
      }
   },
   "PrerequisitePackageIDList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

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

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

The configuration for associating a package with an Amazon OpenSearch Service domain.

Type: PackageAssociationConfiguration object

Required: No

PrerequisitePackageIDList

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

Information about a package that is associated with a domain.

Type: DomainPackageDetails object

Errors

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

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.

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