AWS SDK for PHP 3.x

Client: Aws\ElasticsearchService\ElasticsearchServiceClient

Service ID: es

Version: 2015-01-01

This page describes the parameters and results for the operations of the Amazon Elasticsearch Service (2015-01-01), and shows how to use the Aws\ElasticsearchService\ElasticsearchServiceClient object to call the described operations. This documentation is specific to the 2015-01-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptInboundCrossClusterSearchConnection ( array $params = [] )
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
AddTags ( array $params = [] )
Attaches tags to an existing Elasticsearch domain.
AssociatePackage ( array $params = [] )
Associates a package with an Amazon ES domain.
CancelElasticsearchServiceSoftwareUpdate ( array $params = [] )
Cancels a scheduled service software update for an Amazon ES domain.
CreateElasticsearchDomain ( array $params = [] )
Creates a new Elasticsearch domain.
CreateOutboundCrossClusterSearchConnection ( array $params = [] )
Creates a new cross-cluster search connection from a source domain to a destination domain.
CreatePackage ( array $params = [] )
Create a package for use with Amazon ES domains.
DeleteElasticsearchDomain ( array $params = [] )
Permanently deletes the specified Elasticsearch domain and all of its data.
DeleteElasticsearchServiceRole ( array $params = [] )
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
DeleteInboundCrossClusterSearchConnection ( array $params = [] )
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundCrossClusterSearchConnection ( array $params = [] )
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
DeletePackage ( array $params = [] )
Delete the package.
DescribeDomainAutoTunes ( array $params = [] )
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
DescribeElasticsearchDomain ( array $params = [] )
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
DescribeElasticsearchDomainConfig ( array $params = [] )
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
DescribeElasticsearchDomains ( array $params = [] )
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
DescribeElasticsearchInstanceTypeLimits ( array $params = [] )
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
DescribeInboundCrossClusterSearchConnections ( array $params = [] )
Lists all the inbound cross-cluster search connections for a destination domain.
DescribeOutboundCrossClusterSearchConnections ( array $params = [] )
Lists all the outbound cross-cluster search connections for a source domain.
DescribePackages ( array $params = [] )
Describes all packages available to Amazon ES.
DescribeReservedElasticsearchInstanceOfferings ( array $params = [] )
Lists available reserved Elasticsearch instance offerings.
DescribeReservedElasticsearchInstances ( array $params = [] )
Returns information about reserved Elasticsearch instances for this account.
DissociatePackage ( array $params = [] )
Dissociates a package from the Amazon ES domain.
GetCompatibleElasticsearchVersions ( array $params = [] )
Returns a list of upgrade compatible Elastisearch versions.
GetPackageVersionHistory ( array $params = [] )
Returns a list of versions of the package, along with their creation time and commit message.
GetUpgradeHistory ( array $params = [] )
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
GetUpgradeStatus ( array $params = [] )
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
ListDomainNames ( array $params = [] )
Returns the name of all Elasticsearch domains owned by the current user's account.
ListDomainsForPackage ( array $params = [] )
Lists all Amazon ES domains associated with the package.
ListElasticsearchInstanceTypes ( array $params = [] )
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
ListElasticsearchVersions ( array $params = [] )
List all supported Elasticsearch versions
ListPackagesForDomain ( array $params = [] )
Lists all packages associated with the Amazon ES domain.
ListTags ( array $params = [] )
Returns all tags for the given Elasticsearch domain.
PurchaseReservedElasticsearchInstanceOffering ( array $params = [] )
Allows you to purchase reserved Elasticsearch instances.
RejectInboundCrossClusterSearchConnection ( array $params = [] )
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
RemoveTags ( array $params = [] )
Removes the specified set of tags from the specified Elasticsearch domain.
StartElasticsearchServiceSoftwareUpdate ( array $params = [] )
Schedules a service software update for an Amazon ES domain.
UpdateElasticsearchDomainConfig ( array $params = [] )
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
UpdatePackage ( array $params = [] )
Updates a package for use with Amazon ES domains.
UpgradeElasticsearchDomain ( array $params = [] )
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeDomainAutoTunes
DescribeInboundCrossClusterSearchConnections
DescribeOutboundCrossClusterSearchConnections
DescribePackages
DescribeReservedElasticsearchInstanceOfferings
DescribeReservedElasticsearchInstances
GetPackageVersionHistory
GetUpgradeHistory
ListDomainsForPackage
ListElasticsearchInstanceTypes
ListElasticsearchVersions
ListPackagesForDomain

Operations

AcceptInboundCrossClusterSearchConnection

$result = $client->acceptInboundCrossClusterSearchConnection([/* ... */]);
$promise = $client->acceptInboundCrossClusterSearchConnectionAsync([/* ... */]);

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Parameter Syntax

