/2015-01-01/packages/associate/{PackageID}/{DomainName}

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

POST

Associates a package with an Amazon ES domain.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/packages/associate//'

Response Example

200 - Example 1

{
    "DomainPackageDetails": {
        "PackageID": "string",
        "PackageName": "string",
        "PackageType": "TXT-DICTIONARY",
        "LastUpdated": "string",
        "DomainName": "string",
        "DomainPackageStatus": "ASSOCIATING",
        "PackageVersion": "string",
        "ReferencePath": "string",
        "ErrorDetails": {
            "ErrorType": "string",
            "ErrorMessage": "string"
        }
    }
}

Request

Path Params

PackageID

string

required

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

DomainName

string

required

Name of the domain that you want to associate the package with.

Responses

🟢200Success

application/json

Body

Container for response returned by <code> <a>AssociatePackage</a> </code> operation.

DomainPackageDetails

object

optional

DomainPackageDetails

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.

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483AccessDeniedException

🟠484ValidationException

🟠485ConflictException

Modified at 2023-08-15 04:15:53

/2015-01-01/tags

/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess