/2015-01-01/packages/{PackageID}/domains - Amazon Elasticsearch Service

Lists all Amazon ES domains associated with the package.

Request

Path Params

PackageID

string

required

The package for which to list domains.

Query Params

maxResults

integer

optional

Limits results to a maximum number of domains.

nextToken

string

optional

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Responses

🟢200Success

application/json

Body

Container for response parameters to <code> <a>ListDomainsForPackage</a> </code> operation.

DomainPackageDetailsList

array[object (DomainPackageDetails) {9}]

optional

List of DomainPackageDetails objects.

PackageID

string

optional

Internal ID of the package.

PackageName

string

optional

User specified name of the package.

>= 3 characters<= 28 characters

Match pattern:

[a-z][a-z0-9\-]+

PackageType

enum<string>

optional

Currently supports only TXT-DICTIONARY.

Allowed value:

TXT-DICTIONARY

LastUpdated

string <date-time>

optional

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

DomainName

string

optional

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

>= 3 characters<= 28 characters

Match pattern:

[a-z][a-z0-9\-]+

DomainPackageStatus

enum<string>

optional

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

Allowed values:

ASSOCIATINGASSOCIATION_FAILEDACTIVEDISSOCIATINGDISSOCIATION_FAILED

PackageVersion

string

PackageVersion

optional

ReferencePath

string

optional

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

ErrorDetails

object

optional

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

NextToken

string

optional

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483AccessDeniedException

🟠484ValidationException