Amazon Elasticsearch Service 2015-01-01
- 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 */).
- AddTags ( array $params = [] )
Attaches tags to an existing Elasticsearch domain.
- CreateElasticsearchDomain ( array $params = [] )
Creates a new Elasticsearch domain.
- 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.
- 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.
- DescribeReservedElasticsearchInstanceOfferings ( array $params = [] )
Lists available reserved Elasticsearch instance offerings.
- DescribeReservedElasticsearchInstances ( array $params = [] )
Returns information about reserved Elasticsearch instances for this account.
- GetCompatibleElasticsearchVersions ( array $params = [] )
Returns a list of upgrade compatible Elastisearch versions.
- 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.
- ListElasticsearchInstanceTypes ( array $params = [] )
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
- ListElasticsearchVersions ( array $params = [] )
List all supported Elasticsearch versions
- ListTags ( array $params = [] )
Returns all tags for the given Elasticsearch domain.
- PurchaseReservedElasticsearchInstanceOffering ( array $params = [] )
Allows you to purchase reserved Elasticsearch instances.
- RemoveTags ( array $params = [] )
Removes the specified set of tags from the specified Elasticsearch domain.
- UpdateElasticsearchDomainConfig ( array $params = [] )
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
- 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:
Operations
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
-
- Type: string
Specify the
ARNfor which you want to add the tags. - TagList
-
- Type: Array of Tag structures
List of
Tagthat need to be added for the Elasticsearch domain.
Result Syntax
[]
Result Details
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.
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>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'DomainName' => '<string>', // REQUIRED
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'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
Option to allow references to indices in an HTTP request body. Must be
falsewhen configuring access to individual sub-resources. By default, the value istrue. See Configuration Advanced Options for more information. - 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.
- DomainName
-
- 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 letter or number 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
LogTypeandLogPublishingOption, each containing options to publish a given type of Elasticsearch log. - SnapshotOptions
-
- Type: SnapshotOptions structure
Option to set time, in UTC format, of 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
[
'DomainStatus' => [
'ARN' => '<string>',
'AccessPolicies' => '<string>',
'AdvancedOptions' => ['<string>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'Created' => true || false,
'Deleted' => true || false,
'DomainId' => '<string>',
'DomainName' => '<string>',
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'Enabled' => true || false,
],
// ...
],
'Processing' => true || false,
'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 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.
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
Result Syntax
[
'DomainStatus' => [
'ARN' => '<string>',
'AccessPolicies' => '<string>',
'AdvancedOptions' => ['<string>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'Created' => true || false,
'Deleted' => true || false,
'DomainId' => '<string>',
'DomainName' => '<string>',
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'Enabled' => true || false,
],
// ...
],
'Processing' => true || false,
'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 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
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.
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
Result Syntax
[
'DomainStatus' => [
'ARN' => '<string>',
'AccessPolicies' => '<string>',
'AdvancedOptions' => ['<string>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'Created' => true || false,
'Deleted' => true || false,
'DomainId' => '<string>',
'DomainName' => '<string>',
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'Enabled' => true || false,
],
// ...
],
'Processing' => true || false,
'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
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>,
],
],
'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>,
],
],
'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' => [
'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|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|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',
'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>,
],
],
'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
-
- Type: ElasticsearchDomainConfig structure
The configuration information of the domain requested in the
DescribeElasticsearchDomainConfigrequest.
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
Result Syntax
[
'DomainStatusList' => [
[
'ARN' => '<string>',
'AccessPolicies' => '<string>',
'AdvancedOptions' => ['<string>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'Created' => true || false,
'Deleted' => true || false,
'DomainId' => '<string>',
'DomainName' => '<string>',
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'ElasticsearchVersion' => '<string>',
'EncryptionAtRestOptions' => [
'Enabled' => true || false,
'KmsKeyId' => '<string>',
],
'Endpoint' => '<string>',
'Endpoints' => ['<string>', ...],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'Enabled' => true || false,
],
// ...
],
'Processing' => true || false,
'SnapshotOptions' => [
'AutomatedSnapshotStartHour' => <integer>,
],
'UpgradeProcessing' => true || false,
'VPCOptions' => [
'AvailabilityZones' => ['<string>', ...],
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VPCId' => '<string>',
],
],
// ...
],
]
Result Details
Members
- DomainStatusList
-
- Type: Array of ElasticsearchDomainStatus structures
The status of the domains requested in the
DescribeElasticsearchDomainsrequest.
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|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
Limitsfor existing domain. - ElasticsearchVersion
-
- Type: string
Version of Elasticsearch for which
Limitsare needed. - InstanceType
-
- Type: string
The instance type for an Elasticsearch cluster for which Elasticsearch
Limitsare 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
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.
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|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|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.
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
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
GetCompatibleElasticsearchVersionsoperation.
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.
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
-
- 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).
- 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
UpgradeHistoryobjects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part ofGetUpgradeHistoryResponseobject.
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
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
GetUpgradeStatusResponseobject. 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.
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
-
- 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
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.
ListTags
$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
Result Syntax
[
'TagList' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- TagList
-
- Type: Array of Tag structures
List of
Tagfor 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
Result Syntax
[
'ReservationName' => '<string>',
'ReservedElasticsearchInstanceId' => '<string>',
]
Result Details
Members
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.
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
Result Syntax
[]
Result Details
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.
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>', ...],
'CognitoOptions' => [
'Enabled' => true || false,
'IdentityPoolId' => '<string>',
'RoleArn' => '<string>',
'UserPoolId' => '<string>',
],
'DomainName' => '<string>', // REQUIRED
'EBSOptions' => [
'EBSEnabled' => true || false,
'Iops' => <integer>,
'VolumeSize' => <integer>,
'VolumeType' => 'standard|gp2|io1',
],
'ElasticsearchClusterConfig' => [
'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|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|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',
'ZoneAwarenessEnabled' => true || false,
],
'LogPublishingOptions' => [
'<LogType>' => [
'CloudWatchLogsLogGroupArn' => '<string>',
'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
falsewhen configuring access to individual sub-resources. By default, the value istrue. See Configuration Advanced Options for more information. - 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.
- DomainName
-
- 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.
- LogPublishingOptions
-
- Type: Associative array of custom strings keys (LogType) to LogPublishingOption structures
Map of
LogTypeandLogPublishingOption, each containing options to publish a given type of Elasticsearch log. - SnapshotOptions
-
- Type: SnapshotOptions structure
Option to set the time, in UTC format, for the daily automated snapshot. Default value is
0hours. - 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>,
],
],
'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>,
],
],
'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' => [
'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|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|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',
'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>,
],
],
'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
-
- 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.
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
-
- 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).
- 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.
Result Syntax
[
'DomainName' => '<string>',
'PerformCheckOnly' => true || false,
'TargetVersion' => '<string>',
]
Result 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).
- 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
AccessPoliciesStatus
Description
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
Members
- Options
-
- 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
OptionStatusfor 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
InstanceRoleetc.
Attributes and their details:
- MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much data nodes upto which given
- MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given
ESPartitionInstanceTypecan support as master node.ESPartitionInstanceTypeupto which you don't need any master nodes to govern them. - 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
falsewhen configuring access to individual sub-resources. By default, the value istrue. 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
-
- 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
OptionStatusfor advanced options for the specified Elasticsearch domain.
BaseException
Description
An error occurred while processing the request.
Members
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
-
- 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.
CompatibleVersionsMap
Description
A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
Members
DisabledOperationException
Description
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
Members
DomainInfo
EBSOptions
Description
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
Members
EBSOptionsStatus
Description
Status of the EBS options for the specified Elasticsearch domain.
Members
- Options
-
- 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
- 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.
- 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
-
- 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
-
- Required: Yes
- Type: AccessPoliciesStatus structure
IAM access policy as a JSON-formatted string.
- AdvancedOptions
-
- Required: Yes
- Type: AdvancedOptionsStatus structure
Specifies the
AdvancedOptionsfor the domain. See Configuring Advanced Options for more information. - CognitoOptions
-
- Required: Yes
- Type: CognitoOptionsStatus structure
The
CognitoOptionsfor the specified domain. For more information, see Amazon Cognito Authentication for Kibana. - EBSOptions
-
- Required: Yes
- Type: EBSOptionsStatus structure
Specifies the
EBSOptionsfor the Elasticsearch domain. - ElasticsearchClusterConfig
-
- Required: Yes
- Type: ElasticsearchClusterConfigStatus structure
Specifies the
ElasticsearchClusterConfigfor the Elasticsearch domain. - ElasticsearchVersion
-
- Required: Yes
- Type: ElasticsearchVersionStatus structure
String of format X.Y to specify version for the Elasticsearch domain.
- EncryptionAtRestOptions
-
- Required: Yes
- Type: EncryptionAtRestOptionsStatus structure
Specifies the
EncryptionAtRestOptionsfor the Elasticsearch domain. - LogPublishingOptions
-
- Type: LogPublishingOptionsStatus structure
Log publishing options for the given domain.
- SnapshotOptions
-
- Required: Yes
- Type: SnapshotOptionsStatus structure
Specifies the
SnapshotOptionsfor the Elasticsearch domain. - VPCOptions
-
- Required: Yes
- Type: VPCDerivedInfoStatus structure
The
VPCOptionsfor 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
-
- 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 - CognitoOptions
-
- Type: CognitoOptions structure
The
CognitoOptionsfor the specified domain. For more information, see Amazon Cognito Authentication for Kibana. - Created
-
- Type: boolean
The domain creation status.
Trueif the creation of an Elasticsearch domain is complete.Falseif domain creation is still in progress. - Deleted
-
- Type: boolean
The domain deletion status.
Trueif a delete request has been received for the domain but resource cleanup is still in progress.Falseif the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned. - DomainId
-
- Type: string
The unique identifier for the specified Elasticsearch domain.
- 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).
- EBSOptions
-
- Type: EBSOptions structure
The
EBSOptionsfor the specified domain. See Configuring EBS-based Storage for more information. - ElasticsearchClusterConfig
-
- 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.
- Processing
-
- Type: boolean
The status of the Elasticsearch domain configuration.
Trueif Amazon Elasticsearch Service is processing configuration changes.Falseif the configuration is active. - SnapshotOptions
-
- Type: SnapshotOptions structure
Specifies the status of the
SnapshotOptions - UpgradeProcessing
-
- Type: boolean
The status of an Elasticsearch domain version upgrade.
Trueif Amazon Elasticsearch Service is undergoing a version upgrade.Falseif the configuration is active. - VPCOptions
-
- Type: VPCDerivedInfo structure
The
VPCOptionsfor 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
-
- 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
EncryptionAtRestOptionsStatus
Description
Status of the Encryption At Rest options for the specified Elasticsearch domain.
Members
- Options
-
- 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.
InstanceCountLimits
Description
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
Members
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
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
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
-
- Required: Yes
- Type: OptionStatus structure
The status of the log publishing options for the Elasticsearch domain. See
OptionStatusfor the status information that's included.
OptionStatus
Description
Provides the current status of the entity.
Members
- CreationDate
-
- 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
-
- Type: string
Provides the
OptionStatefor the Elasticsearch domain. - UpdateDate
-
- 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.
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
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
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
SnapshotOptionsStatus
Description
Status of a daily automated snapshot.
Members
- Options
-
- 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
VolumeTypefor 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 Inbuilt storage available for the given Instance
- ebs Elastic block storage that would be attached to the given Instance
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
StorageTypeis ebs, following storage options are applicable- MinimumVolumeSize Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
- MaximumVolumeSize Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
- MaximumIops Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
- MinimumIops Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
- LimitValues
-
- Type: Array of strings
Values for the
StorageTypeLimit$LimitName.
Tag
Description
Specifies a key value pair for a resource tag.
Members
- Key
-
- 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
-
- 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 ofproject : Trinityandcost-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
UpgradeStepItems 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
-
- 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
ValidationException
Description
An exception for missing / invalid input fields. Gives http status code of 400.
