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 ]



Create a package for use with Amazon OpenSearch Service domains.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--package-name <value>
--package-type <value>
[--package-description <value>]
--package-source <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--package-name (string)

Unique identifier for the package.

--package-type (string)

Type of package. Currently supports only TXT-DICTIONARY.

Possible values:


--package-description (string)

Description of the package.

--package-source (structure)

The Amazon S3 location from which to import the package.

S3BucketName -> (string)

The name of the Amazon S3 bucket containing the package.

S3Key -> (string)

Key (file name) of the package.

Shorthand Syntax:


JSON Syntax:

  "S3BucketName": "string",
  "S3Key": "string"

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


PackageDetails -> (structure)

Information about the 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)