AWS CLI Command Reference

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

Description

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service .

See also: AWS API Documentation

Synopsis

  create-package
--package-name <value>
--package-type <value>
[--package-description <value>]
--package-source <value>
[--package-configuration <value>]
[--engine-version <value>]
[--package-vending-options <value>]
[--package-encryption-options <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--package-name (string)

Unique name for the package.

--package-type (string)

The type of package.

Possible values:

  • TXT-DICTIONARY
  • ZIP-PLUGIN
  • PACKAGE-LICENSE
  • PACKAGE-CONFIG

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

S3BucketName=string,S3Key=string

JSON Syntax:

{
  "S3BucketName": "string",
  "S3Key": "string"
}

--package-configuration (structure)

The configuration parameters for the package being created.

LicenseRequirement -> (string)

The license requirements for the package.

LicenseFilepath -> (string)

The relative file path for the license associated with the package.

ConfigurationRequirement -> (string)

The configuration requirements for the package.

RequiresRestartForConfigurationUpdate -> (boolean)

This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

Shorthand Syntax:

LicenseRequirement=string,LicenseFilepath=string,ConfigurationRequirement=string,RequiresRestartForConfigurationUpdate=boolean

JSON Syntax:

{
  "LicenseRequirement": "REQUIRED"|"OPTIONAL"|"NONE",
  "LicenseFilepath": "string",
  "ConfigurationRequirement": "REQUIRED"|"OPTIONAL"|"NONE",
  "RequiresRestartForConfigurationUpdate": true|false
}

--engine-version (string)

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

--package-vending-options (structure)

The vending options for the package being created. They determine if the package can be vended to other users.

VendingEnabled -> (boolean)

This indicates whether vending is enabled for the package to determine if package can be used by other users.

Shorthand Syntax:

VendingEnabled=boolean

JSON Syntax:

{
  "VendingEnabled": true|false
}

--package-encryption-options (structure)

The encryption parameters for the package being created.

KmsKeyIdentifier -> (string)

KMS key ID for encrypting the package.

EncryptionEnabled -> (boolean)

This indicates whether encryption is enabled for the package.

Shorthand Syntax:

KmsKeyIdentifier=string,EncryptionEnabled=boolean

JSON Syntax:

{
  "KmsKeyIdentifier": "string",
  "EncryptionEnabled": true|false
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

PackageDetails -> (structure)

Basic information about an OpenSearch Service package.

PackageID -> (string)

The unique identifier of the package.

PackageName -> (string)

The user-specified name of the package.

PackageType -> (string)

The type of package.

PackageDescription -> (string)

User-specified description of the package.

PackageStatus -> (string)

The current status of the package. The available options are AVAILABLE , COPYING , COPY_FAILED , VALIDATNG , VALIDATION_FAILED , DELETING , and DELETE_FAILED .

CreatedAt -> (timestamp)

The timestamp when the package was created.

LastUpdatedAt -> (timestamp)

Date and time when the package was last updated.

AvailablePackageVersion -> (string)

The package version.

ErrorDetails -> (structure)

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

ErrorType -> (string)

The type of error that occurred.

ErrorMessage -> (string)

A message describing the error.

EngineVersion -> (string)

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

AvailablePluginProperties -> (structure)

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Name -> (string)

The name of the plugin.

Description -> (string)

The description of the plugin.

Version -> (string)

The version of the plugin.

ClassName -> (string)

The name of the class to load.

UncompressedSizeInBytes -> (long)

The uncompressed size of the plugin.

AvailablePackageConfiguration -> (structure)

This represents the available configuration parameters for the package.

LicenseRequirement -> (string)

The license requirements for the package.

LicenseFilepath -> (string)

The relative file path for the license associated with the package.

ConfigurationRequirement -> (string)

The configuration requirements for the package.

RequiresRestartForConfigurationUpdate -> (boolean)

This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for.

AllowListedUserList -> (list)

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

(string)

PackageOwner -> (string)

The owner of the package who is allowed to create/update a package and add users to the package scope.

PackageVendingOptions -> (structure)

Package Vending Options for a package.

VendingEnabled -> (boolean)

This indicates whether vending is enabled for the package to determine if package can be used by other users.

PackageEncryptionOptions -> (structure)

Package Encryption Options for a package.

KmsKeyIdentifier -> (string)

KMS key ID for encrypting the package.

EncryptionEnabled -> (boolean)

This indicates whether encryption is enabled for the package.