Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]



Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--filters (list)

Only returns packages that match the DescribePackagesFilterList values.


A filter to apply to the DescribePackage response.

Name -> (string)

Any field from PackageDetails .

Value -> (list)

A list of values for the specified field.


Shorthand Syntax:

Name=string,Value=string,string ...

JSON Syntax:

    "Name": "PackageID"|"PackageName"|"PackageStatus",
    "Value": ["string", ...]

--max-results (integer)

Limits results to a maximum number of packages.

--next-token (string)

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


PackageDetailsList -> (list)

List of PackageDetails objects.


Basic information about a package.

PackageID -> (string)

Internal ID of the package.

PackageName -> (string)

User-specified name of the package.

PackageType -> (string)

Currently supports only TXT-DICTIONARY.

PackageDescription -> (string)

User-specified description of the package.

PackageStatus -> (string)

Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

CreatedAt -> (timestamp)

The timestamp of when the package was created.

LastUpdatedAt -> (timestamp)

AvailablePackageVersion -> (string)

ErrorDetails -> (structure)

Additional information if the package is in an error state. Null otherwise.

ErrorType -> (string)

ErrorMessage -> (string)

NextToken -> (string)