DissociatePackages - Amazon OpenSearch Service

DissociatePackages

Dissociates multiple packages from a domain simulatneously.

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

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 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

A list of package details for the packages that were dissociated from the 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: