Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DissociatePackageCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, DissociatePackageCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, DissociatePackageCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // DissociatePackageRequest
PackageID: "STRING_VALUE", // required
DomainName: "STRING_VALUE", // required
};
const command = new DissociatePackageCommand(input);
const response = await client.send(command);
// { // DissociatePackageResponse
// DomainPackageDetails: { // DomainPackageDetails
// PackageID: "STRING_VALUE",
// PackageName: "STRING_VALUE",
// PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
// LastUpdated: new Date("TIMESTAMP"),
// DomainName: "STRING_VALUE",
// DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
// PackageVersion: "STRING_VALUE",
// ReferencePath: "STRING_VALUE",
// ErrorDetails: { // ErrorDetails
// ErrorType: "STRING_VALUE",
// ErrorMessage: "STRING_VALUE",
// },
// },
// };

Param

DissociatePackageCommandInput

Returns

DissociatePackageCommandOutput

See

Throws

AccessDeniedException (client fault)

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

Throws

BaseException (client fault)

An error occurred while processing the request.

Throws

ConflictException (client fault)

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

Throws

InternalException (server fault)

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

Throws

ResourceNotFoundException (client fault)

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

Throws

ValidationException (client fault)

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

Throws

OpenSearchServiceException

Base exception class for all service exceptions from OpenSearch service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods