[ aws . es ]

list-packages-for-domain

Description

Lists all packages associated with the Amazon ES domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-packages-for-domain
--domain-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The name of the domain for which you want to list associated packages.

--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 | --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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

DomainPackageDetailsList -> (list)

List of DomainPackageDetails objects.

(structure)

Information on 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)

Currently supports only TXT-DICTIONARY.

LastUpdated -> (timestamp)

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

DomainName -> (string)

Name of the domain you’ve associated a package with.

DomainPackageStatus -> (string)

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

PackageVersion -> (string)

ReferencePath -> (string)

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

ErrorDetails -> (structure)

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

ErrorType -> (string)

ErrorMessage -> (string)

NextToken -> (string)

Pagination token that needs to be supplied to the next call to get the next page of results.