$result = $client->acceptInboundCrossClusterSearchConnection([
    'CrossClusterSearchConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CrossClusterSearchConnectionId

Required: Yes
Type: string

The id of the inbound connection that you want to accept.

Result Syntax

[
    'CrossClusterSearchConnection' => [
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'CrossClusterSearchConnectionId' => '<string>',
        'DestinationDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
        'SourceDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]

Result Details

Members

CrossClusterSearchConnection

Type: InboundCrossClusterSearchConnection structure

Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

AddTags

$result = $client->addTags([/* ... */]);
$promise = $client->addTagsAsync([/* ... */]);

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

Parameter Syntax

$result = $client->addTags([
    'ARN' => '<string>', // REQUIRED
    'TagList' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ARN

Required: Yes
Type: string

Specify the ARN for which you want to add the tags.

TagList

Required: Yes
Type: Array of Tag structures

List of Tag that need to be added for the Elasticsearch domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BaseException:
An error occurred while processing the request.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

AssociatePackage

$result = $client->associatePackage([/* ... */]);
$promise = $client->associatePackageAsync([/* ... */]);

Associates a package with an Amazon ES domain.

Parameter Syntax

$result = $client->associatePackage([
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

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

PackageID

Required: Yes
Type: string

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

Result Syntax

[
    'DomainPackageDetails' => [
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY',
        'PackageVersion' => '<string>',
        'ReferencePath' => '<string>',
    ],
]

Result Details

Members

DomainPackageDetails

Type: DomainPackageDetails structure

DomainPackageDetails

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
ConflictException:
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

CancelElasticsearchServiceSoftwareUpdate

$result = $client->cancelElasticsearchServiceSoftwareUpdate([/* ... */]);
$promise = $client->cancelElasticsearchServiceSoftwareUpdateAsync([/* ... */]);

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

Parameter Syntax

$result = $client->cancelElasticsearchServiceSoftwareUpdate([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain that you want to stop the latest service software update on.

Result Syntax

[
    'ServiceSoftwareOptions' => [
        'AutomatedUpdateDate' => <DateTime>,
        'Cancellable' => true || false,
        'CurrentVersion' => '<string>',
        'Description' => '<string>',
        'NewVersion' => '<string>',
        'OptionalDeployment' => true || false,
        'UpdateAvailable' => true || false,
        'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
    ],
]

Result Details

Members

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

The current status of the Elasticsearch service software update.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

CreateElasticsearchDomain

$result = $client->createElasticsearchDomain([/* ... */]);
$promise = $client->createElasticsearchDomainAsync([/* ... */]);

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Parameter Syntax

$result = $client->createElasticsearchDomain([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
    ],
    'CognitoOptions' => [
        'Enabled' => true || false,
        'IdentityPoolId' => '<string>',
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
    'DomainEndpointOptions' => [
        'CustomEndpoint' => '<string>',
        'CustomEndpointCertificateArn' => '<string>',
        'CustomEndpointEnabled' => true || false,
        'EnforceHTTPS' => true || false,
        'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
    ],
    'DomainName' => '<string>', // REQUIRED
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1',
    ],
    'ElasticsearchClusterConfig' => [
        'ColdStorageOptions' => [
            'Enabled' => true || false, // REQUIRED
        ],
        'DedicatedMasterCount' => <integer>,
        'DedicatedMasterEnabled' => true || false,
        'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
        'InstanceCount' => <integer>,
        'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
        'WarmCount' => <integer>,
        'WarmEnabled' => true || false,
        'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
        'ZoneAwarenessConfig' => [
            'AvailabilityZoneCount' => <integer>,
        ],
        'ZoneAwarenessEnabled' => true || false,
    ],
    'ElasticsearchVersion' => '<string>',
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'TagList' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

AccessPolicies

Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions

Type: Associative array of custom strings keys (String) to strings

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsInput structure

Specifies advanced security options.

AutoTuneOptions

Type: AutoTuneOptionsInput structure

Specifies Auto-Tune options.

CognitoOptions

Type: CognitoOptions structure

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

DomainEndpointOptions

Type: DomainEndpointOptions structure

Options to specify configuration that will be applied to the domain endpoint.

DomainName

Required: Yes
Type: string

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

EBSOptions

Type: EBSOptions structure

Options to enable, disable and specify the type and size of EBS storage volumes.

ElasticsearchClusterConfig

Type: ElasticsearchClusterConfig structure

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

ElasticsearchVersion

Type: string

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Specifies the Encryption At Rest Options.

LogPublishingOptions

Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Specifies the NodeToNodeEncryptionOptions.

SnapshotOptions

Type: SnapshotOptions structure

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

TagList

Type: Array of Tag structures

A list of Tag added during domain creation.

VPCOptions

Type: VPCOptions structure

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'ElasticsearchClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'ElasticsearchVersion' => '<string>',
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members

DomainStatus

Type: ElasticsearchDomainStatus structure

The status of the newly created Elasticsearch domain.

Errors

BaseException:
An error occurred while processing the request.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
InvalidTypeException:
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

CreateOutboundCrossClusterSearchConnection

$result = $client->createOutboundCrossClusterSearchConnection([/* ... */]);
$promise = $client->createOutboundCrossClusterSearchConnectionAsync([/* ... */]);

Creates a new cross-cluster search connection from a source domain to a destination domain.

Parameter Syntax

$result = $client->createOutboundCrossClusterSearchConnection([
    'ConnectionAlias' => '<string>', // REQUIRED
    'DestinationDomainInfo' => [ // REQUIRED
        'DomainName' => '<string>', // REQUIRED
        'OwnerId' => '<string>',
        'Region' => '<string>',
    ],
    'SourceDomainInfo' => [ // REQUIRED
        'DomainName' => '<string>', // REQUIRED
        'OwnerId' => '<string>',
        'Region' => '<string>',
    ],
]);

Parameter Details

Members

ConnectionAlias

Required: Yes
Type: string

Specifies the connection alias that will be used by the customer for this connection.

DestinationDomainInfo

Required: Yes
Type: DomainInformation structure

Specifies the DomainInformation for the destination Elasticsearch domain.

SourceDomainInfo

Required: Yes
Type: DomainInformation structure

Specifies the DomainInformation for the source Elasticsearch domain.

Result Syntax

[
    'ConnectionAlias' => '<string>',
    'ConnectionStatus' => [
        'Message' => '<string>',
        'StatusCode' => 'PENDING_ACCEPTANCE|VALIDATING|VALIDATION_FAILED|PROVISIONING|ACTIVE|REJECTED|DELETING|DELETED',
    ],
    'CrossClusterSearchConnectionId' => '<string>',
    'DestinationDomainInfo' => [
        'DomainName' => '<string>',
        'OwnerId' => '<string>',
        'Region' => '<string>',
    ],
    'SourceDomainInfo' => [
        'DomainName' => '<string>',
        'OwnerId' => '<string>',
        'Region' => '<string>',
    ],
]

Result Details

Members

ConnectionAlias

Type: string

Specifies the connection alias provided during the create connection request.

ConnectionStatus

Type: OutboundCrossClusterSearchConnectionStatus structure

Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

CrossClusterSearchConnectionId

Type: string

Unique id for the created outbound connection, which is used for subsequent operations on connection.

DestinationDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the destination Elasticsearch domain.

SourceDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the source Elasticsearch domain.

Errors

LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

CreatePackage

$result = $client->createPackage([/* ... */]);
$promise = $client->createPackageAsync([/* ... */]);

Create a package for use with Amazon ES domains.

Parameter Syntax

$result = $client->createPackage([
    'PackageDescription' => '<string>',
    'PackageName' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
    'PackageType' => 'TXT-DICTIONARY', // REQUIRED
]);

Parameter Details

Members

PackageDescription

Type: string

Description of the package.

PackageName

Required: Yes
Type: string

Unique identifier for the package.

PackageSource

Required: Yes
Type: PackageSource structure

The customer S3 location PackageSource for importing the package.

PackageType

Required: Yes
Type: string

Type of package. Currently supports only TXT-DICTIONARY.

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

Information about the package PackageDetails.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
InvalidTypeException:
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DeleteElasticsearchDomain

$result = $client->deleteElasticsearchDomain([/* ... */]);
$promise = $client->deleteElasticsearchDomainAsync([/* ... */]);

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

Parameter Syntax

$result = $client->deleteElasticsearchDomain([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the Elasticsearch domain that you want to permanently delete.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'ElasticsearchClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'ElasticsearchVersion' => '<string>',
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members

DomainStatus

Type: ElasticsearchDomainStatus structure

The status of the Elasticsearch domain being deleted.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DeleteElasticsearchServiceRole

$result = $client->deleteElasticsearchServiceRole([/* ... */]);
$promise = $client->deleteElasticsearchServiceRoleAsync([/* ... */]);

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

Parameter Syntax

$result = $client->deleteElasticsearchServiceRole([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DeleteInboundCrossClusterSearchConnection

$result = $client->deleteInboundCrossClusterSearchConnection([/* ... */]);
$promise = $client->deleteInboundCrossClusterSearchConnectionAsync([/* ... */]);

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

Parameter Syntax

$result = $client->deleteInboundCrossClusterSearchConnection([
    'CrossClusterSearchConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CrossClusterSearchConnectionId

Required: Yes
Type: string

The id of the inbound connection that you want to permanently delete.

Result Syntax

[
    'CrossClusterSearchConnection' => [
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'CrossClusterSearchConnectionId' => '<string>',
        'DestinationDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
        'SourceDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]

Result Details

Members

CrossClusterSearchConnection

Type: InboundCrossClusterSearchConnection structure

Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DeleteOutboundCrossClusterSearchConnection

$result = $client->deleteOutboundCrossClusterSearchConnection([/* ... */]);
$promise = $client->deleteOutboundCrossClusterSearchConnectionAsync([/* ... */]);

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

Parameter Syntax

$result = $client->deleteOutboundCrossClusterSearchConnection([
    'CrossClusterSearchConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CrossClusterSearchConnectionId

Required: Yes
Type: string

The id of the outbound connection that you want to permanently delete.

Result Syntax

[
    'CrossClusterSearchConnection' => [
        'ConnectionAlias' => '<string>',
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|VALIDATING|VALIDATION_FAILED|PROVISIONING|ACTIVE|REJECTED|DELETING|DELETED',
        ],
        'CrossClusterSearchConnectionId' => '<string>',
        'DestinationDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
        'SourceDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]

Result Details

Members

CrossClusterSearchConnection

Type: OutboundCrossClusterSearchConnection structure

Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DeletePackage

$result = $client->deletePackage([/* ... */]);
$promise = $client->deletePackageAsync([/* ... */]);

Delete the package.

Parameter Syntax

$result = $client->deletePackage([
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

PackageID

Required: Yes
Type: string

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

PackageDetails

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
ConflictException:
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

DescribeDomainAutoTunes

$result = $client->describeDomainAutoTunes([/* ... */]);
$promise = $client->describeDomainAutoTunesAsync([/* ... */]);

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Parameter Syntax

$result = $client->describeDomainAutoTunes([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

Specifies the domain name for which you want Auto-Tune action details.

MaxResults

Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken

Type: string

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Result Syntax

[
    'AutoTunes' => [
        [
            'AutoTuneDetails' => [
                'ScheduledAutoTuneDetails' => [
                    'Action' => '<string>',
                    'ActionType' => 'JVM_HEAP_SIZE_TUNING|JVM_YOUNG_GEN_TUNING',
                    'Date' => <DateTime>,
                    'Severity' => 'LOW|MEDIUM|HIGH',
                ],
            ],
            'AutoTuneType' => 'SCHEDULED_ACTION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

AutoTunes

Type: Array of AutoTune structures

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

NextToken

Type: string

Specifies an identifier to allow retrieval of paginated results.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeElasticsearchDomain

$result = $client->describeElasticsearchDomain([/* ... */]);
$promise = $client->describeElasticsearchDomainAsync([/* ... */]);

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Parameter Syntax

$result = $client->describeElasticsearchDomain([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the Elasticsearch domain for which you want information.

Result Syntax

[
    'DomainStatus' => [
        'ARN' => '<string>',
        'AccessPolicies' => '<string>',
        'AdvancedOptions' => ['<string>', ...],
        'AdvancedSecurityOptions' => [
            'Enabled' => true || false,
            'InternalUserDatabaseEnabled' => true || false,
            'SAMLOptions' => [
                'Enabled' => true || false,
                'Idp' => [
                    'EntityId' => '<string>',
                    'MetadataContent' => '<string>',
                ],
                'RolesKey' => '<string>',
                'SessionTimeoutMinutes' => <integer>,
                'SubjectKey' => '<string>',
            ],
        ],
        'AutoTuneOptions' => [
            'ErrorMessage' => '<string>',
            'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
        ],
        'CognitoOptions' => [
            'Enabled' => true || false,
            'IdentityPoolId' => '<string>',
            'RoleArn' => '<string>',
            'UserPoolId' => '<string>',
        ],
        'Created' => true || false,
        'Deleted' => true || false,
        'DomainEndpointOptions' => [
            'CustomEndpoint' => '<string>',
            'CustomEndpointCertificateArn' => '<string>',
            'CustomEndpointEnabled' => true || false,
            'EnforceHTTPS' => true || false,
            'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
        ],
        'DomainId' => '<string>',
        'DomainName' => '<string>',
        'EBSOptions' => [
            'EBSEnabled' => true || false,
            'Iops' => <integer>,
            'VolumeSize' => <integer>,
            'VolumeType' => 'standard|gp2|io1',
        ],
        'ElasticsearchClusterConfig' => [
            'ColdStorageOptions' => [
                'Enabled' => true || false,
            ],
            'DedicatedMasterCount' => <integer>,
            'DedicatedMasterEnabled' => true || false,
            'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'InstanceCount' => <integer>,
            'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'WarmCount' => <integer>,
            'WarmEnabled' => true || false,
            'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
            'ZoneAwarenessConfig' => [
                'AvailabilityZoneCount' => <integer>,
            ],
            'ZoneAwarenessEnabled' => true || false,
        ],
        'ElasticsearchVersion' => '<string>',
        'EncryptionAtRestOptions' => [
            'Enabled' => true || false,
            'KmsKeyId' => '<string>',
        ],
        'Endpoint' => '<string>',
        'Endpoints' => ['<string>', ...],
        'LogPublishingOptions' => [
            '<LogType>' => [
                'CloudWatchLogsLogGroupArn' => '<string>',
                'Enabled' => true || false,
            ],
            // ...
        ],
        'NodeToNodeEncryptionOptions' => [
            'Enabled' => true || false,
        ],
        'Processing' => true || false,
        'ServiceSoftwareOptions' => [
            'AutomatedUpdateDate' => <DateTime>,
            'Cancellable' => true || false,
            'CurrentVersion' => '<string>',
            'Description' => '<string>',
            'NewVersion' => '<string>',
            'OptionalDeployment' => true || false,
            'UpdateAvailable' => true || false,
            'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
        ],
        'SnapshotOptions' => [
            'AutomatedSnapshotStartHour' => <integer>,
        ],
        'UpgradeProcessing' => true || false,
        'VPCOptions' => [
            'AvailabilityZones' => ['<string>', ...],
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
            'VPCId' => '<string>',
        ],
    ],
]

Result Details

Members

DomainStatus

Required: Yes
Type: ElasticsearchDomainStatus structure

The current status of the Elasticsearch domain.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeElasticsearchDomainConfig

$result = $client->describeElasticsearchDomainConfig([/* ... */]);
$promise = $client->describeElasticsearchDomainConfigAsync([/* ... */]);

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Parameter Syntax

$result = $client->describeElasticsearchDomainConfig([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The Elasticsearch domain that you want to get information about.

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'ErrorMessage' => '<string>',
                'PendingDeletion' => true || false,
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'CognitoOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'DomainEndpointOptions' => [
            'Options' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ElasticsearchClusterConfig' => [
            'Options' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ElasticsearchVersion' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EncryptionAtRestOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'LogPublishingOptions' => [
            'Options' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'SnapshotOptions' => [
            'Options' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'VPCOptions' => [
            'Options' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
    ],
]

Result Details

Members

DomainConfig

Required: Yes
Type: ElasticsearchDomainConfig structure

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeElasticsearchDomains

$result = $client->describeElasticsearchDomains([/* ... */]);
$promise = $client->describeElasticsearchDomainsAsync([/* ... */]);

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Parameter Syntax

$result = $client->describeElasticsearchDomains([
    'DomainNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

DomainNames

Required: Yes
Type: Array of strings

The Elasticsearch domains for which you want information.

Result Syntax

[
    'DomainStatusList' => [
        [
            'ARN' => '<string>',
            'AccessPolicies' => '<string>',
            'AdvancedOptions' => ['<string>', ...],
            'AdvancedSecurityOptions' => [
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'AutoTuneOptions' => [
                'ErrorMessage' => '<string>',
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
            ],
            'CognitoOptions' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Created' => true || false,
            'Deleted' => true || false,
            'DomainEndpointOptions' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'DomainId' => '<string>',
            'DomainName' => '<string>',
            'EBSOptions' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'ElasticsearchClusterConfig' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'ElasticsearchVersion' => '<string>',
            'EncryptionAtRestOptions' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Endpoint' => '<string>',
            'Endpoints' => ['<string>', ...],
            'LogPublishingOptions' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'NodeToNodeEncryptionOptions' => [
                'Enabled' => true || false,
            ],
            'Processing' => true || false,
            'ServiceSoftwareOptions' => [
                'AutomatedUpdateDate' => <DateTime>,
                'Cancellable' => true || false,
                'CurrentVersion' => '<string>',
                'Description' => '<string>',
                'NewVersion' => '<string>',
                'OptionalDeployment' => true || false,
                'UpdateAvailable' => true || false,
                'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
            ],
            'SnapshotOptions' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'UpgradeProcessing' => true || false,
            'VPCOptions' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

DomainStatusList

Required: Yes
Type: Array of ElasticsearchDomainStatus structures

The status of the domains requested in the DescribeElasticsearchDomains request.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeElasticsearchInstanceTypeLimits

$result = $client->describeElasticsearchInstanceTypeLimits([/* ... */]);
$promise = $client->describeElasticsearchInstanceTypeLimitsAsync([/* ... */]);

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Parameter Syntax

$result = $client->describeElasticsearchInstanceTypeLimits([
    'DomainName' => '<string>',
    'ElasticsearchVersion' => '<string>', // REQUIRED
    'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch', // REQUIRED
]);

Parameter Details

Members

DomainName

Type: string

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

ElasticsearchVersion

Required: Yes
Type: string

Version of Elasticsearch for which Limits are needed.

InstanceType

Required: Yes
Type: string

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

Result Syntax

[
    'LimitsByRole' => [
        '<InstanceRole>' => [
            'AdditionalLimits' => [
                [
                    'LimitName' => '<string>',
                    'LimitValues' => ['<string>', ...],
                ],
                // ...
            ],
            'InstanceLimits' => [
                'InstanceCountLimits' => [
                    'MaximumInstanceCount' => <integer>,
                    'MinimumInstanceCount' => <integer>,
                ],
            ],
            'StorageTypes' => [
                [
                    'StorageSubTypeName' => '<string>',
                    'StorageTypeLimits' => [
                        [
                            'LimitName' => '<string>',
                            'LimitValues' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'StorageTypeName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

LimitsByRole

Type: Associative array of custom strings keys (InstanceRole) to Limits structures

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

data: If the given InstanceType is used as data node
master: If the given InstanceType is used as master node
ultra_warm: If the given InstanceType is used as warm node

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
InvalidTypeException:
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeInboundCrossClusterSearchConnections

$result = $client->describeInboundCrossClusterSearchConnections([/* ... */]);
$promise = $client->describeInboundCrossClusterSearchConnectionsAsync([/* ... */]);

Lists all the inbound cross-cluster search connections for a destination domain.

Parameter Syntax

$result = $client->describeInboundCrossClusterSearchConnections([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

cross-cluster-search-connection-id
source-domain-info.domain-name
source-domain-info.owner-id
source-domain-info.region
destination-domain-info.domain-name

MaxResults

Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken

Type: string

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Result Syntax

[
    'CrossClusterSearchConnections' => [
        [
            'ConnectionStatus' => [
                'Message' => '<string>',
                'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|REJECTING|REJECTED|DELETING|DELETED',
            ],
            'CrossClusterSearchConnectionId' => '<string>',
            'DestinationDomainInfo' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
            'SourceDomainInfo' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CrossClusterSearchConnections

Type: Array of InboundCrossClusterSearchConnection structures

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

NextToken

Type: string

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Errors

InvalidPaginationTokenException:
The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DescribeOutboundCrossClusterSearchConnections

$result = $client->describeOutboundCrossClusterSearchConnections([/* ... */]);
$promise = $client->describeOutboundCrossClusterSearchConnectionsAsync([/* ... */]);

Lists all the outbound cross-cluster search connections for a source domain.

Parameter Syntax

$result = $client->describeOutboundCrossClusterSearchConnections([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are:

cross-cluster-search-connection-id
destination-domain-info.domain-name
destination-domain-info.owner-id
destination-domain-info.region
source-domain-info.domain-name

MaxResults

Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken

Type: string

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Result Syntax

[
    'CrossClusterSearchConnections' => [
        [
            'ConnectionAlias' => '<string>',
            'ConnectionStatus' => [
                'Message' => '<string>',
                'StatusCode' => 'PENDING_ACCEPTANCE|VALIDATING|VALIDATION_FAILED|PROVISIONING|ACTIVE|REJECTED|DELETING|DELETED',
            ],
            'CrossClusterSearchConnectionId' => '<string>',
            'DestinationDomainInfo' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
            'SourceDomainInfo' => [
                'DomainName' => '<string>',
                'OwnerId' => '<string>',
                'Region' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CrossClusterSearchConnections

Type: Array of OutboundCrossClusterSearchConnection structures

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

NextToken

Type: string

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Errors

InvalidPaginationTokenException:
The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DescribePackages

$result = $client->describePackages([/* ... */]);
$promise = $client->describePackagesAsync([/* ... */]);

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Parameter Syntax

$result = $client->describePackages([
    'Filters' => [
        [
            'Name' => 'PackageID|PackageName|PackageStatus',
            'Value' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of DescribePackagesFilter structures

Only returns packages that match the DescribePackagesFilterList values.

MaxResults

Type: int

Limits results to a maximum number of packages.

NextToken

Type: 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.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageDetailsList' => [
        [
            'AvailablePackageVersion' => '<string>',
            'CreatedAt' => <DateTime>,
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdatedAt' => <DateTime>,
            'PackageDescription' => '<string>',
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
            'PackageType' => 'TXT-DICTIONARY',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackageDetailsList

Type: Array of PackageDetails structures

List of PackageDetails objects.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

DescribeReservedElasticsearchInstanceOfferings

$result = $client->describeReservedElasticsearchInstanceOfferings([/* ... */]);
$promise = $client->describeReservedElasticsearchInstanceOfferingsAsync([/* ... */]);

Lists available reserved Elasticsearch instance offerings.

Parameter Syntax

$result = $client->describeReservedElasticsearchInstanceOfferings([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReservedElasticsearchInstanceOfferingId' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken

Type: string

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

ReservedElasticsearchInstanceOfferingId

Type: string

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedElasticsearchInstanceOfferings' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'ElasticsearchInstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'FixedPrice' => <float>,
            'PaymentOption' => 'ALL_UPFRONT|PARTIAL_UPFRONT|NO_UPFRONT',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservedElasticsearchInstanceOfferingId' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedElasticsearchInstanceOfferings

Type: Array of ReservedElasticsearchInstanceOffering structures

List of reserved Elasticsearch instance offerings

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

DescribeReservedElasticsearchInstances

$result = $client->describeReservedElasticsearchInstances([/* ... */]);
$promise = $client->describeReservedElasticsearchInstancesAsync([/* ... */]);

Returns information about reserved Elasticsearch instances for this account.

Parameter Syntax

$result = $client->describeReservedElasticsearchInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ReservedElasticsearchInstanceId' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Set this value to limit the number of results returned. If not specified, defaults to 100.

NextToken

Type: string

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

ReservedElasticsearchInstanceId

Type: string

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

Result Syntax

[
    'NextToken' => '<string>',
    'ReservedElasticsearchInstances' => [
        [
            'CurrencyCode' => '<string>',
            'Duration' => <integer>,
            'ElasticsearchInstanceCount' => <integer>,
            'ElasticsearchInstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
            'FixedPrice' => <float>,
            'PaymentOption' => 'ALL_UPFRONT|PARTIAL_UPFRONT|NO_UPFRONT',
            'RecurringCharges' => [
                [
                    'RecurringChargeAmount' => <float>,
                    'RecurringChargeFrequency' => '<string>',
                ],
                // ...
            ],
            'ReservationName' => '<string>',
            'ReservedElasticsearchInstanceId' => '<string>',
            'ReservedElasticsearchInstanceOfferingId' => '<string>',
            'StartTime' => <DateTime>,
            'State' => '<string>',
            'UsagePrice' => <float>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Provides an identifier to allow retrieval of paginated results.

ReservedElasticsearchInstances

Type: Array of ReservedElasticsearchInstance structures

List of reserved Elasticsearch instances.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

DissociatePackage

$result = $client->dissociatePackage([/* ... */]);
$promise = $client->dissociatePackageAsync([/* ... */]);

Dissociates a package from the Amazon ES domain.

Parameter Syntax

$result = $client->dissociatePackage([
    'DomainName' => '<string>', // REQUIRED
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

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

PackageID

Required: Yes
Type: string

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

Result Syntax

[
    'DomainPackageDetails' => [
        'DomainName' => '<string>',
        'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdated' => <DateTime>,
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageType' => 'TXT-DICTIONARY',
        'PackageVersion' => '<string>',
        'ReferencePath' => '<string>',
    ],
]

Result Details

Members

DomainPackageDetails

Type: DomainPackageDetails structure

DomainPackageDetails

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
ConflictException:
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

GetCompatibleElasticsearchVersions

$result = $client->getCompatibleElasticsearchVersions([/* ... */]);
$promise = $client->getCompatibleElasticsearchVersionsAsync([/* ... */]);

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

Parameter Syntax

$result = $client->getCompatibleElasticsearchVersions([
    'DomainName' => '<string>',
]);

Parameter Details

Members

DomainName

Type: string

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Result Syntax

[
    'CompatibleElasticsearchVersions' => [
        [
            'SourceVersion' => '<string>',
            'TargetVersions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

CompatibleElasticsearchVersions

Type: Array of CompatibleVersionsMap structures

A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

GetPackageVersionHistory

$result = $client->getPackageVersionHistory([/* ... */]);
$promise = $client->getPackageVersionHistoryAsync([/* ... */]);

Returns a list of versions of the package, along with their creation time and commit message.

Parameter Syntax

$result = $client->getPackageVersionHistory([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

Limits results to a maximum number of versions.

NextToken

Type: 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.

PackageID

Required: Yes
Type: string

Returns an audit history of versions of the package.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageID' => '<string>',
    'PackageVersionHistoryList' => [
        [
            'CommitMessage' => '<string>',
            'CreatedAt' => <DateTime>,
            'PackageVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

PackageID

Type: string

PackageVersionHistoryList

Type: Array of PackageVersionHistory structures

List of PackageVersionHistory objects.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

GetUpgradeHistory

$result = $client->getUpgradeHistory([/* ... */]);
$promise = $client->getUpgradeHistoryAsync([/* ... */]);

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Parameter Syntax

$result = $client->getUpgradeHistory([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

MaxResults

Type: int

Set this value to limit the number of results returned.

NextToken

Type: string

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Result Syntax

[
    'NextToken' => '<string>',
    'UpgradeHistories' => [
        [
            'StartTimestamp' => <DateTime>,
            'StepsList' => [
                [
                    'Issues' => ['<string>', ...],
                    'ProgressPercent' => <float>,
                    'UpgradeStep' => 'PRE_UPGRADE_CHECK|SNAPSHOT|UPGRADE',
                    'UpgradeStepStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
                ],
                // ...
            ],
            'UpgradeName' => '<string>',
            'UpgradeStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

UpgradeHistories

Type: Array of UpgradeHistory structures

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

GetUpgradeStatus

$result = $client->getUpgradeStatus([/* ... */]);
$promise = $client->getUpgradeStatusAsync([/* ... */]);

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Parameter Syntax

$result = $client->getUpgradeStatus([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

Result Syntax

[
    'StepStatus' => 'IN_PROGRESS|SUCCEEDED|SUCCEEDED_WITH_ISSUES|FAILED',
    'UpgradeName' => '<string>',
    'UpgradeStep' => 'PRE_UPGRADE_CHECK|SNAPSHOT|UPGRADE',
]

Result Details

Members

StepStatus

Type: string

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

UpgradeName

Type: string

A string that describes the update briefly

UpgradeStep

Type: string

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

PreUpgradeCheck
Snapshot
Upgrade

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

ListDomainNames

$result = $client->listDomainNames([/* ... */]);
$promise = $client->listDomainNamesAsync([/* ... */]);

Returns the name of all Elasticsearch domains owned by the current user's account.

Parameter Syntax

$result = $client->listDomainNames([
]);

Parameter Details

Members

Result Syntax

[
    'DomainNames' => [
        [
            'DomainName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

DomainNames

Type: Array of DomainInfo structures

List of Elasticsearch domain names.

Errors

BaseException:
An error occurred while processing the request.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

ListDomainsForPackage

$result = $client->listDomainsForPackage([/* ... */]);
$promise = $client->listDomainsForPackageAsync([/* ... */]);

Lists all Amazon ES domains associated with the package.

Parameter Syntax

$result = $client->listDomainsForPackage([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PackageID' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

Limits results to a maximum number of domains.

NextToken

Type: 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.

PackageID

Required: Yes
Type: string

The package for which to list domains.

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY',
            'PackageVersion' => '<string>',
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DomainPackageDetailsList

Type: Array of DomainPackageDetails structures

List of DomainPackageDetails objects.

NextToken

Type: string

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

ListElasticsearchInstanceTypes

$result = $client->listElasticsearchInstanceTypes([/* ... */]);
$promise = $client->listElasticsearchInstanceTypesAsync([/* ... */]);

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Parameter Syntax

$result = $client->listElasticsearchInstanceTypes([
    'DomainName' => '<string>',
    'ElasticsearchVersion' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainName

Type: string

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

ElasticsearchVersion

Required: Yes
Type: string

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

MaxResults

Type: int

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

NextToken

Type: string

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Result Syntax

[
    'ElasticsearchInstanceTypes' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

ElasticsearchInstanceTypes

Type: Array of strings

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

NextToken

Type: string

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

ListElasticsearchVersions

$result = $client->listElasticsearchVersions([/* ... */]);
$promise = $client->listElasticsearchVersionsAsync([/* ... */]);

List all supported Elasticsearch versions

Parameter Syntax

$result = $client->listElasticsearchVersions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

NextToken

Type: string

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Result Syntax

[
    'ElasticsearchVersions' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

ElasticsearchVersions

Type: Array of strings

List of supported elastic search versions.

NextToken

Type: string

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

ListPackagesForDomain

$result = $client->listPackagesForDomain([/* ... */]);
$promise = $client->listPackagesForDomainAsync([/* ... */]);

Lists all packages associated with the Amazon ES domain.

Parameter Syntax

$result = $client->listPackagesForDomain([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

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

MaxResults

Type: int

Limits results to a maximum number of packages.

NextToken

Type: 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.

Result Syntax

[
    'DomainPackageDetailsList' => [
        [
            'DomainName' => '<string>',
            'DomainPackageStatus' => 'ASSOCIATING|ASSOCIATION_FAILED|ACTIVE|DISSOCIATING|DISSOCIATION_FAILED',
            'ErrorDetails' => [
                'ErrorMessage' => '<string>',
                'ErrorType' => '<string>',
            ],
            'LastUpdated' => <DateTime>,
            'PackageID' => '<string>',
            'PackageName' => '<string>',
            'PackageType' => 'TXT-DICTIONARY',
            'PackageVersion' => '<string>',
            'ReferencePath' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DomainPackageDetailsList

Type: Array of DomainPackageDetails structures

List of DomainPackageDetails objects.

NextToken

Type: string

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

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Returns all tags for the given Elasticsearch domain.

Parameter Syntax

$result = $client->listTags([
    'ARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

ARN

Required: Yes
Type: string

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

Result Syntax

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagList

Type: Array of Tag structures

List of Tag for the requested Elasticsearch domain.

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

PurchaseReservedElasticsearchInstanceOffering

$result = $client->purchaseReservedElasticsearchInstanceOffering([/* ... */]);
$promise = $client->purchaseReservedElasticsearchInstanceOfferingAsync([/* ... */]);

Allows you to purchase reserved Elasticsearch instances.

Parameter Syntax

$result = $client->purchaseReservedElasticsearchInstanceOffering([
    'InstanceCount' => <integer>,
    'ReservationName' => '<string>', // REQUIRED
    'ReservedElasticsearchInstanceOfferingId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceCount

Type: int

The number of Elasticsearch instances to reserve.

ReservationName

Required: Yes
Type: string

A customer-specified identifier to track this reservation.

ReservedElasticsearchInstanceOfferingId

Required: Yes
Type: string

The ID of the reserved Elasticsearch instance offering to purchase.

Result Syntax

[
    'ReservationName' => '<string>',
    'ReservedElasticsearchInstanceId' => '<string>',
]

Result Details

Members

ReservationName

Type: string

The customer-specified identifier used to track this reservation.

ReservedElasticsearchInstanceId

Type: string

Details of the reserved Elasticsearch instance which was purchased.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists. Gives http status code of 400.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

RejectInboundCrossClusterSearchConnection

$result = $client->rejectInboundCrossClusterSearchConnection([/* ... */]);
$promise = $client->rejectInboundCrossClusterSearchConnectionAsync([/* ... */]);

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Parameter Syntax

$result = $client->rejectInboundCrossClusterSearchConnection([
    'CrossClusterSearchConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

CrossClusterSearchConnectionId

Required: Yes
Type: string

The id of the inbound connection that you want to reject.

Result Syntax

[
    'CrossClusterSearchConnection' => [
        'ConnectionStatus' => [
            'Message' => '<string>',
            'StatusCode' => 'PENDING_ACCEPTANCE|APPROVED|REJECTING|REJECTED|DELETING|DELETED',
        ],
        'CrossClusterSearchConnectionId' => '<string>',
        'DestinationDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
        'SourceDomainInfo' => [
            'DomainName' => '<string>',
            'OwnerId' => '<string>',
            'Region' => '<string>',
        ],
    ],
]

Result Details

Members

CrossClusterSearchConnection

Type: InboundCrossClusterSearchConnection structure

Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

Errors

ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

RemoveTags

$result = $client->removeTags([/* ... */]);
$promise = $client->removeTagsAsync([/* ... */]);

Removes the specified set of tags from the specified Elasticsearch domain.

Parameter Syntax

$result = $client->removeTags([
    'ARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ARN

Required: Yes
Type: string

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

TagKeys

Required: Yes
Type: Array of strings

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BaseException:
An error occurred while processing the request.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

StartElasticsearchServiceSoftwareUpdate

$result = $client->startElasticsearchServiceSoftwareUpdate([/* ... */]);
$promise = $client->startElasticsearchServiceSoftwareUpdateAsync([/* ... */]);

Schedules a service software update for an Amazon ES domain.

Parameter Syntax

$result = $client->startElasticsearchServiceSoftwareUpdate([
    'DomainName' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

The name of the domain that you want to update to the latest service software.

Result Syntax

[
    'ServiceSoftwareOptions' => [
        'AutomatedUpdateDate' => <DateTime>,
        'Cancellable' => true || false,
        'CurrentVersion' => '<string>',
        'Description' => '<string>',
        'NewVersion' => '<string>',
        'OptionalDeployment' => true || false,
        'UpdateAvailable' => true || false,
        'UpdateStatus' => 'PENDING_UPDATE|IN_PROGRESS|COMPLETED|NOT_ELIGIBLE|ELIGIBLE',
    ],
]

Result Details

Members

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

The current status of the Elasticsearch service software update.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

UpdateElasticsearchDomainConfig

$result = $client->updateElasticsearchDomainConfig([/* ... */]);
$promise = $client->updateElasticsearchDomainConfigAsync([/* ... */]);

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Parameter Syntax

$result = $client->updateElasticsearchDomainConfig([
    'AccessPolicies' => '<string>',
    'AdvancedOptions' => ['<string>', ...],
    'AdvancedSecurityOptions' => [
        'Enabled' => true || false,
        'InternalUserDatabaseEnabled' => true || false,
        'MasterUserOptions' => [
            'MasterUserARN' => '<string>',
            'MasterUserName' => '<string>',
            'MasterUserPassword' => '<string>',
        ],
        'SAMLOptions' => [
            'Enabled' => true || false,
            'Idp' => [
                'EntityId' => '<string>', // REQUIRED
                'MetadataContent' => '<string>', // REQUIRED
            ],
            'MasterBackendRole' => '<string>',
            'MasterUserName' => '<string>',
            'RolesKey' => '<string>',
            'SessionTimeoutMinutes' => <integer>,
            'SubjectKey' => '<string>',
        ],
    ],
    'AutoTuneOptions' => [
        'DesiredState' => 'ENABLED|DISABLED',
        'MaintenanceSchedules' => [
            [
                'CronExpressionForRecurrence' => '<string>',
                'Duration' => [
                    'Unit' => 'HOURS',
                    'Value' => <integer>,
                ],
                'StartAt' => <integer || string || DateTime>,
            ],
            // ...
        ],
        'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
    ],
    'CognitoOptions' => [
        'Enabled' => true || false,
        'IdentityPoolId' => '<string>',
        'RoleArn' => '<string>',
        'UserPoolId' => '<string>',
    ],
    'DomainEndpointOptions' => [
        'CustomEndpoint' => '<string>',
        'CustomEndpointCertificateArn' => '<string>',
        'CustomEndpointEnabled' => true || false,
        'EnforceHTTPS' => true || false,
        'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
    ],
    'DomainName' => '<string>', // REQUIRED
    'EBSOptions' => [
        'EBSEnabled' => true || false,
        'Iops' => <integer>,
        'VolumeSize' => <integer>,
        'VolumeType' => 'standard|gp2|io1',
    ],
    'ElasticsearchClusterConfig' => [
        'ColdStorageOptions' => [
            'Enabled' => true || false, // REQUIRED
        ],
        'DedicatedMasterCount' => <integer>,
        'DedicatedMasterEnabled' => true || false,
        'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
        'InstanceCount' => <integer>,
        'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
        'WarmCount' => <integer>,
        'WarmEnabled' => true || false,
        'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
        'ZoneAwarenessConfig' => [
            'AvailabilityZoneCount' => <integer>,
        ],
        'ZoneAwarenessEnabled' => true || false,
    ],
    'EncryptionAtRestOptions' => [
        'Enabled' => true || false,
        'KmsKeyId' => '<string>',
    ],
    'LogPublishingOptions' => [
        '<LogType>' => [
            'CloudWatchLogsLogGroupArn' => '<string>',
            'Enabled' => true || false,
        ],
        // ...
    ],
    'NodeToNodeEncryptionOptions' => [
        'Enabled' => true || false,
    ],
    'SnapshotOptions' => [
        'AutomatedSnapshotStartHour' => <integer>,
    ],
    'VPCOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

AccessPolicies

Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions

Type: Associative array of custom strings keys (String) to strings

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsInput structure

Specifies advanced security options.

AutoTuneOptions

Type: AutoTuneOptions structure

Specifies Auto-Tune options.

CognitoOptions

Type: CognitoOptions structure

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

DomainEndpointOptions

Type: DomainEndpointOptions structure

Options to specify configuration that will be applied to the domain endpoint.

DomainName

Required: Yes
Type: string

The name of the Elasticsearch domain that you are updating.

EBSOptions

Type: EBSOptions structure

Specify the type and size of the EBS volume that you want to use.

ElasticsearchClusterConfig

Type: ElasticsearchClusterConfig structure

The type and number of instances to instantiate for the domain cluster.

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Specifies the Encryption At Rest Options.

LogPublishingOptions

Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Specifies the NodeToNodeEncryptionOptions.

SnapshotOptions

Type: SnapshotOptions structure

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

VPCOptions

Type: VPCOptions structure

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

Result Syntax

[
    'DomainConfig' => [
        'AccessPolicies' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedOptions' => [
            'Options' => ['<string>', ...],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AdvancedSecurityOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'InternalUserDatabaseEnabled' => true || false,
                'SAMLOptions' => [
                    'Enabled' => true || false,
                    'Idp' => [
                        'EntityId' => '<string>',
                        'MetadataContent' => '<string>',
                    ],
                    'RolesKey' => '<string>',
                    'SessionTimeoutMinutes' => <integer>,
                    'SubjectKey' => '<string>',
                ],
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'AutoTuneOptions' => [
            'Options' => [
                'DesiredState' => 'ENABLED|DISABLED',
                'MaintenanceSchedules' => [
                    [
                        'CronExpressionForRecurrence' => '<string>',
                        'Duration' => [
                            'Unit' => 'HOURS',
                            'Value' => <integer>,
                        ],
                        'StartAt' => <DateTime>,
                    ],
                    // ...
                ],
                'RollbackOnDisable' => 'NO_ROLLBACK|DEFAULT_ROLLBACK',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'ErrorMessage' => '<string>',
                'PendingDeletion' => true || false,
                'State' => 'ENABLED|DISABLED|ENABLE_IN_PROGRESS|DISABLE_IN_PROGRESS|DISABLED_AND_ROLLBACK_SCHEDULED|DISABLED_AND_ROLLBACK_IN_PROGRESS|DISABLED_AND_ROLLBACK_COMPLETE|DISABLED_AND_ROLLBACK_ERROR|ERROR',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'CognitoOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'IdentityPoolId' => '<string>',
                'RoleArn' => '<string>',
                'UserPoolId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'DomainEndpointOptions' => [
            'Options' => [
                'CustomEndpoint' => '<string>',
                'CustomEndpointCertificateArn' => '<string>',
                'CustomEndpointEnabled' => true || false,
                'EnforceHTTPS' => true || false,
                'TLSSecurityPolicy' => 'Policy-Min-TLS-1-0-2019-07|Policy-Min-TLS-1-2-2019-07',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EBSOptions' => [
            'Options' => [
                'EBSEnabled' => true || false,
                'Iops' => <integer>,
                'VolumeSize' => <integer>,
                'VolumeType' => 'standard|gp2|io1',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ElasticsearchClusterConfig' => [
            'Options' => [
                'ColdStorageOptions' => [
                    'Enabled' => true || false,
                ],
                'DedicatedMasterCount' => <integer>,
                'DedicatedMasterEnabled' => true || false,
                'DedicatedMasterType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'InstanceCount' => <integer>,
                'InstanceType' => 'm3.medium.elasticsearch|m3.large.elasticsearch|m3.xlarge.elasticsearch|m3.2xlarge.elasticsearch|m4.large.elasticsearch|m4.xlarge.elasticsearch|m4.2xlarge.elasticsearch|m4.4xlarge.elasticsearch|m4.10xlarge.elasticsearch|m5.large.elasticsearch|m5.xlarge.elasticsearch|m5.2xlarge.elasticsearch|m5.4xlarge.elasticsearch|m5.12xlarge.elasticsearch|r5.large.elasticsearch|r5.xlarge.elasticsearch|r5.2xlarge.elasticsearch|r5.4xlarge.elasticsearch|r5.12xlarge.elasticsearch|c5.large.elasticsearch|c5.xlarge.elasticsearch|c5.2xlarge.elasticsearch|c5.4xlarge.elasticsearch|c5.9xlarge.elasticsearch|c5.18xlarge.elasticsearch|ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch|t2.micro.elasticsearch|t2.small.elasticsearch|t2.medium.elasticsearch|r3.large.elasticsearch|r3.xlarge.elasticsearch|r3.2xlarge.elasticsearch|r3.4xlarge.elasticsearch|r3.8xlarge.elasticsearch|i2.xlarge.elasticsearch|i2.2xlarge.elasticsearch|d2.xlarge.elasticsearch|d2.2xlarge.elasticsearch|d2.4xlarge.elasticsearch|d2.8xlarge.elasticsearch|c4.large.elasticsearch|c4.xlarge.elasticsearch|c4.2xlarge.elasticsearch|c4.4xlarge.elasticsearch|c4.8xlarge.elasticsearch|r4.large.elasticsearch|r4.xlarge.elasticsearch|r4.2xlarge.elasticsearch|r4.4xlarge.elasticsearch|r4.8xlarge.elasticsearch|r4.16xlarge.elasticsearch|i3.large.elasticsearch|i3.xlarge.elasticsearch|i3.2xlarge.elasticsearch|i3.4xlarge.elasticsearch|i3.8xlarge.elasticsearch|i3.16xlarge.elasticsearch',
                'WarmCount' => <integer>,
                'WarmEnabled' => true || false,
                'WarmType' => 'ultrawarm1.medium.elasticsearch|ultrawarm1.large.elasticsearch',
                'ZoneAwarenessConfig' => [
                    'AvailabilityZoneCount' => <integer>,
                ],
                'ZoneAwarenessEnabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'ElasticsearchVersion' => [
            'Options' => '<string>',
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'EncryptionAtRestOptions' => [
            'Options' => [
                'Enabled' => true || false,
                'KmsKeyId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'LogPublishingOptions' => [
            'Options' => [
                '<LogType>' => [
                    'CloudWatchLogsLogGroupArn' => '<string>',
                    'Enabled' => true || false,
                ],
                // ...
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'NodeToNodeEncryptionOptions' => [
            'Options' => [
                'Enabled' => true || false,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'SnapshotOptions' => [
            'Options' => [
                'AutomatedSnapshotStartHour' => <integer>,
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
        'VPCOptions' => [
            'Options' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'VPCId' => '<string>',
            ],
            'Status' => [
                'CreationDate' => <DateTime>,
                'PendingDeletion' => true || false,
                'State' => 'RequiresIndexDocuments|Processing|Active',
                'UpdateDate' => <DateTime>,
                'UpdateVersion' => <integer>,
            ],
        ],
    ],
]

Result Details

Members

DomainConfig

Required: Yes
Type: ElasticsearchDomainConfig structure

The status of the updated Elasticsearch domain.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
InvalidTypeException:
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

UpdatePackage

$result = $client->updatePackage([/* ... */]);
$promise = $client->updatePackageAsync([/* ... */]);

Updates a package for use with Amazon ES domains.

Parameter Syntax

$result = $client->updatePackage([
    'CommitMessage' => '<string>',
    'PackageDescription' => '<string>',
    'PackageID' => '<string>', // REQUIRED
    'PackageSource' => [ // REQUIRED
        'S3BucketName' => '<string>',
        'S3Key' => '<string>',
    ],
]);

Parameter Details

Members

CommitMessage

Type: string

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

PackageDescription

Type: string

New description of the package.

PackageID

Required: Yes
Type: string

Unique identifier for the package.

PackageSource

Required: Yes
Type: PackageSource structure

The S3 location for importing the package specified as S3BucketName and S3Key

Result Syntax

[
    'PackageDetails' => [
        'AvailablePackageVersion' => '<string>',
        'CreatedAt' => <DateTime>,
        'ErrorDetails' => [
            'ErrorMessage' => '<string>',
            'ErrorType' => '<string>',
        ],
        'LastUpdatedAt' => <DateTime>,
        'PackageDescription' => '<string>',
        'PackageID' => '<string>',
        'PackageName' => '<string>',
        'PackageStatus' => 'COPYING|COPY_FAILED|VALIDATING|VALIDATION_FAILED|AVAILABLE|DELETING|DELETED|DELETE_FAILED',
        'PackageType' => 'TXT-DICTIONARY',
    ],
]

Result Details

Members

PackageDetails

Type: PackageDetails structure

Information about the package PackageDetails.

Errors

BaseException:
An error occurred while processing the request.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
LimitExceededException:
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
AccessDeniedException:
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.

UpgradeElasticsearchDomain

$result = $client->upgradeElasticsearchDomain([/* ... */]);
$promise = $client->upgradeElasticsearchDomainAsync([/* ... */]);

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Parameter Syntax

$result = $client->upgradeElasticsearchDomain([
    'DomainName' => '<string>', // REQUIRED
    'PerformCheckOnly' => true || false,
    'TargetVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainName

Required: Yes
Type: string

PerformCheckOnly

Type: boolean

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

TargetVersion

Required: Yes
Type: string

The version of Elasticsearch that you intend to upgrade the domain to.

Result Syntax

[
    'DomainName' => '<string>',
    'PerformCheckOnly' => true || false,
    'TargetVersion' => '<string>',
]

Result Details

Members

DomainName

Type: string

PerformCheckOnly

Type: boolean

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

TargetVersion

Type: string

The version of Elasticsearch that you intend to upgrade the domain to.

Errors

BaseException:
An error occurred while processing the request.
ResourceNotFoundException:
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ResourceAlreadyExistsException:
An exception for creating a resource that already exists. Gives http status code of 400.
DisabledOperationException:
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
ValidationException:
An exception for missing / invalid input fields. Gives http status code of 400.
InternalException:
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

Shapes

AccessDeniedException

Description

An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

Members

AccessPoliciesStatus

Description

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

Members

Options

Required: Yes
Type: string

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

Status

Required: Yes
Type: OptionStatus structure

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

AdditionalLimit

Description

List of limits that are specific to a given InstanceType and for each of it's InstanceRole .

Members

LimitName

Type: string

Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc.
Attributes and their details:

MaximumNumberOfDataNodesSupported

ESPartitionInstanceType

MaximumNumberOfDataNodesWithoutMasterNode

ESPartitionInstanceType

LimitValues

Type: Array of strings

Value for given AdditionalLimit$LimitName .

AdvancedOptionsStatus

Description

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

Members

Options

Required: Yes
Type: Associative array of custom strings keys (String) to strings

Specifies the status of advanced options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

AdvancedSecurityOptions

Description

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

Members

Enabled

Type: boolean

True if advanced security is enabled.

InternalUserDatabaseEnabled

Type: boolean

True if the internal user database is enabled.

SAMLOptions

Type: SAMLOptionsOutput structure

Describes the SAML application configured for a domain.

AdvancedSecurityOptionsInput

Description

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

Members

Enabled

Type: boolean

True if advanced security is enabled.

InternalUserDatabaseEnabled

Type: boolean

True if the internal user database is enabled.

MasterUserOptions

Type: MasterUserOptions structure

Credentials for the master user: username and password, ARN, or both.

SAMLOptions

Type: SAMLOptionsInput structure

Specifies the SAML application configuration for the domain.

AdvancedSecurityOptionsStatus

Description

Specifies the status of advanced security options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: AdvancedSecurityOptions structure

Specifies advanced security options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Status of the advanced security options for the specified Elasticsearch domain.

AutoTune

Description

Specifies Auto-Tune type and Auto-Tune action details.

Members

AutoTuneDetails

Type: AutoTuneDetails structure

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

AutoTuneType

Type: string

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails

Description

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

Members

ScheduledAutoTuneDetails

Type: ScheduledAutoTuneDetails structure

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

AutoTuneMaintenanceSchedule

Description

Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.

Members

CronExpressionForRecurrence

Type: string

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

Duration

Type: Duration structure

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

StartAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies timestamp at which Auto-Tune maintenance schedule start.

AutoTuneOptions

Description

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

Members

DesiredState

Type: string

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

MaintenanceSchedules

Type: Array of AutoTuneMaintenanceSchedule structures

Specifies list of maitenance schedules. See the Developer Guide for more information.

RollbackOnDisable

Type: string

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

AutoTuneOptionsInput

Description

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

Members

DesiredState

Type: string

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

MaintenanceSchedules

Type: Array of AutoTuneMaintenanceSchedule structures

Specifies list of maitenance schedules. See the Developer Guide for more information.

AutoTuneOptionsOutput

Description

Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

Members

ErrorMessage

Type: string

Specifies the error message while enabling or disabling the Auto-Tune.

State

Type: string

Specifies the AutoTuneState for the Elasticsearch domain.

AutoTuneOptionsStatus

Description

Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

Members

Options

Type: AutoTuneOptions structure

Specifies Auto-Tune options for the specified Elasticsearch domain.

Status

Type: AutoTuneStatus structure

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

AutoTuneStatus

Description

Provides the current status of the Auto-Tune options.

Members

CreationDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells Auto-Tune options creation date .

ErrorMessage

Type: string

Specifies the error message while enabling or disabling the Auto-Tune options.

PendingDeletion

Type: boolean

Indicates whether the Elasticsearch domain is being deleted.

State

Required: Yes
Type: string

Specifies the AutoTuneState for the Elasticsearch domain.

UpdateDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells Auto-Tune options last updated time.

UpdateVersion

Type: int

Specifies the Auto-Tune options latest version.

BaseException

Description

An error occurred while processing the request.

Members

message

Type: string

A description of the error.

CognitoOptions

Description

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

Members

Enabled

Type: boolean

Specifies the option to enable Cognito for Kibana authentication.

IdentityPoolId

Type: string

Specifies the Cognito identity pool ID for Kibana authentication.

RoleArn

Type: string

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

UserPoolId

Type: string

Specifies the Cognito user pool ID for Kibana authentication.

CognitoOptionsStatus

Description

Status of the Cognito options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: CognitoOptions structure

Specifies the Cognito options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the Cognito options for the specified Elasticsearch domain.

ColdStorageOptions

Description

Specifies settings for cold storage.

Members

Enabled

Required: Yes
Type: boolean

True to enable cold storage for an Elasticsearch domain.

CompatibleVersionsMap

Description

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

Members

SourceVersion

Type: string

The current version of Elasticsearch on which a domain is.

TargetVersions

Type: Array of strings

List of supported elastic search versions.

ConflictException

Description

An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

Members

DescribePackagesFilter

Description

Filter to apply in DescribePackage response.

Members

Name

Type: string

Any field from PackageDetails.

Value

Type: Array of strings

A list of values for the specified field.

DisabledOperationException

Description

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

Members

DomainEndpointOptions

Description

Options to configure endpoint for the Elasticsearch domain.

Members

CustomEndpoint

Type: string

Specify the fully qualified domain for your custom endpoint.

CustomEndpointCertificateArn

Type: string

Specify ACM certificate ARN for your custom endpoint.

CustomEndpointEnabled

Type: boolean

Specify if custom endpoint should be enabled for the Elasticsearch domain.

EnforceHTTPS

Type: boolean

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

TLSSecurityPolicy

Type: string

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

DomainEndpointOptionsStatus

Description

The configured endpoint options for the domain and their current status.

Members

Options

Required: Yes
Type: DomainEndpointOptions structure

Options to configure endpoint for the Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.

DomainInfo

Members

DomainName

Type: string

Specifies the DomainName.

DomainInformation

Members

DomainName

Required: Yes
Type: string

OwnerId

Type: string

Region

Type: string

DomainPackageDetails

Description

Information on a package that is associated with a domain.

Members

DomainName

Type: string

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

DomainPackageStatus

Type: string

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

ErrorDetails

Type: ErrorDetails structure

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

LastUpdated

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

PackageID

Type: string

Internal ID of the package.

PackageName

Type: string

User specified name of the package.

PackageType

Type: string

Currently supports only TXT-DICTIONARY.

PackageVersion

Type: string

ReferencePath

Type: string

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

Duration

Description

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

Members

Unit

Type: string

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

Value

Type: long (int|float)

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

EBSOptions

Description

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

Members

EBSEnabled

Type: boolean

Specifies whether EBS-based storage is enabled.

Iops

Type: int

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

VolumeSize

Type: int

Integer to specify the size of an EBS volume.

VolumeType

Type: string

Specifies the volume type for EBS-based storage.

EBSOptionsStatus

Description

Status of the EBS options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: EBSOptions structure

Specifies the EBS options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the EBS options for the specified Elasticsearch domain.

ElasticsearchClusterConfig

Description

Specifies the configuration for the domain cluster, such as the type and number of instances.

Members

ColdStorageOptions

Type: ColdStorageOptions structure

Specifies the ColdStorageOptions configuration for an Elasticsearch domain.

DedicatedMasterCount

Type: int

Total number of dedicated master nodes, active and on standby, for the cluster.

DedicatedMasterEnabled

Type: boolean

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

DedicatedMasterType

Type: string

The instance type for a dedicated master node.

InstanceCount

Type: int

The number of instances in the specified domain cluster.

InstanceType

Type: string

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

WarmCount

Type: int

The number of warm nodes in the cluster.

WarmEnabled

Type: boolean

True to enable warm storage.

WarmType

Type: string

The instance type for the Elasticsearch cluster's warm nodes.

ZoneAwarenessConfig

Type: ZoneAwarenessConfig structure

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

ZoneAwarenessEnabled

Type: boolean

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

ElasticsearchClusterConfigStatus

Description

Specifies the configuration status for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: ElasticsearchClusterConfig structure

Specifies the cluster configuration for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the configuration for the specified Elasticsearch domain.

ElasticsearchDomainConfig

Description

The configuration of an Elasticsearch domain.

Members

AccessPolicies

Type: AccessPoliciesStatus structure

IAM access policy as a JSON-formatted string.

AdvancedOptions

Type: AdvancedOptionsStatus structure

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

AdvancedSecurityOptions

Type: AdvancedSecurityOptionsStatus structure

Specifies AdvancedSecurityOptions for the domain.

AutoTuneOptions

Type: AutoTuneOptionsStatus structure

Specifies AutoTuneOptions for the domain.

CognitoOptions

Type: CognitoOptionsStatus structure

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

DomainEndpointOptions

Type: DomainEndpointOptionsStatus structure

Specifies the DomainEndpointOptions for the Elasticsearch domain.

EBSOptions

Type: EBSOptionsStatus structure

Specifies the EBSOptions for the Elasticsearch domain.

ElasticsearchClusterConfig

Type: ElasticsearchClusterConfigStatus structure

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

ElasticsearchVersion

Type: ElasticsearchVersionStatus structure

String of format X.Y to specify version for the Elasticsearch domain.

EncryptionAtRestOptions

Type: EncryptionAtRestOptionsStatus structure

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

LogPublishingOptions

Type: LogPublishingOptionsStatus structure

Log publishing options for the given domain.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptionsStatus structure

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

SnapshotOptions

Type: SnapshotOptionsStatus structure

Specifies the SnapshotOptions for the Elasticsearch domain.

VPCOptions

Type: VPCDerivedInfoStatus structure

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

ElasticsearchDomainStatus

Description

The current status of an Elasticsearch domain.

Members

ARN

Required: Yes
Type: string

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

AccessPolicies

Type: string

IAM access policy as a JSON-formatted string.

AdvancedOptions

Type: Associative array of custom strings keys (String) to strings

Specifies the status of the AdvancedOptions

AdvancedSecurityOptions

Type: AdvancedSecurityOptions structure

The current status of the Elasticsearch domain's advanced security options.

AutoTuneOptions

Type: AutoTuneOptionsOutput structure

The current status of the Elasticsearch domain's Auto-Tune options.

CognitoOptions

Type: CognitoOptions structure

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Created

Type: boolean

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

Deleted

Type: boolean

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

DomainEndpointOptions

Type: DomainEndpointOptions structure

The current status of the Elasticsearch domain's endpoint options.

DomainId

Required: Yes
Type: string

The unique identifier for the specified Elasticsearch domain.

DomainName

Required: Yes
Type: string

EBSOptions

Type: EBSOptions structure

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

ElasticsearchClusterConfig

Required: Yes
Type: ElasticsearchClusterConfig structure

The type and number of instances in the domain cluster.

ElasticsearchVersion

Type: string

EncryptionAtRestOptions

Type: EncryptionAtRestOptions structure

Specifies the status of the EncryptionAtRestOptions.

Endpoint

Type: string

The Elasticsearch domain endpoint that you use to submit index and search requests.

Endpoints

Type: Associative array of custom strings keys (String) to strings

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

LogPublishingOptions

Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

Log publishing options for the given domain.

NodeToNodeEncryptionOptions

Type: NodeToNodeEncryptionOptions structure

Specifies the status of the NodeToNodeEncryptionOptions.

Processing

Type: boolean

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

ServiceSoftwareOptions

Type: ServiceSoftwareOptions structure

The current status of the Elasticsearch domain's service software.

SnapshotOptions

Type: SnapshotOptions structure

Specifies the status of the SnapshotOptions

UpgradeProcessing

Type: boolean

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

VPCOptions

Type: VPCDerivedInfo structure

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

ElasticsearchVersionStatus

Description

Status of the Elasticsearch version options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: string

Specifies the Elasticsearch version for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

EncryptionAtRestOptions

Description

Specifies the Encryption At Rest Options.

Members

Enabled

Type: boolean

Specifies the option to enable Encryption At Rest.

KmsKeyId

Type: string

Specifies the KMS Key ID for Encryption At Rest options.

EncryptionAtRestOptionsStatus

Description

Status of the Encryption At Rest options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: EncryptionAtRestOptions structure

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

ErrorDetails

Members

ErrorMessage

Type: string

ErrorType

Type: string

Filter

Description

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.

Members

Name

Type: string

Specifies the name of the filter.

Values

Type: Array of strings

Contains one or more values for the filter.

InboundCrossClusterSearchConnection

Description

Specifies details of an inbound connection.

Members

ConnectionStatus

Type: InboundCrossClusterSearchConnectionStatus structure

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

CrossClusterSearchConnectionId

Type: string

Specifies the connection id for the inbound cross-cluster search connection.

DestinationDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the destination Elasticsearch domain.

SourceDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the source Elasticsearch domain.

InboundCrossClusterSearchConnectionStatus

Description

Specifies the coonection status of an inbound cross-cluster search connection.

Members

Message

Type: string

Specifies verbose information for the inbound connection status.

StatusCode

Type: string

The state code for inbound connection. This can be one of the following:

PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
APPROVED: Inbound connection is pending acceptance by destination domain owner.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and cannot be used further.

InstanceCountLimits

Description

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

Members

MaximumInstanceCount

Type: int

Maximum number of Instances that can be instantiated for given InstanceType.

MinimumInstanceCount

Type: int

Minimum number of Instances that can be instantiated for given InstanceType.

InstanceLimits

Description

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

Members

InstanceCountLimits

Type: InstanceCountLimits structure

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

InternalException

Description

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

Members

InvalidPaginationTokenException

Description

The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.

Members

InvalidTypeException

Description

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

Members

LimitExceededException

Description

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

Members

Limits

Description

Limits for given InstanceType and for each of it's role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

Members

AdditionalLimits

Type: Array of AdditionalLimit structures

List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole .

InstanceLimits

Type: InstanceLimits structure

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

StorageTypes

Type: Array of StorageType structures

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

LogPublishingOption

Description

Log Publishing option that is set for given domain.
Attributes and their details:

CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
Enabled: Whether the log publishing for given log type is enabled or not

Members

CloudWatchLogsLogGroupArn

Type: string

ARN of the Cloudwatch log group to which log needs to be published.

Enabled

Type: boolean

Specifies whether given log publishing option is enabled or not.

LogPublishingOptionsStatus

Description

The configured log publishing options for the domain and their current status.

Members

Options

Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures

The log publishing options configured for the Elasticsearch domain.

Status

Type: OptionStatus structure

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.

MasterUserOptions

Description

Credentials for the master user: username and password, ARN, or both.

Members

MasterUserARN

Type: string

ARN for the master user (if IAM is enabled).

MasterUserName

Type: string

The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.

MasterUserPassword

Type: string

The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.

NodeToNodeEncryptionOptions

Description

Specifies the node-to-node encryption options.

Members

Enabled

Type: boolean

Specify true to enable node-to-node encryption.

NodeToNodeEncryptionOptionsStatus

Description

Status of the node-to-node encryption options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: NodeToNodeEncryptionOptions structure

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

OptionStatus

Description

Provides the current status of the entity.

Members

CreationDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells the creation date for the entity.

PendingDeletion

Type: boolean

Indicates whether the Elasticsearch domain is being deleted.

State

Required: Yes
Type: string

Provides the OptionState for the Elasticsearch domain.

UpdateDate

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells the last updated time for the entity.

UpdateVersion

Type: int

Specifies the latest version for the entity.

OutboundCrossClusterSearchConnection

Description

Specifies details of an outbound connection.

Members

ConnectionAlias

Type: string

Specifies the connection alias for the outbound cross-cluster search connection.

ConnectionStatus

Type: OutboundCrossClusterSearchConnectionStatus structure

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

CrossClusterSearchConnectionId

Type: string

Specifies the connection id for the outbound cross-cluster search connection.

DestinationDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the destination Elasticsearch domain.

SourceDomainInfo

Type: DomainInformation structure

Specifies the DomainInformation for the source Elasticsearch domain.

OutboundCrossClusterSearchConnectionStatus

Description

Specifies the connection status of an outbound cross-cluster search connection.

Members

Message

Type: string

Specifies verbose information for the outbound connection status.

StatusCode

Type: string

The state code for outbound connection. This can be one of the following:

VALIDATING: The outbound connection request is being validated.
VALIDATION_FAILED: Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner.
PROVISIONING: Outbound connection request is in process.
ACTIVE: Outbound connection is active and ready to use.
REJECTED: Outbound connection request is rejected by destination domain owner.
DELETING: Outbound connection deletion is in progress.
DELETED: Outbound connection is deleted and cannot be used further.

PackageDetails

Description

Basic information about a package.

Members

AvailablePackageVersion

Type: string

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells creation date of the package.

ErrorDetails

Type: ErrorDetails structure

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

LastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

PackageDescription

Type: string

User-specified description of the package.

PackageID

Type: string

Internal ID of the package.

PackageName

Type: string

User specified name of the package.

PackageStatus

Type: string

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

PackageType

Type: string

Currently supports only TXT-DICTIONARY.

PackageSource

Description

The S3 location for importing the package specified as S3BucketName and S3Key

Members

S3BucketName

Type: string

Name of the bucket containing the package.

S3Key

Type: string

Key (file name) of the package.

PackageVersionHistory

Description

Details of a package version.

Members

CommitMessage

Type: string

A message associated with the version.

CreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp which tells creation time of the package version.

PackageVersion

Type: string

Version of the package.

RecurringCharge

Description

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

Members

RecurringChargeAmount

Type: double

The monetary amount of the recurring charge.

RecurringChargeFrequency

Type: string

The frequency of the recurring charge.

ReservedElasticsearchInstance

Description

Details of a reserved Elasticsearch instance.

Members

CurrencyCode

Type: string

The currency code for the reserved Elasticsearch instance offering.

Duration

Type: int

The duration, in seconds, for which the Elasticsearch instance is reserved.

ElasticsearchInstanceCount

Type: int

The number of Elasticsearch instances that have been reserved.

ElasticsearchInstanceType

Type: string

The Elasticsearch instance type offered by the reserved instance offering.

FixedPrice

Type: double

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

PaymentOption

Type: string

The payment option as defined in the reserved Elasticsearch instance offering.

RecurringCharges

Type: Array of RecurringCharge structures

The charge to your account regardless of whether you are creating any domains using the instance offering.

ReservationName

Type: string

The customer-specified identifier to track this reservation.

ReservedElasticsearchInstanceId

Type: string

The unique identifier for the reservation.

ReservedElasticsearchInstanceOfferingId

Type: string

The offering identifier.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the reservation started.

State

Type: string

The state of the reserved Elasticsearch instance.

UsagePrice

Type: double

The rate you are charged for each hour for the domain that is using this reserved instance.

ReservedElasticsearchInstanceOffering

Description

Details of a reserved Elasticsearch instance offering.

Members

CurrencyCode

Type: string

The currency code for the reserved Elasticsearch instance offering.

Duration

Type: int

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

ElasticsearchInstanceType

Type: string

The Elasticsearch instance type offered by the reserved instance offering.

FixedPrice

Type: double

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

PaymentOption

Type: string

Payment option for the reserved Elasticsearch instance offering

RecurringCharges

Type: Array of RecurringCharge structures

The charge to your account regardless of whether you are creating any domains using the instance offering.

ReservedElasticsearchInstanceOfferingId

Type: string

The Elasticsearch reserved instance offering identifier.

UsagePrice

Type: double

The rate you are charged for each hour the domain that is using the offering is running.

ResourceAlreadyExistsException

Description

An exception for creating a resource that already exists. Gives http status code of 400.

Members

ResourceNotFoundException

Description

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

Members

SAMLIdp

Description

Specifies the SAML Identity Provider's information.

Members

EntityId

Required: Yes
Type: string

The unique Entity ID of the application in SAML Identity Provider.

MetadataContent

Required: Yes
Type: string

The Metadata of the SAML application in xml format.

SAMLOptionsInput

Description

Specifies the SAML application configuration for the domain.

Members

Enabled

Type: boolean

True if SAML is enabled.

Idp

Type: SAMLIdp structure

Specifies the SAML Identity Provider's information.

MasterBackendRole

Type: string

The backend role to which the SAML master user is mapped to.

MasterUserName

Type: string

The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.

RolesKey

Type: string

The key to use for matching the SAML Roles attribute.

SessionTimeoutMinutes

Type: int

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

SubjectKey

Type: string

The key to use for matching the SAML Subject attribute.

SAMLOptionsOutput

Description

Describes the SAML application configured for the domain.

Members

Enabled

Type: boolean

True if SAML is enabled.

Idp

Type: SAMLIdp structure

Describes the SAML Identity Provider's information.

RolesKey

Type: string

The key used for matching the SAML Roles attribute.

SessionTimeoutMinutes

Type: int

The duration, in minutes, after which a user session becomes inactive.

SubjectKey

Type: string

The key used for matching the SAML Subject attribute.

ScheduledAutoTuneDetails

Description

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

Members

Action

Type: string

Specifies Auto-Tune action description.

ActionType

Type: string

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

Date

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies timestamp for the Auto-Tune action scheduled for the domain.

Severity

Type: string

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

ServiceSoftwareOptions

Description

The current options of an Elasticsearch domain service software options.

Members

AutomatedUpdateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

Cancellable

Type: boolean

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

CurrentVersion

Type: string

The current service software version that is present on the domain.

Description

Type: string

The description of the UpdateStatus.

NewVersion

Type: string

The new service software version if one is available.

OptionalDeployment

Type: boolean

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

UpdateAvailable

Type: boolean

True if you are able to update you service software version. False if you are not able to update your service software version.

UpdateStatus

Type: string

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

SnapshotOptions

Description

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

Members

AutomatedSnapshotStartHour

Type: int

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

SnapshotOptionsStatus

Description

Status of a daily automated snapshot.

Members

Options

Required: Yes
Type: SnapshotOptions structure

Specifies the daily snapshot options specified for the Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of a daily automated snapshot.

StorageType

Description

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

Members

StorageSubTypeName

Type: string

SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes

standard
gp2
io1

Refer VolumeType for more information regarding above EBS storage options.

StorageTypeLimits

Type: Array of StorageTypeLimit structures

List of limits that are applicable for given storage type.

StorageTypeName

Type: string

Type of the storage. List of available storage options:

instance
ebs

StorageTypeLimit

Description

Limits that are applicable for given storage type.

Members

LimitName

Type: string

Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable

MinimumVolumeSize
MaximumVolumeSize
MaximumIops
MinimumIops

LimitValues

Type: Array of strings

Values for the StorageTypeLimit$LimitName .

Tag

Description

Specifies a key value pair for a resource tag.

Members

Key

Required: Yes
Type: string

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

Value

Required: Yes
Type: string

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

UpgradeHistory

Description

History of the last 10 Upgrades and Upgrade Eligibility Checks.

Members

StartTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

StepsList

Type: Array of UpgradeStepItem structures

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

UpgradeName

Type: string

A string that describes the update briefly

UpgradeStatus

Type: string

The overall status of the update. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

UpgradeStepItem

Description

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

Members

Issues

Type: Array of strings

A list of strings containing detailed information about the errors encountered in a particular step.

ProgressPercent

Type: double

The Floating point value representing progress percentage of a particular step.

UpgradeStep

Type: string

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

PreUpgradeCheck
Snapshot
Upgrade

UpgradeStepStatus

Type: string

The status of a particular step during an upgrade. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

VPCDerivedInfo

Description

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Members

AvailabilityZones

Type: Array of strings

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

SecurityGroupIds

Type: Array of strings

Specifies the security groups for VPC endpoint.

SubnetIds

Type: Array of strings

Specifies the subnets for VPC endpoint.

VPCId

Type: string

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

VPCDerivedInfoStatus

Description

Status of the VPC options for the specified Elasticsearch domain.

Members

Options

Required: Yes
Type: VPCDerivedInfo structure

Specifies the VPC options for the specified Elasticsearch domain.

Status

Required: Yes
Type: OptionStatus structure

Specifies the status of the VPC options for the specified Elasticsearch domain.

VPCOptions

Description

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Members

SecurityGroupIds

Type: Array of strings

Specifies the security groups for VPC endpoint.

SubnetIds

Type: Array of strings

Specifies the subnets for VPC endpoint.

ValidationException

Description

An exception for missing / invalid input fields. Gives http status code of 400.

Members

ZoneAwarenessConfig

Description

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

Members

AvailabilityZoneCount

Type: int

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Elasticsearch Service 2015-01-01

Operation Summary

Paginators

Operations

AcceptInboundCrossClusterSearchConnection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddTags

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

AssociatePackage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelElasticsearchServiceSoftwareUpdate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateElasticsearchDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateOutboundCrossClusterSearchConnection

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePackage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteElasticsearchDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteElasticsearchServiceRole

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors