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 ]

associate-package

Description

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service .

See also: AWS API Documentation

Synopsis

  associate-package
--package-id <value>
--domain-name <value>
[--prerequisite-package-id-list <value>]
[--association-configuration <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-id (string)

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

--domain-name (string)

Name of the domain to associate the package with.

--prerequisite-package-id-list (list)

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

(string)

Syntax:

"string" "string" ...

--association-configuration (structure)

The configuration for associating a package with an Amazon OpenSearch Service domain.

KeyStoreAccessOption -> (structure)

The configuration parameters to enable accessing the key store required by the package.

KeyAccessRoleArn -> (string)

Role ARN to access the KeyStore Key

KeyStoreAccessEnabled -> (boolean)

This indicates whether Key Store access is enabled

Shorthand Syntax:

KeyStoreAccessOption={KeyAccessRoleArn=string,KeyStoreAccessEnabled=boolean}

JSON Syntax:

{
  "KeyStoreAccessOption": {
    "KeyAccessRoleArn": "string",
    "KeyStoreAccessEnabled": 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

DomainPackageDetails -> (structure)

Information about a package that is associated with a domain.

PackageID -> (string)

Internal ID of the package.

PackageName -> (string)

User-specified name of the package.

PackageType -> (string)

The type of package.

LastUpdated -> (timestamp)

Timestamp of the most recent update to the package association status.

DomainName -> (string)

Name of the domain that the package is associated with.

DomainPackageStatus -> (string)

State of the association.

PackageVersion -> (string)

The current version of the package.

PrerequisitePackageIDList -> (list)

A list of package IDs that must be associated with the domain before or with the package can be associated.

(string)

ReferencePath -> (string)

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

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.

AssociationConfiguration -> (structure)

The configuration for associating a package with an Amazon OpenSearch Service domain.

KeyStoreAccessOption -> (structure)

The configuration parameters to enable accessing the key store required by the package.

KeyAccessRoleArn -> (string)

Role ARN to access the KeyStore Key

KeyStoreAccessEnabled -> (boolean)

This indicates whether Key Store access is enabled