[ aws . opensearch ]

associate-package

Description

Associates a package with an Amazon OpenSearch Service domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-package
--package-id <value>
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--package-id (string)

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

--domain-name (string)

The name of the domain to associate the package with.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Output

DomainPackageDetails -> (structure)

DomainPackageDetails

PackageID -> (string)

The internal ID of the package.

PackageName -> (string)

User-specified name of the package.

PackageType -> (string)

Currently supports only TXT-DICTIONARY.

LastUpdated -> (timestamp)

The timestamp of the most recent update to the package association status.

DomainName -> (string)

The name of the domain you’ve associated a package with.

DomainPackageStatus -> (string)

State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

PackageVersion -> (string)

ReferencePath -> (string)

The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

ErrorDetails -> (structure)

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

ErrorType -> (string)

ErrorMessage -> (string)