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

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

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

A list of packages and their prerequisites to be associated with a domain.

Type: Array of PackageDetailsForAssociation 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

List of information about packages that are associated with a domain.

Type: Array of DomainPackageDetails objects

Errors

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

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

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