Table of Contents
ElasticsearchService.Client¶A low-level client representing Amazon Elasticsearch Service
Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs .
The endpoint for configuration service requests is region-specific: es.*region* .amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints .
import boto3
client = boto3.client('es')
These are the available methods:
accept_inbound_cross_cluster_search_connection()add_tags()associate_package()can_paginate()cancel_elasticsearch_service_software_update()close()create_elasticsearch_domain()create_outbound_cross_cluster_search_connection()create_package()delete_elasticsearch_domain()delete_elasticsearch_service_role()delete_inbound_cross_cluster_search_connection()delete_outbound_cross_cluster_search_connection()delete_package()describe_domain_auto_tunes()describe_domain_change_progress()describe_elasticsearch_domain()describe_elasticsearch_domain_config()describe_elasticsearch_domains()describe_elasticsearch_instance_type_limits()describe_inbound_cross_cluster_search_connections()describe_outbound_cross_cluster_search_connections()describe_packages()describe_reserved_elasticsearch_instance_offerings()describe_reserved_elasticsearch_instances()dissociate_package()get_compatible_elasticsearch_versions()get_package_version_history()get_paginator()get_upgrade_history()get_upgrade_status()get_waiter()list_domain_names()list_domains_for_package()list_elasticsearch_instance_types()list_elasticsearch_versions()list_packages_for_domain()list_tags()purchase_reserved_elasticsearch_instance_offering()reject_inbound_cross_cluster_search_connection()remove_tags()start_elasticsearch_service_software_update()update_elasticsearch_domain_config()update_package()upgrade_elasticsearch_domain()accept_inbound_cross_cluster_search_connection(**kwargs)¶Allows the destination domain owner to accept an inbound cross-cluster search connection request.
See also: AWS API Documentation
Request Syntax
response = client.accept_inbound_cross_cluster_search_connection(
CrossClusterSearchConnectionId='string'
)
[REQUIRED]
The id of the inbound connection that you want to accept.
{
'CrossClusterSearchConnection': {
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
}
}
Response Structure
The result of a `` AcceptInboundCrossClusterSearchConnection`` operation. Contains details of accepted inbound connection.
Specifies the `` InboundCrossClusterSearchConnection`` of accepted inbound connection.
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
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).
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
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).
Specifies the connection id for the inbound cross-cluster search connection.
Specifies the `` InboundCrossClusterSearchConnectionStatus`` for the outbound connection.
The state code for inbound connection. This can be one of the following:
Specifies verbose information for the inbound connection status.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionAttaches 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.
See also: AWS API Documentation
Request Syntax
response = client.add_tags(
ARN='string',
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specify the ARN for which you want to add the tags.
[REQUIRED]
List of Tag that need to be added for the Elasticsearch domain.
Specifies a key value pair for a resource tag.
Specifies the TagKey , the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
Specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
None
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionassociate_package(**kwargs)¶Associates a package with an Amazon ES domain.
See also: AWS API Documentation
Request Syntax
response = client.associate_package(
PackageID='string',
DomainName='string'
)
[REQUIRED]
Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
[REQUIRED]
Name of the domain that you want to associate the package with.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for response returned by `` AssociatePackage `` operation.
DomainPackageDetails (dict) --
DomainPackageDetails
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
LastUpdated (datetime) --
Timestamp of the most-recent update to the association status.
DomainName (string) --
Name of the domain you've associated a package with.
DomainPackageStatus (string) --
State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
PackageVersion (string) --
ReferencePath (string) --
The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.ConflictExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_elasticsearch_service_software_update(**kwargs)¶Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
See also: AWS API Documentation
Request Syntax
response = client.cancel_elasticsearch_service_software_update(
DomainName='string'
)
[REQUIRED]
The name of the domain that you want to stop the latest service software update on.
{
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
}
}
Response Structure
The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
The current status of the Elasticsearch service software update.
The current service software version that is present on the domain.
The new service software version if one is available.
True if you are able to update you service software version. False if you are not able to update your service software version.
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
The description of the UpdateStatus .
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionclose()¶Closes underlying endpoint connections.
create_elasticsearch_domain(**kwargs)¶Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_elasticsearch_domain(
DomainName='string',
ElasticsearchVersion='string',
ElasticsearchClusterConfig={
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
EBSOptions={
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
AccessPolicies='string',
SnapshotOptions={
'AutomatedSnapshotStartHour': 123
},
VPCOptions={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
CognitoOptions={
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
EncryptionAtRestOptions={
'Enabled': True|False,
'KmsKeyId': 'string'
},
NodeToNodeEncryptionOptions={
'Enabled': True|False
},
AdvancedOptions={
'string': 'string'
},
LogPublishingOptions={
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
DomainEndpointOptions={
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
AdvancedSecurityOptions={
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'MasterUserOptions': {
'MasterUserARN': 'string',
'MasterUserName': 'string',
'MasterUserPassword': 'string'
},
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'MasterUserName': 'string',
'MasterBackendRole': 'string',
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthEnabled': True|False
},
AutoTuneOptions={
'DesiredState': 'ENABLED'|'DISABLED',
'MaintenanceSchedules': [
{
'StartAt': datetime(2015, 1, 1),
'Duration': {
'Value': 123,
'Unit': 'HOURS'
},
'CronExpressionForRecurrence': 'string'
},
]
},
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
Options to enable, disable and specify the type and size of EBS storage volumes.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
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
Specifies the subnets for VPC endpoint.
Specifies the security groups for VPC endpoint.
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Specifies the Encryption At Rest Options.
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies the NodeToNodeEncryptionOptions.
Specify true to enable node-to-node encryption.
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Configuration Advanced Options for more information.
Map of LogType and LogPublishingOption , each containing options to publish a given type of Elasticsearch log.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
Options to specify configuration that will be applied to the domain endpoint.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
Specifies advanced security options.
True if advanced security is enabled.
True if the internal user database is enabled.
Credentials for the master user: username and password, ARN, or both.
ARN for the master user (if IAM is enabled).
The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.
The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.
Specifies the SAML application configuration for the domain.
True if SAML is enabled.
Specifies the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.
The backend role to which the SAML master user is mapped to.
The key to use for matching the SAML Subject attribute.
The key to use for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Specifies Auto-Tune options.
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
Specifies list of maitenance schedules. See the Developer Guide for more information.
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
Specifies timestamp at which Auto-Tune maintenance schedule start.
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
A list of Tag added during domain creation.
Specifies a key value pair for a resource tag.
Specifies the TagKey , the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
Specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
dict
Response Syntax
{
'DomainStatus': {
'DomainId': 'string',
'DomainName': 'string',
'ARN': 'string',
'Created': True|False,
'Deleted': True|False,
'Endpoint': 'string',
'Endpoints': {
'string': 'string'
},
'Processing': True|False,
'UpgradeProcessing': True|False,
'ElasticsearchVersion': 'string',
'ElasticsearchClusterConfig': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'EBSOptions': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'AccessPolicies': 'string',
'SnapshotOptions': {
'AutomatedSnapshotStartHour': 123
},
'VPCOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CognitoOptions': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'EncryptionAtRestOptions': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'NodeToNodeEncryptionOptions': {
'Enabled': True|False
},
'AdvancedOptions': {
'string': 'string'
},
'LogPublishingOptions': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
},
'DomainEndpointOptions': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'AdvancedSecurityOptions': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'AutoTuneOptions': {
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
(dict) --
The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.
DomainStatus (dict) --
The status of the newly created Elasticsearch domain.
DomainId (string) --
The unique identifier for the specified Elasticsearch domain.
DomainName (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).
ARN (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.
Created (boolean) --
The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
Deleted (boolean) --
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Endpoint (string) --
The Elasticsearch domain endpoint that you use to submit index and search requests.
Endpoints (dict) --
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' .
(string) --
(string) --
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
Processing (boolean) --
The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing (boolean) --
The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
ElasticsearchVersion (string) --
ElasticsearchClusterConfig (dict) --
The type and number of instances in the domain cluster.
InstanceType (string) --
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
ZoneAwarenessConfig (dict) --
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable warm storage.
WarmType (string) --
The instance type for the Elasticsearch cluster's warm nodes.
WarmCount (integer) --
The number of warm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
EBSOptions (dict) --
The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
EBSEnabled (boolean) --
Specifies whether EBS-based storage is enabled.
VolumeType (string) --
Specifies the volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Throughput (integer) --
Specifies the Throughput for GP3 EBS volume (SSD).
AccessPolicies (string) --
IAM access policy as a JSON-formatted string.
SnapshotOptions (dict) --
Specifies the status of the SnapshotOptions
AutomatedSnapshotStartHour (integer) --
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
VPCId (string) --
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
SubnetIds (list) --
Specifies the subnets for VPC endpoint.
AvailabilityZones (list) --
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
SecurityGroupIds (list) --
Specifies the security groups for VPC endpoint.
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Enabled (boolean) --
Specifies the option to enable Cognito for Kibana authentication.
UserPoolId (string) --
Specifies the Cognito user pool ID for Kibana authentication.
IdentityPoolId (string) --
Specifies the Cognito identity pool ID for Kibana authentication.
RoleArn (string) --
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
EncryptionAtRestOptions (dict) --
Specifies the status of the EncryptionAtRestOptions .
Enabled (boolean) --
Specifies the option to enable Encryption At Rest.
KmsKeyId (string) --
Specifies the KMS Key ID for Encryption At Rest options.
NodeToNodeEncryptionOptions (dict) --
Specifies the status of the NodeToNodeEncryptionOptions .
Enabled (boolean) --
Specify true to enable node-to-node encryption.
AdvancedOptions (dict) --
Specifies the status of the AdvancedOptions
LogPublishingOptions (dict) --
Log publishing options for the given domain.
(string) --
Type of Log File, it can be one of the following:
(dict) --
Log Publishing option that is set for given domain. Attributes and their details:
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to which log needs to be published.
Enabled (boolean) --
Specifies whether given log publishing option is enabled or not.
ServiceSoftwareOptions (dict) --
The current status of the Elasticsearch domain's service software.
CurrentVersion (string) --
The current service software version that is present on the domain.
NewVersion (string) --
The new service software version if one is available.
UpdateAvailable (boolean) --
True if you are able to update you service software version. False if you are not able to update your service software version.
Cancellable (boolean) --
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
UpdateStatus (string) --
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
Description (string) --
The description of the UpdateStatus .
AutomatedUpdateDate (datetime) --
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment (boolean) --
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
DomainEndpointOptions (dict) --
The current status of the Elasticsearch domain's endpoint options.
EnforceHTTPS (boolean) --
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
CustomEndpointEnabled (boolean) --
Specify if custom endpoint should be enabled for the Elasticsearch domain.
CustomEndpoint (string) --
Specify the fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
Specify ACM certificate ARN for your custom endpoint.
AdvancedSecurityOptions (dict) --
The current status of the Elasticsearch domain's advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
Enabled (boolean) --
True if SAML is enabled.
Idp (dict) --
Describes the SAML Identity Provider's information.
MetadataContent (string) --
The Metadata of the SAML application in xml format.
EntityId (string) --
The unique Entity ID of the application in SAML Identity Provider.
SubjectKey (string) --
The key used for matching the SAML Subject attribute.
RolesKey (string) --
The key used for matching the SAML Roles attribute.
SessionTimeoutMinutes (integer) --
The duration, in minutes, after which a user session becomes inactive.
AnonymousAuthDisableDate (datetime) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AutoTuneOptions (dict) --
The current status of the Elasticsearch domain's Auto-Tune options.
State (string) --
Specifies the AutoTuneState for the Elasticsearch domain.
ErrorMessage (string) --
Specifies the error message while enabling or disabling the Auto-Tune.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.InvalidTypeExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.ResourceAlreadyExistsExceptionElasticsearchService.Client.exceptions.ValidationExceptioncreate_outbound_cross_cluster_search_connection(**kwargs)¶Creates a new cross-cluster search connection from a source domain to a destination domain.
See also: AWS API Documentation
Request Syntax
response = client.create_outbound_cross_cluster_search_connection(
SourceDomainInfo={
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
DestinationDomainInfo={
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
ConnectionAlias='string'
)
[REQUIRED]
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
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).
[REQUIRED]
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
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).
[REQUIRED]
Specifies the connection alias that will be used by the customer for this connection.
dict
Response Syntax
{
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'CrossClusterSearchConnectionId': 'string'
}
Response Structure
(dict) --
The result of a `` CreateOutboundCrossClusterSearchConnection`` request. Contains the details of the newly created cross-cluster search connection.
SourceDomainInfo (dict) --
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
DestinationDomainInfo (dict) --
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
ConnectionAlias (string) --
Specifies the connection alias provided during the create connection request.
ConnectionStatus (dict) --
Specifies the `` OutboundCrossClusterSearchConnectionStatus`` for the newly created connection.
StatusCode (string) --
The state code for outbound connection. This can be one of the following:
Message (string) --
Specifies verbose information for the outbound connection status.
CrossClusterSearchConnectionId (string) --
Unique id for the created outbound connection, which is used for subsequent operations on connection.
Exceptions
ElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceAlreadyExistsExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptioncreate_package(**kwargs)¶Create a package for use with Amazon ES domains.
See also: AWS API Documentation
Request Syntax
response = client.create_package(
PackageName='string',
PackageType='TXT-DICTIONARY',
PackageDescription='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
}
)
[REQUIRED]
Unique identifier for the package.
[REQUIRED]
Type of package. Currently supports only TXT-DICTIONARY.
[REQUIRED]
The customer S3 location PackageSource for importing the package.
Name of the bucket containing the package.
Key (file name) of the package.
dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for response returned by `` CreatePackage `` operation.
PackageDetails (dict) --
Information about the package PackageDetails .
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
CreatedAt (datetime) --
Timestamp which tells creation date of the package.
LastUpdatedAt (datetime) --
AvailablePackageVersion (string) --
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.InvalidTypeExceptionElasticsearchService.Client.exceptions.ResourceAlreadyExistsExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptiondelete_elasticsearch_domain(**kwargs)¶Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
See also: AWS API Documentation
Request Syntax
response = client.delete_elasticsearch_domain(
DomainName='string'
)
[REQUIRED]
The name of the Elasticsearch domain that you want to permanently delete.
{
'DomainStatus': {
'DomainId': 'string',
'DomainName': 'string',
'ARN': 'string',
'Created': True|False,
'Deleted': True|False,
'Endpoint': 'string',
'Endpoints': {
'string': 'string'
},
'Processing': True|False,
'UpgradeProcessing': True|False,
'ElasticsearchVersion': 'string',
'ElasticsearchClusterConfig': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'EBSOptions': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'AccessPolicies': 'string',
'SnapshotOptions': {
'AutomatedSnapshotStartHour': 123
},
'VPCOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CognitoOptions': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'EncryptionAtRestOptions': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'NodeToNodeEncryptionOptions': {
'Enabled': True|False
},
'AdvancedOptions': {
'string': 'string'
},
'LogPublishingOptions': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
},
'DomainEndpointOptions': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'AdvancedSecurityOptions': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'AutoTuneOptions': {
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.
The status of the Elasticsearch domain being deleted.
The unique identifier for the specified Elasticsearch domain.
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).
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
The Elasticsearch domain endpoint that you use to submit index and search requests.
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' .
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
The type and number of instances in the domain cluster.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
IAM access policy as a JSON-formatted string.
Specifies the status of the SnapshotOptions
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the subnets for VPC endpoint.
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the security groups for VPC endpoint.
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Specifies the status of the EncryptionAtRestOptions .
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies the status of the NodeToNodeEncryptionOptions .
Specify true to enable node-to-node encryption.
Specifies the status of the AdvancedOptions
Log publishing options for the given domain.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
The current status of the Elasticsearch domain's service software.
The current service software version that is present on the domain.
The new service software version if one is available.
True if you are able to update you service software version. False if you are not able to update your service software version.
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
The description of the UpdateStatus .
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
The current status of the Elasticsearch domain's endpoint options.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
The current status of the Elasticsearch domain's advanced security options.
True if advanced security is enabled.
True if the internal user database is enabled.
Describes the SAML application configured for a domain.
True if SAML is enabled.
Describes the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The key used for matching the SAML Subject attribute.
The key used for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
The current status of the Elasticsearch domain's Auto-Tune options.
Specifies the AutoTuneState for the Elasticsearch domain.
Specifies the error message while enabling or disabling the Auto-Tune.
Specifies change details of the domain configuration change.
The unique change identifier associated with a specific domain configuration change.
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondelete_elasticsearch_service_role()¶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 .
See also: AWS API Documentation
Request Syntax
response = client.delete_elasticsearch_service_role()
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ValidationExceptiondelete_inbound_cross_cluster_search_connection(**kwargs)¶Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_inbound_cross_cluster_search_connection(
CrossClusterSearchConnectionId='string'
)
[REQUIRED]
The id of the inbound connection that you want to permanently delete.
{
'CrossClusterSearchConnection': {
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
}
}
Response Structure
The result of a `` DeleteInboundCrossClusterSearchConnection`` operation. Contains details of deleted inbound connection.
Specifies the `` InboundCrossClusterSearchConnection`` of deleted inbound connection.
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
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).
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
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).
Specifies the connection id for the inbound cross-cluster search connection.
Specifies the `` InboundCrossClusterSearchConnectionStatus`` for the outbound connection.
The state code for inbound connection. This can be one of the following:
Specifies verbose information for the inbound connection status.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptiondelete_outbound_cross_cluster_search_connection(**kwargs)¶Allows the source domain owner to delete an existing outbound cross-cluster search connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_outbound_cross_cluster_search_connection(
CrossClusterSearchConnectionId='string'
)
[REQUIRED]
The id of the outbound connection that you want to permanently delete.
{
'CrossClusterSearchConnection': {
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
}
}
Response Structure
The result of a `` DeleteOutboundCrossClusterSearchConnection`` operation. Contains details of deleted outbound connection.
Specifies the `` OutboundCrossClusterSearchConnection`` of deleted outbound connection.
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
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).
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
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).
Specifies the connection id for the outbound cross-cluster search connection.
Specifies the connection alias for the outbound cross-cluster search connection.
Specifies the `` OutboundCrossClusterSearchConnectionStatus`` for the outbound connection.
The state code for outbound connection. This can be one of the following:
Specifies verbose information for the outbound connection status.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptiondelete_package(**kwargs)¶Delete the package.
See also: AWS API Documentation
Request Syntax
response = client.delete_package(
PackageID='string'
)
[REQUIRED]
Internal ID of the package that you want to delete. Use DescribePackages to find this value.
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
Container for response parameters to `` DeletePackage `` operation.
PackageDetails
Internal ID of the package.
User specified name of the package.
Currently supports only TXT-DICTIONARY.
User-specified description of the package.
Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
Timestamp which tells creation date of the package.
Additional information if the package is in an error state. Null otherwise.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.ConflictExceptiondescribe_domain_auto_tunes(**kwargs)¶Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_auto_tunes(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Specifies the domain name for which you want Auto-Tune action details.
dict
Response Syntax
{
'AutoTunes': [
{
'AutoTuneType': 'SCHEDULED_ACTION',
'AutoTuneDetails': {
'ScheduledAutoTuneDetails': {
'Date': datetime(2015, 1, 1),
'ActionType': 'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
'Action': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.
AutoTunes (list) --
Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.
(dict) --
Specifies Auto-Tune type and Auto-Tune action details.
AutoTuneType (string) --
Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
AutoTuneDetails (dict) --
Specifies details of the Auto-Tune action. See the Developer Guide for more information.
ScheduledAutoTuneDetails (dict) --
Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.
Date (datetime) --
Specifies timestamp for the Auto-Tune action scheduled for the domain.
ActionType (string) --
Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
Action (string) --
Specifies Auto-Tune action description.
Severity (string) --
Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
NextToken (string) --
Specifies an identifier to allow retrieval of paginated results.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_domain_change_progress(**kwargs)¶Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_change_progress(
DomainName='string',
ChangeId='string'
)
[REQUIRED]
The domain you want to get the progress information about.
dict
Response Syntax
{
'ChangeProgressStatus': {
'ChangeId': 'string',
'StartTime': datetime(2015, 1, 1),
'Status': 'PENDING'|'PROCESSING'|'COMPLETED'|'FAILED',
'PendingProperties': [
'string',
],
'CompletedProperties': [
'string',
],
'TotalNumberOfStages': 123,
'ChangeProgressStages': [
{
'Name': 'string',
'Status': 'string',
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
The result of a DescribeDomainChangeProgress request. Contains the progress information of the requested domain change.
ChangeProgressStatus (dict) --
Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
StartTime (datetime) --
The time at which the configuration change is made on the domain.
Status (string) --
The overall status of the domain configuration change. This field can take the following values: PENDING , PROCESSING , COMPLETED and FAILED
PendingProperties (list) --
The list of properties involved in the domain configuration change that are still in pending.
CompletedProperties (list) --
The list of properties involved in the domain configuration change that are completed.
TotalNumberOfStages (integer) --
The total number of stages required for the configuration change.
ChangeProgressStages (list) --
The specific stages that the domain is going through to perform the configuration change.
(dict) --
A progress stage details of a specific domain configuration change.
Name (string) --
The name of the specific progress stage.
Status (string) --
The overall status of a specific progress stage.
Description (string) --
The description of the progress stage.
LastUpdated (datetime) --
The last updated timestamp of the progress stage.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_elasticsearch_domain(**kwargs)¶Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
See also: AWS API Documentation
Request Syntax
response = client.describe_elasticsearch_domain(
DomainName='string'
)
[REQUIRED]
The name of the Elasticsearch domain for which you want information.
{
'DomainStatus': {
'DomainId': 'string',
'DomainName': 'string',
'ARN': 'string',
'Created': True|False,
'Deleted': True|False,
'Endpoint': 'string',
'Endpoints': {
'string': 'string'
},
'Processing': True|False,
'UpgradeProcessing': True|False,
'ElasticsearchVersion': 'string',
'ElasticsearchClusterConfig': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'EBSOptions': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'AccessPolicies': 'string',
'SnapshotOptions': {
'AutomatedSnapshotStartHour': 123
},
'VPCOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CognitoOptions': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'EncryptionAtRestOptions': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'NodeToNodeEncryptionOptions': {
'Enabled': True|False
},
'AdvancedOptions': {
'string': 'string'
},
'LogPublishingOptions': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
},
'DomainEndpointOptions': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'AdvancedSecurityOptions': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'AutoTuneOptions': {
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.
The current status of the Elasticsearch domain.
The unique identifier for the specified Elasticsearch domain.
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).
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
The Elasticsearch domain endpoint that you use to submit index and search requests.
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' .
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
The type and number of instances in the domain cluster.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
IAM access policy as a JSON-formatted string.
Specifies the status of the SnapshotOptions
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the subnets for VPC endpoint.
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the security groups for VPC endpoint.
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Specifies the status of the EncryptionAtRestOptions .
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies the status of the NodeToNodeEncryptionOptions .
Specify true to enable node-to-node encryption.
Specifies the status of the AdvancedOptions
Log publishing options for the given domain.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
The current status of the Elasticsearch domain's service software.
The current service software version that is present on the domain.
The new service software version if one is available.
True if you are able to update you service software version. False if you are not able to update your service software version.
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
The description of the UpdateStatus .
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
The current status of the Elasticsearch domain's endpoint options.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
The current status of the Elasticsearch domain's advanced security options.
True if advanced security is enabled.
True if the internal user database is enabled.
Describes the SAML application configured for a domain.
True if SAML is enabled.
Describes the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The key used for matching the SAML Subject attribute.
The key used for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
The current status of the Elasticsearch domain's Auto-Tune options.
Specifies the AutoTuneState for the Elasticsearch domain.
Specifies the error message while enabling or disabling the Auto-Tune.
Specifies change details of the domain configuration change.
The unique change identifier associated with a specific domain configuration change.
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_elasticsearch_domain_config(**kwargs)¶Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
See also: AWS API Documentation
Request Syntax
response = client.describe_elasticsearch_domain_config(
DomainName='string'
)
[REQUIRED]
The Elasticsearch domain that you want to get information about.
{
'DomainConfig': {
'ElasticsearchVersion': {
'Options': 'string',
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'ElasticsearchClusterConfig': {
'Options': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'EBSOptions': {
'Options': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AccessPolicies': {
'Options': 'string',
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'SnapshotOptions': {
'Options': {
'AutomatedSnapshotStartHour': 123
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'VPCOptions': {
'Options': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'CognitoOptions': {
'Options': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'EncryptionAtRestOptions': {
'Options': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'NodeToNodeEncryptionOptions': {
'Options': {
'Enabled': True|False
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AdvancedOptions': {
'Options': {
'string': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'LogPublishingOptions': {
'Options': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'DomainEndpointOptions': {
'Options': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AdvancedSecurityOptions': {
'Options': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AutoTuneOptions': {
'Options': {
'DesiredState': 'ENABLED'|'DISABLED',
'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
'MaintenanceSchedules': [
{
'StartAt': datetime(2015, 1, 1),
'Duration': {
'Value': 123,
'Unit': 'HOURS'
},
'CronExpressionForRecurrence': 'string'
},
]
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string',
'PendingDeletion': True|False
}
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.
The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.
String of format X.Y to specify version for the Elasticsearch domain.
Specifies the Elasticsearch version for the specified Elasticsearch domain.
Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
Specifies the cluster configuration for the specified Elasticsearch domain.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
Specifies the status of the configuration for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the EBSOptions for the Elasticsearch domain.
Specifies the EBS options for the specified Elasticsearch domain.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
Specifies the status of the EBS options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
IAM access policy as a JSON-formatted string.
The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policies for more information.
The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the SnapshotOptions for the Elasticsearch domain.
Specifies the daily snapshot options specified for the Elasticsearch domain.
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
Specifies the status of a daily automated snapshot.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
Specifies the VPC options for the specified Elasticsearch domain.
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the subnets for VPC endpoint.
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the security groups for VPC endpoint.
Specifies the status of the VPC options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the Cognito options for the specified Elasticsearch domain.
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Specifies the status of the Cognito options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
Specifies the Encryption At Rest options for the specified Elasticsearch domain.
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
Specifies the node-to-node encryption options for the specified Elasticsearch domain.
Specify true to enable node-to-node encryption.
Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
Specifies the status of advanced options for the specified Elasticsearch domain.
Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Log publishing options for the given domain.
The log publishing options configured for the Elasticsearch domain.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies the DomainEndpointOptions for the Elasticsearch domain.
Options to configure endpoint for the Elasticsearch domain.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies AdvancedSecurityOptions for the domain.
Specifies advanced security options for the specified Elasticsearch domain.
True if advanced security is enabled.
True if the internal user database is enabled.
Describes the SAML application configured for a domain.
True if SAML is enabled.
Describes the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The key used for matching the SAML Subject attribute.
The key used for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Status of the advanced security options for the specified Elasticsearch domain.
Timestamp which tells the creation date for the entity.
Timestamp which tells the last updated time for the entity.
Specifies the latest version for the entity.
Provides the OptionState for the Elasticsearch domain.
Indicates whether the Elasticsearch domain is being deleted.
Specifies AutoTuneOptions for the domain.
Specifies Auto-Tune options for the specified Elasticsearch domain.
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
Specifies list of maitenance schedules. See the Developer Guide for more information.
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
Specifies timestamp at which Auto-Tune maintenance schedule start.
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.
Timestamp which tells Auto-Tune options creation date .
Timestamp which tells Auto-Tune options last updated time.
Specifies the Auto-Tune options latest version.
Specifies the AutoTuneState for the Elasticsearch domain.
Specifies the error message while enabling or disabling the Auto-Tune options.
Indicates whether the Elasticsearch domain is being deleted.
Specifies change details of the domain configuration change.
The unique change identifier associated with a specific domain configuration change.
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_elasticsearch_domains(**kwargs)¶Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
See also: AWS API Documentation
Request Syntax
response = client.describe_elasticsearch_domains(
DomainNames=[
'string',
]
)
[REQUIRED]
The Elasticsearch domains for which you want information.
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).
{
'DomainStatusList': [
{
'DomainId': 'string',
'DomainName': 'string',
'ARN': 'string',
'Created': True|False,
'Deleted': True|False,
'Endpoint': 'string',
'Endpoints': {
'string': 'string'
},
'Processing': True|False,
'UpgradeProcessing': True|False,
'ElasticsearchVersion': 'string',
'ElasticsearchClusterConfig': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'EBSOptions': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'AccessPolicies': 'string',
'SnapshotOptions': {
'AutomatedSnapshotStartHour': 123
},
'VPCOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'CognitoOptions': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'EncryptionAtRestOptions': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'NodeToNodeEncryptionOptions': {
'Enabled': True|False
},
'AdvancedOptions': {
'string': 'string'
},
'LogPublishingOptions': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
},
'DomainEndpointOptions': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'AdvancedSecurityOptions': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'AutoTuneOptions': {
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
},
]
}
Response Structure
The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.
The status of the domains requested in the DescribeElasticsearchDomains request.
The current status of an Elasticsearch domain.
The unique identifier for the specified Elasticsearch domain.
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).
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
The Elasticsearch domain endpoint that you use to submit index and search requests.
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' .
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
The type and number of instances in the domain cluster.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
IAM access policy as a JSON-formatted string.
Specifies the status of the SnapshotOptions
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the subnets for VPC endpoint.
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
Specifies the security groups for VPC endpoint.
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Specifies the status of the EncryptionAtRestOptions .
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies the status of the NodeToNodeEncryptionOptions .
Specify true to enable node-to-node encryption.
Specifies the status of the AdvancedOptions
Log publishing options for the given domain.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
The current status of the Elasticsearch domain's service software.
The current service software version that is present on the domain.
The new service software version if one is available.
True if you are able to update you service software version. False if you are not able to update your service software version.
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
The description of the UpdateStatus .
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
The current status of the Elasticsearch domain's endpoint options.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
The current status of the Elasticsearch domain's advanced security options.
True if advanced security is enabled.
True if the internal user database is enabled.
Describes the SAML application configured for a domain.
True if SAML is enabled.
Describes the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The key used for matching the SAML Subject attribute.
The key used for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
The current status of the Elasticsearch domain's Auto-Tune options.
Specifies the AutoTuneState for the Elasticsearch domain.
Specifies the error message while enabling or disabling the Auto-Tune.
Specifies change details of the domain configuration change.
The unique change identifier associated with a specific domain configuration change.
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_elasticsearch_instance_type_limits(**kwargs)¶Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the `` DomainName `` to know what Limits are supported for modifying.
See also: AWS API Documentation
Request Syntax
response = client.describe_elasticsearch_instance_type_limits(
DomainName='string',
InstanceType='m3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
ElasticsearchVersion='string'
)
[REQUIRED]
The instance type for an Elasticsearch cluster for which Elasticsearch `` Limits `` are needed.
[REQUIRED]
Version of Elasticsearch for which `` Limits `` are needed.
dict
Response Syntax
{
'LimitsByRole': {
'string': {
'StorageTypes': [
{
'StorageTypeName': 'string',
'StorageSubTypeName': 'string',
'StorageTypeLimits': [
{
'LimitName': 'string',
'LimitValues': [
'string',
]
},
]
},
],
'InstanceLimits': {
'InstanceCountLimits': {
'MinimumInstanceCount': 123,
'MaximumInstanceCount': 123
}
},
'AdditionalLimits': [
{
'LimitName': 'string',
'LimitValues': [
'string',
]
},
]
}
}
}
Response Structure
(dict) --
Container for the parameters received from `` DescribeElasticsearchInstanceTypeLimits `` operation.
LimitsByRole (dict) --
Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:
(string) --
(dict) --
Limits for given InstanceType and for each of it's role. Limits contains following `` StorageTypes, `` `` InstanceLimits `` and `` AdditionalLimits ``
StorageTypes (list) --
StorageType represents the list of storage related types and attributes that are available for given InstanceType.
(dict) --
StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
StorageTypeName (string) --
Type of the storage. List of available storage options:
Inbuilt storage available for the given Instance * ebs Elastic block storage that would be attached to the given Instance
StorageSubTypeName (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
Refer `` VolumeType`` for more information regarding above EBS storage options.
StorageTypeLimits (list) --
List of limits that are applicable for given storage type.
(dict) --
Limits that are applicable for given storage type.
LimitName (string) --
Name of storage limits that are applicable for given storage type. If `` StorageType `` is ebs, following storage options are applicable
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. * MaximumThroughput Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable. * MinimumThroughput Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
LimitValues (list) --
Values for the `` StorageTypeLimit$LimitName `` .
InstanceLimits (dict) --
InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
InstanceCountLimits (dict) --
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
MinimumInstanceCount (integer) --
Minimum number of Instances that can be instantiated for given InstanceType.
MaximumInstanceCount (integer) --
Maximum number of Instances that can be instantiated for given InstanceType.
AdditionalLimits (list) --
List of additional limits that are specific to a given InstanceType and for each of it's `` InstanceRole `` .
(dict) --
List of limits that are specific to a given InstanceType and for each of it's `` InstanceRole `` .
LimitName (string) --
Name of Additional Limit is specific to a given InstanceType and for each of it's `` InstanceRole `` etc. Attributes and their details:
This attribute will be present in Master node only to specify how much data nodes upto which given `` ESPartitionInstanceType `` can support as master node. * MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given `` ESPartitionInstanceType `` upto which you don't need any master nodes to govern them.
LimitValues (list) --
Value for given `` AdditionalLimit$LimitName `` .
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.InvalidTypeExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_inbound_cross_cluster_search_connections(**kwargs)¶Lists all the inbound cross-cluster search connections for a destination domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_inbound_cross_cluster_search_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
A list of filters used to match properties for inbound cross-cluster search connection. Available `` Filter`` names for this operation are:
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
Specifies the name of the filter.
Contains one or more values for the filter.
dict
Response Syntax
{
'CrossClusterSearchConnections': [
{
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result of a `` DescribeInboundCrossClusterSearchConnections`` request. Contains the list of connections matching the filter criteria.
CrossClusterSearchConnections (list) --
Consists of list of `` InboundCrossClusterSearchConnection`` matching the specified filter criteria.
(dict) --
Specifies details of an inbound connection.
SourceDomainInfo (dict) --
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
DestinationDomainInfo (dict) --
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
CrossClusterSearchConnectionId (string) --
Specifies the connection id for the inbound cross-cluster search connection.
ConnectionStatus (dict) --
Specifies the `` InboundCrossClusterSearchConnectionStatus`` for the outbound connection.
StatusCode (string) --
The state code for inbound connection. This can be one of the following:
Message (string) --
Specifies verbose information for the inbound connection status.
NextToken (string) --
If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
Exceptions
ElasticsearchService.Client.exceptions.InvalidPaginationTokenExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptiondescribe_outbound_cross_cluster_search_connections(**kwargs)¶Lists all the outbound cross-cluster search connections for a source domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_outbound_cross_cluster_search_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
A list of filters used to match properties for outbound cross-cluster search connection. Available `` Filter`` names for this operation are:
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
Specifies the name of the filter.
Contains one or more values for the filter.
dict
Response Syntax
{
'CrossClusterSearchConnections': [
{
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result of a `` DescribeOutboundCrossClusterSearchConnections`` request. Contains the list of connections matching the filter criteria.
CrossClusterSearchConnections (list) --
Consists of list of `` OutboundCrossClusterSearchConnection`` matching the specified filter criteria.
(dict) --
Specifies details of an outbound connection.
SourceDomainInfo (dict) --
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
DestinationDomainInfo (dict) --
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
OwnerId (string) --
DomainName (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).
Region (string) --
CrossClusterSearchConnectionId (string) --
Specifies the connection id for the outbound cross-cluster search connection.
ConnectionAlias (string) --
Specifies the connection alias for the outbound cross-cluster search connection.
ConnectionStatus (dict) --
Specifies the `` OutboundCrossClusterSearchConnectionStatus`` for the outbound connection.
StatusCode (string) --
The state code for outbound connection. This can be one of the following:
Message (string) --
Specifies verbose information for the outbound connection status.
NextToken (string) --
If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
Exceptions
ElasticsearchService.Client.exceptions.InvalidPaginationTokenExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptiondescribe_packages(**kwargs)¶Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_packages(
Filters=[
{
'Name': 'PackageID'|'PackageName'|'PackageStatus',
'Value': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
Only returns packages that match the DescribePackagesFilterList values.
Filter to apply in DescribePackage response.
Any field from PackageDetails .
A list of values for the specified field.
dict
Response Syntax
{
'PackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response returned by `` DescribePackages `` operation.
PackageDetailsList (list) --
List of PackageDetails objects.
(dict) --
Basic information about a package.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
CreatedAt (datetime) --
Timestamp which tells creation date of the package.
LastUpdatedAt (datetime) --
AvailablePackageVersion (string) --
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
NextToken (string) --
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptiondescribe_reserved_elasticsearch_instance_offerings(**kwargs)¶Lists available reserved Elasticsearch instance offerings.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_elasticsearch_instance_offerings(
ReservedElasticsearchInstanceOfferingId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ReservedElasticsearchInstanceOfferings': [
{
'ReservedElasticsearchInstanceOfferingId': 'string',
'ElasticsearchInstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results from DescribeReservedElasticsearchInstanceOfferings
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
ReservedElasticsearchInstanceOfferings (list) --
List of reserved Elasticsearch instance offerings
(dict) --
Details of a reserved Elasticsearch instance offering.
ReservedElasticsearchInstanceOfferingId (string) --
The Elasticsearch reserved instance offering identifier.
ElasticsearchInstanceType (string) --
The Elasticsearch instance type offered by the reserved instance offering.
Duration (integer) --
The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
FixedPrice (float) --
The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
UsagePrice (float) --
The rate you are charged for each hour the domain that is using the offering is running.
CurrencyCode (string) --
The currency code for the reserved Elasticsearch instance offering.
PaymentOption (string) --
Payment option for the reserved Elasticsearch instance offering
RecurringCharges (list) --
The charge to your account regardless of whether you are creating any domains using the instance offering.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.InternalExceptiondescribe_reserved_elasticsearch_instances(**kwargs)¶Returns information about reserved Elasticsearch instances for this account.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_elasticsearch_instances(
ReservedElasticsearchInstanceId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ReservedElasticsearchInstances': [
{
'ReservationName': 'string',
'ReservedElasticsearchInstanceId': 'string',
'ReservedElasticsearchInstanceOfferingId': 'string',
'ElasticsearchInstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'ElasticsearchInstanceCount': 123,
'State': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results from DescribeReservedElasticsearchInstances
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
ReservedElasticsearchInstances (list) --
List of reserved Elasticsearch instances.
(dict) --
Details of a reserved Elasticsearch instance.
ReservationName (string) --
The customer-specified identifier to track this reservation.
ReservedElasticsearchInstanceId (string) --
The unique identifier for the reservation.
ReservedElasticsearchInstanceOfferingId (string) --
The offering identifier.
ElasticsearchInstanceType (string) --
The Elasticsearch instance type offered by the reserved instance offering.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration, in seconds, for which the Elasticsearch instance is reserved.
FixedPrice (float) --
The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
UsagePrice (float) --
The rate you are charged for each hour for the domain that is using this reserved instance.
CurrencyCode (string) --
The currency code for the reserved Elasticsearch instance offering.
ElasticsearchInstanceCount (integer) --
The number of Elasticsearch instances that have been reserved.
State (string) --
The state of the reserved Elasticsearch instance.
PaymentOption (string) --
The payment option as defined in the reserved Elasticsearch instance offering.
RecurringCharges (list) --
The charge to your account regardless of whether you are creating any domains using the instance offering.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptiondissociate_package(**kwargs)¶Dissociates a package from the Amazon ES domain.
See also: AWS API Documentation
Request Syntax
response = client.dissociate_package(
PackageID='string',
DomainName='string'
)
[REQUIRED]
Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
[REQUIRED]
Name of the domain that you want to associate the package with.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for response returned by `` DissociatePackage `` operation.
DomainPackageDetails (dict) --
DomainPackageDetails
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
LastUpdated (datetime) --
Timestamp of the most-recent update to the association status.
DomainName (string) --
Name of the domain you've associated a package with.
DomainPackageStatus (string) --
State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
PackageVersion (string) --
ReferencePath (string) --
The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.ConflictExceptionget_compatible_elasticsearch_versions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_compatible_elasticsearch_versions(
DomainName='string'
)
{
'CompatibleElasticsearchVersions': [
{
'SourceVersion': 'string',
'TargetVersions': [
'string',
]
},
]
}
Response Structure
Container for response returned by `` GetCompatibleElasticsearchVersions `` operation.
A map of compatible Elasticsearch versions returned as part of the `` GetCompatibleElasticsearchVersions `` operation.
A map from an `` ElasticsearchVersion `` to a list of compatible `` ElasticsearchVersion `` s to which the domain can be upgraded.
The current version of Elasticsearch on which a domain is.
List of supported elastic search versions.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionget_package_version_history(**kwargs)¶Returns a list of versions of the package, along with their creation time and commit message.
See also: AWS API Documentation
Request Syntax
response = client.get_package_version_history(
PackageID='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Returns an audit history of versions of the package.
dict
Response Syntax
{
'PackageID': 'string',
'PackageVersionHistoryList': [
{
'PackageVersion': 'string',
'CommitMessage': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response returned by `` GetPackageVersionHistory `` operation.
PackageID (string) --
PackageVersionHistoryList (list) --
List of PackageVersionHistory objects.
(dict) --
Details of a package version.
PackageVersion (string) --
Version of the package.
CommitMessage (string) --
A message associated with the version.
CreatedAt (datetime) --
Timestamp which tells creation time of the package version.
NextToken (string) --
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_upgrade_history(**kwargs)¶Retrieves the complete history of the last 10 upgrades that were performed on the domain.
See also: AWS API Documentation
Request Syntax
response = client.get_upgrade_history(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
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).
dict
Response Syntax
{
'UpgradeHistories': [
{
'UpgradeName': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'StepsList': [
{
'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'Issues': [
'string',
],
'ProgressPercent': 123.0
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response returned by `` GetUpgradeHistory `` operation.
UpgradeHistories (list) --
A list of `` UpgradeHistory `` objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of `` GetUpgradeHistoryResponse `` object.
(dict) --
History of the last 10 Upgrades and Upgrade Eligibility Checks.
UpgradeName (string) --
A string that describes the update briefly
StartTimestamp (datetime) --
UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
UpgradeStatus (string) --
The overall status of the update. The status can take one of the following values:
StepsList (list) --
A list of `` UpgradeStepItem `` s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.
(dict) --
Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
UpgradeStep (string) --
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
UpgradeStepStatus (string) --
The status of a particular step during an upgrade. The status can take one of the following values:
Issues (list) --
A list of strings containing detailed information about the errors encountered in a particular step.
ProgressPercent (float) --
The Floating point value representing progress percentage of a particular step.
NextToken (string) --
Pagination token that needs to be supplied to the next call to get the next page of results
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionget_upgrade_status(**kwargs)¶Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
See also: AWS API Documentation
Request Syntax
response = client.get_upgrade_status(
DomainName='string'
)
[REQUIRED]
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).
{
'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'UpgradeName': 'string'
}
Response Structure
Container for response returned by `` GetUpgradeStatus `` operation.
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
One of 4 statuses that a step can go through returned as part of the `` GetUpgradeStatusResponse `` object. The status can take one of the following values:
A string that describes the update briefly
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_domain_names(**kwargs)¶Returns the name of all Elasticsearch domains owned by the current user's account.
See also: AWS API Documentation
Request Syntax
response = client.list_domain_names(
EngineType='OpenSearch'|'Elasticsearch'
)
{
'DomainNames': [
{
'DomainName': 'string',
'EngineType': 'OpenSearch'|'Elasticsearch'
},
]
}
Response Structure
The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
List of domain names and respective engine types.
Specifies the DomainName .
Specifies the EngineType of the domain.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ValidationExceptionlist_domains_for_package(**kwargs)¶Lists all Amazon ES domains associated with the package.
See also: AWS API Documentation
Request Syntax
response = client.list_domains_for_package(
PackageID='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The package for which to list domains.
dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response parameters to `` ListDomainsForPackage `` operation.
DomainPackageDetailsList (list) --
List of DomainPackageDetails objects.
(dict) --
Information on a package that is associated with a domain.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
LastUpdated (datetime) --
Timestamp of the most-recent update to the association status.
DomainName (string) --
Name of the domain you've associated a package with.
DomainPackageStatus (string) --
State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
PackageVersion (string) --
ReferencePath (string) --
The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
NextToken (string) --
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionlist_elasticsearch_instance_types(**kwargs)¶List all Elasticsearch instance types that are supported for given ElasticsearchVersion
See also: AWS API Documentation
Request Syntax
response = client.list_elasticsearch_instance_types(
ElasticsearchVersion='string',
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
dict
Response Syntax
{
'ElasticsearchInstanceTypes': [
'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the parameters returned by `` ListElasticsearchInstanceTypes `` operation.
ElasticsearchInstanceTypes (list) --
List of instance types supported by Amazon Elasticsearch service for given `` ElasticsearchVersion ``
NextToken (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.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionlist_elasticsearch_versions(**kwargs)¶List all supported Elasticsearch versions
See also: AWS API Documentation
Request Syntax
response = client.list_elasticsearch_versions(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ElasticsearchVersions': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the parameters for response received from `` ListElasticsearchVersions `` operation.
ElasticsearchVersions (list) --
List of supported elastic search versions.
NextToken (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.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionlist_packages_for_domain(**kwargs)¶Lists all packages associated with the Amazon ES domain.
See also: AWS API Documentation
Request Syntax
response = client.list_packages_for_domain(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the domain for which you want to list associated packages.
dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response parameters to `` ListPackagesForDomain `` operation.
DomainPackageDetailsList (list) --
List of DomainPackageDetails objects.
(dict) --
Information on a package that is associated with a domain.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
LastUpdated (datetime) --
Timestamp of the most-recent update to the association status.
DomainName (string) --
Name of the domain you've associated a package with.
DomainPackageStatus (string) --
State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
PackageVersion (string) --
ReferencePath (string) --
The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
NextToken (string) --
Pagination token that needs to be supplied to the next call to get the next page of results.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionReturns all tags for the given Elasticsearch domain.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ARN='string'
)
[REQUIRED]
Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.
List of Tag for the requested Elasticsearch domain.
Specifies a key value pair for a resource tag.
Specifies the TagKey , the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
Specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionpurchase_reserved_elasticsearch_instance_offering(**kwargs)¶Allows you to purchase reserved Elasticsearch instances.
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_elasticsearch_instance_offering(
ReservedElasticsearchInstanceOfferingId='string',
ReservationName='string',
InstanceCount=123
)
[REQUIRED]
The ID of the reserved Elasticsearch instance offering to purchase.
[REQUIRED]
A customer-specified identifier to track this reservation.
dict
Response Syntax
{
'ReservedElasticsearchInstanceId': 'string',
'ReservationName': 'string'
}
Response Structure
(dict) --
Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.
ReservedElasticsearchInstanceId (string) --
Details of the reserved Elasticsearch instance which was purchased.
ReservationName (string) --
The customer-specified identifier used to track this reservation.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ResourceAlreadyExistsExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionreject_inbound_cross_cluster_search_connection(**kwargs)¶Allows the destination domain owner to reject an inbound cross-cluster search connection request.
See also: AWS API Documentation
Request Syntax
response = client.reject_inbound_cross_cluster_search_connection(
CrossClusterSearchConnectionId='string'
)
[REQUIRED]
The id of the inbound connection that you want to reject.
{
'CrossClusterSearchConnection': {
'SourceDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'DestinationDomainInfo': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
},
'CrossClusterSearchConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
}
}
}
Response Structure
The result of a `` RejectInboundCrossClusterSearchConnection`` operation. Contains details of rejected inbound connection.
Specifies the `` InboundCrossClusterSearchConnection`` of rejected inbound connection.
Specifies the `` DomainInformation`` for the source Elasticsearch domain.
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).
Specifies the `` DomainInformation`` for the destination Elasticsearch domain.
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).
Specifies the connection id for the inbound cross-cluster search connection.
Specifies the `` InboundCrossClusterSearchConnectionStatus`` for the outbound connection.
The state code for inbound connection. This can be one of the following:
Specifies verbose information for the inbound connection status.
Exceptions
ElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionRemoves the specified set of tags from the specified Elasticsearch domain.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags(
ARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.
[REQUIRED]
Specifies the TagKey list which you want to remove from the Elasticsearch domain.
None
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionstart_elasticsearch_service_software_update(**kwargs)¶Schedules a service software update for an Amazon ES domain.
See also: AWS API Documentation
Request Syntax
response = client.start_elasticsearch_service_software_update(
DomainName='string'
)
[REQUIRED]
The name of the domain that you want to update to the latest service software.
{
'ServiceSoftwareOptions': {
'CurrentVersion': 'string',
'NewVersion': 'string',
'UpdateAvailable': True|False,
'Cancellable': True|False,
'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
'Description': 'string',
'AutomatedUpdateDate': datetime(2015, 1, 1),
'OptionalDeployment': True|False
}
}
Response Structure
The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.
The current status of the Elasticsearch service software update.
The current service software version that is present on the domain.
The new service software version if one is available.
True if you are able to update you service software version. False if you are not able to update your service software version.
True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
The status of your service software update. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
The description of the UpdateStatus .
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate .
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionupdate_elasticsearch_domain_config(**kwargs)¶Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
See also: AWS API Documentation
Request Syntax
response = client.update_elasticsearch_domain_config(
DomainName='string',
ElasticsearchClusterConfig={
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
EBSOptions={
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
SnapshotOptions={
'AutomatedSnapshotStartHour': 123
},
VPCOptions={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
CognitoOptions={
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
AdvancedOptions={
'string': 'string'
},
AccessPolicies='string',
LogPublishingOptions={
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
DomainEndpointOptions={
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
AdvancedSecurityOptions={
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'MasterUserOptions': {
'MasterUserARN': 'string',
'MasterUserName': 'string',
'MasterUserPassword': 'string'
},
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'MasterUserName': 'string',
'MasterBackendRole': 'string',
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthEnabled': True|False
},
NodeToNodeEncryptionOptions={
'Enabled': True|False
},
EncryptionAtRestOptions={
'Enabled': True|False,
'KmsKeyId': 'string'
},
AutoTuneOptions={
'DesiredState': 'ENABLED'|'DISABLED',
'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
'MaintenanceSchedules': [
{
'StartAt': datetime(2015, 1, 1),
'Duration': {
'Value': 123,
'Unit': 'HOURS'
},
'CronExpressionForRecurrence': 'string'
},
]
},
DryRun=True|False
)
[REQUIRED]
The name of the Elasticsearch domain that you are updating.
The type and number of instances to instantiate for the domain cluster.
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
The number of instances in the specified domain cluster.
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
The instance type for a dedicated master node.
Total number of dedicated master nodes, active and on standby, for the cluster.
True to enable warm storage.
The instance type for the Elasticsearch cluster's warm nodes.
The number of warm nodes in the cluster.
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enable cold storage option. Accepted values true or false
Specify the type and size of the EBS volume that you want to use.
Specifies whether EBS-based storage is enabled.
Specifies the volume type for EBS-based storage.
Integer to specify the size of an EBS volume.
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Specifies the Throughput for GP3 EBS volume (SSD).
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
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
Specifies the subnets for VPC endpoint.
Specifies the security groups for VPC endpoint.
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana .
Specifies the option to enable Cognito for Kibana authentication.
Specifies the Cognito user pool ID for Kibana authentication.
Specifies the Cognito identity pool ID for Kibana authentication.
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Configuration Advanced Options for more information.
Map of LogType and LogPublishingOption , each containing options to publish a given type of Elasticsearch log.
Type of Log File, it can be one of the following:
Log Publishing option that is set for given domain. Attributes and their details:
ARN of the Cloudwatch log group to which log needs to be published.
Specifies whether given log publishing option is enabled or not.
Options to specify configuration that will be applied to the domain endpoint.
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
Specify if custom endpoint should be enabled for the Elasticsearch domain.
Specify the fully qualified domain for your custom endpoint.
Specify ACM certificate ARN for your custom endpoint.
Specifies advanced security options.
True if advanced security is enabled.
True if the internal user database is enabled.
Credentials for the master user: username and password, ARN, or both.
ARN for the master user (if IAM is enabled).
The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.
The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.
Specifies the SAML application configuration for the domain.
True if SAML is enabled.
Specifies the SAML Identity Provider's information.
The Metadata of the SAML application in xml format.
The unique Entity ID of the application in SAML Identity Provider.
The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.
The backend role to which the SAML master user is mapped to.
The key to use for matching the SAML Subject attribute.
The key to use for matching the SAML Roles attribute.
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Specifies the NodeToNodeEncryptionOptions.
Specify true to enable node-to-node encryption.
Specifies the Encryption At Rest Options.
Specifies the option to enable Encryption At Rest.
Specifies the KMS Key ID for Encryption At Rest options.
Specifies Auto-Tune options.
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
Specifies list of maitenance schedules. See the Developer Guide for more information.
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
Specifies timestamp at which Auto-Tune maintenance schedule start.
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.dict
Response Syntax
{
'DomainConfig': {
'ElasticsearchVersion': {
'Options': 'string',
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'ElasticsearchClusterConfig': {
'Options': {
'InstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'EBSOptions': {
'Options': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
'VolumeSize': 123,
'Iops': 123,
'Throughput': 123
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AccessPolicies': {
'Options': 'string',
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'SnapshotOptions': {
'Options': {
'AutomatedSnapshotStartHour': 123
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'VPCOptions': {
'Options': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'CognitoOptions': {
'Options': {
'Enabled': True|False,
'UserPoolId': 'string',
'IdentityPoolId': 'string',
'RoleArn': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'EncryptionAtRestOptions': {
'Options': {
'Enabled': True|False,
'KmsKeyId': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'NodeToNodeEncryptionOptions': {
'Options': {
'Enabled': True|False
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AdvancedOptions': {
'Options': {
'string': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'LogPublishingOptions': {
'Options': {
'string': {
'CloudWatchLogsLogGroupArn': 'string',
'Enabled': True|False
}
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'DomainEndpointOptions': {
'Options': {
'EnforceHTTPS': True|False,
'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
'CustomEndpointEnabled': True|False,
'CustomEndpoint': 'string',
'CustomEndpointCertificateArn': 'string'
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AdvancedSecurityOptions': {
'Options': {
'Enabled': True|False,
'InternalUserDatabaseEnabled': True|False,
'SAMLOptions': {
'Enabled': True|False,
'Idp': {
'MetadataContent': 'string',
'EntityId': 'string'
},
'SubjectKey': 'string',
'RolesKey': 'string',
'SessionTimeoutMinutes': 123
},
'AnonymousAuthDisableDate': datetime(2015, 1, 1),
'AnonymousAuthEnabled': True|False
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'RequiresIndexDocuments'|'Processing'|'Active',
'PendingDeletion': True|False
}
},
'AutoTuneOptions': {
'Options': {
'DesiredState': 'ENABLED'|'DISABLED',
'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
'MaintenanceSchedules': [
{
'StartAt': datetime(2015, 1, 1),
'Duration': {
'Value': 123,
'Unit': 'HOURS'
},
'CronExpressionForRecurrence': 'string'
},
]
},
'Status': {
'CreationDate': datetime(2015, 1, 1),
'UpdateDate': datetime(2015, 1, 1),
'UpdateVersion': 123,
'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
'ErrorMessage': 'string',
'PendingDeletion': True|False
}
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
},
'DryRunResults': {
'DeploymentType': 'string',
'Message': 'string'
}
}
Response Structure
(dict) --
The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.
DomainConfig (dict) --
The status of the updated Elasticsearch domain.
ElasticsearchVersion (dict) --
String of format X.Y to specify version for the Elasticsearch domain.
Options (string) --
Specifies the Elasticsearch version for the specified Elasticsearch domain.
Status (dict) --
Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
ElasticsearchClusterConfig (dict) --
Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
Options (dict) --
Specifies the cluster configuration for the specified Elasticsearch domain.
InstanceType (string) --
The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
ZoneAwarenessConfig (dict) --
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable warm storage.
WarmType (string) --
The instance type for the Elasticsearch cluster's warm nodes.
WarmCount (integer) --
The number of warm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for Elasticsearch Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
Status (dict) --
Specifies the status of the configuration for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
EBSOptions (dict) --
Specifies the EBSOptions for the Elasticsearch domain.
Options (dict) --
Specifies the EBS options for the specified Elasticsearch domain.
EBSEnabled (boolean) --
Specifies whether EBS-based storage is enabled.
VolumeType (string) --
Specifies the volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
Throughput (integer) --
Specifies the Throughput for GP3 EBS volume (SSD).
Status (dict) --
Specifies the status of the EBS options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
AccessPolicies (dict) --
IAM access policy as a JSON-formatted string.
Options (string) --
The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policies for more information.
Status (dict) --
The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
SnapshotOptions (dict) --
Specifies the SnapshotOptions for the Elasticsearch domain.
Options (dict) --
Specifies the daily snapshot options specified for the Elasticsearch domain.
AutomatedSnapshotStartHour (integer) --
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
Status (dict) --
Specifies the status of a daily automated snapshot.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
Options (dict) --
Specifies the VPC options for the specified Elasticsearch domain.
VPCId (string) --
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
SubnetIds (list) --
Specifies the subnets for VPC endpoint.
AvailabilityZones (list) --
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
SecurityGroupIds (list) --
Specifies the security groups for VPC endpoint.
Status (dict) --
Specifies the status of the VPC options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana .
Options (dict) --
Specifies the Cognito options for the specified Elasticsearch domain.
Enabled (boolean) --
Specifies the option to enable Cognito for Kibana authentication.
UserPoolId (string) --
Specifies the Cognito user pool ID for Kibana authentication.
IdentityPoolId (string) --
Specifies the Cognito identity pool ID for Kibana authentication.
RoleArn (string) --
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
Status (dict) --
Specifies the status of the Cognito options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
EncryptionAtRestOptions (dict) --
Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
Options (dict) --
Specifies the Encryption At Rest options for the specified Elasticsearch domain.
Enabled (boolean) --
Specifies the option to enable Encryption At Rest.
KmsKeyId (string) --
Specifies the KMS Key ID for Encryption At Rest options.
Status (dict) --
Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
NodeToNodeEncryptionOptions (dict) --
Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
Options (dict) --
Specifies the node-to-node encryption options for the specified Elasticsearch domain.
Enabled (boolean) --
Specify true to enable node-to-node encryption.
Status (dict) --
Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
AdvancedOptions (dict) --
Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
Options (dict) --
Specifies the status of advanced options for the specified Elasticsearch domain.
Status (dict) --
Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
LogPublishingOptions (dict) --
Log publishing options for the given domain.
Options (dict) --
The log publishing options configured for the Elasticsearch domain.
(string) --
Type of Log File, it can be one of the following:
(dict) --
Log Publishing option that is set for given domain. Attributes and their details:
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to which log needs to be published.
Enabled (boolean) --
Specifies whether given log publishing option is enabled or not.
Status (dict) --
The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
DomainEndpointOptions (dict) --
Specifies the DomainEndpointOptions for the Elasticsearch domain.
Options (dict) --
Options to configure endpoint for the Elasticsearch domain.
EnforceHTTPS (boolean) --
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:
CustomEndpointEnabled (boolean) --
Specify if custom endpoint should be enabled for the Elasticsearch domain.
CustomEndpoint (string) --
Specify the fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
Specify ACM certificate ARN for your custom endpoint.
Status (dict) --
The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
AdvancedSecurityOptions (dict) --
Specifies AdvancedSecurityOptions for the domain.
Options (dict) --
Specifies advanced security options for the specified Elasticsearch domain.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
Enabled (boolean) --
True if SAML is enabled.
Idp (dict) --
Describes the SAML Identity Provider's information.
MetadataContent (string) --
The Metadata of the SAML application in xml format.
EntityId (string) --
The unique Entity ID of the application in SAML Identity Provider.
SubjectKey (string) --
The key used for matching the SAML Subject attribute.
RolesKey (string) --
The key used for matching the SAML Roles attribute.
SessionTimeoutMinutes (integer) --
The duration, in minutes, after which a user session becomes inactive.
AnonymousAuthDisableDate (datetime) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Status (dict) --
Status of the advanced security options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells the creation date for the entity.
UpdateDate (datetime) --
Timestamp which tells the last updated time for the entity.
UpdateVersion (integer) --
Specifies the latest version for the entity.
State (string) --
Provides the OptionState for the Elasticsearch domain.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
AutoTuneOptions (dict) --
Specifies AutoTuneOptions for the domain.
Options (dict) --
Specifies Auto-Tune options for the specified Elasticsearch domain.
DesiredState (string) --
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
RollbackOnDisable (string) --
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
MaintenanceSchedules (list) --
Specifies list of maitenance schedules. See the Developer Guide for more information.
(dict) --
Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
StartAt (datetime) --
Specifies timestamp at which Auto-Tune maintenance schedule start.
Duration (dict) --
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
Value (integer) --
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
Unit (string) --
Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
CronExpressionForRecurrence (string) --
Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
Status (dict) --
Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.
CreationDate (datetime) --
Timestamp which tells Auto-Tune options creation date .
UpdateDate (datetime) --
Timestamp which tells Auto-Tune options last updated time.
UpdateVersion (integer) --
Specifies the Auto-Tune options latest version.
State (string) --
Specifies the AutoTuneState for the Elasticsearch domain.
ErrorMessage (string) --
Specifies the error message while enabling or disabling the Auto-Tune options.
PendingDeletion (boolean) --
Indicates whether the Elasticsearch domain is being deleted.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
DryRunResults (dict) --
Contains result of DryRun.
DeploymentType (string) --
Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)
Message (string) --
Contains an optional message associated with the DryRunResults.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.InvalidTypeExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ValidationExceptionupdate_package(**kwargs)¶Updates a package for use with Amazon ES domains.
See also: AWS API Documentation
Request Syntax
response = client.update_package(
PackageID='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
},
PackageDescription='string',
CommitMessage='string'
)
[REQUIRED]
Unique identifier for the package.
[REQUIRED]
The S3 location for importing the package specified as S3BucketName and S3Key
Name of the bucket containing the package.
Key (file name) of the package.
GetPackageVersionHistoryResponse .dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for response returned by `` UpdatePackage `` operation.
PackageDetails (dict) --
Information about the package PackageDetails .
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User specified name of the package.
PackageType (string) --
Currently supports only TXT-DICTIONARY.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
CreatedAt (datetime) --
Timestamp which tells creation date of the package.
LastUpdatedAt (datetime) --
AvailablePackageVersion (string) --
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.InternalExceptionElasticsearchService.Client.exceptions.LimitExceededExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.AccessDeniedExceptionElasticsearchService.Client.exceptions.ValidationExceptionupgrade_elasticsearch_domain(**kwargs)¶Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
See also: AWS API Documentation
Request Syntax
response = client.upgrade_elasticsearch_domain(
DomainName='string',
TargetVersion='string',
PerformCheckOnly=True|False
)
[REQUIRED]
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).
[REQUIRED]
The version of Elasticsearch that you intend to upgrade the domain to.
dict
Response Syntax
{
'DomainName': 'string',
'TargetVersion': 'string',
'PerformCheckOnly': True|False,
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
Response Structure
(dict) --
Container for response returned by `` UpgradeElasticsearchDomain `` operation.
DomainName (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).
TargetVersion (string) --
The version of Elasticsearch that you intend to upgrade the domain to.
PerformCheckOnly (boolean) --
This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
Exceptions
ElasticsearchService.Client.exceptions.BaseExceptionElasticsearchService.Client.exceptions.ResourceNotFoundExceptionElasticsearchService.Client.exceptions.ResourceAlreadyExistsExceptionElasticsearchService.Client.exceptions.DisabledOperationExceptionElasticsearchService.Client.exceptions.ValidationExceptionElasticsearchService.Client.exceptions.InternalExceptionThe available paginators are:
ElasticsearchService.Paginator.DescribeReservedElasticsearchInstanceOfferingsElasticsearchService.Paginator.DescribeReservedElasticsearchInstancesElasticsearchService.Paginator.GetUpgradeHistoryElasticsearchService.Paginator.ListElasticsearchInstanceTypesElasticsearchService.Paginator.ListElasticsearchVersionsElasticsearchService.Paginator.DescribeReservedElasticsearchInstanceOfferings¶paginator = client.get_paginator('describe_reserved_elasticsearch_instance_offerings')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElasticsearchService.Client.describe_reserved_elasticsearch_instance_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedElasticsearchInstanceOfferingId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedElasticsearchInstanceOfferings': [
{
'ReservedElasticsearchInstanceOfferingId': 'string',
'ElasticsearchInstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results from DescribeReservedElasticsearchInstanceOfferings
ReservedElasticsearchInstanceOfferings (list) --
List of reserved Elasticsearch instance offerings
(dict) --
Details of a reserved Elasticsearch instance offering.
ReservedElasticsearchInstanceOfferingId (string) --
The Elasticsearch reserved instance offering identifier.
ElasticsearchInstanceType (string) --
The Elasticsearch instance type offered by the reserved instance offering.
Duration (integer) --
The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
FixedPrice (float) --
The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
UsagePrice (float) --
The rate you are charged for each hour the domain that is using the offering is running.
CurrencyCode (string) --
The currency code for the reserved Elasticsearch instance offering.
PaymentOption (string) --
Payment option for the reserved Elasticsearch instance offering
RecurringCharges (list) --
The charge to your account regardless of whether you are creating any domains using the instance offering.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ElasticsearchService.Paginator.DescribeReservedElasticsearchInstances¶paginator = client.get_paginator('describe_reserved_elasticsearch_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElasticsearchService.Client.describe_reserved_elasticsearch_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedElasticsearchInstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedElasticsearchInstances': [
{
'ReservationName': 'string',
'ReservedElasticsearchInstanceId': 'string',
'ReservedElasticsearchInstanceOfferingId': 'string',
'ElasticsearchInstanceType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'ElasticsearchInstanceCount': 123,
'State': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results from DescribeReservedElasticsearchInstances
ReservedElasticsearchInstances (list) --
List of reserved Elasticsearch instances.
(dict) --
Details of a reserved Elasticsearch instance.
ReservationName (string) --
The customer-specified identifier to track this reservation.
ReservedElasticsearchInstanceId (string) --
The unique identifier for the reservation.
ReservedElasticsearchInstanceOfferingId (string) --
The offering identifier.
ElasticsearchInstanceType (string) --
The Elasticsearch instance type offered by the reserved instance offering.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration, in seconds, for which the Elasticsearch instance is reserved.
FixedPrice (float) --
The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
UsagePrice (float) --
The rate you are charged for each hour for the domain that is using this reserved instance.
CurrencyCode (string) --
The currency code for the reserved Elasticsearch instance offering.
ElasticsearchInstanceCount (integer) --
The number of Elasticsearch instances that have been reserved.
State (string) --
The state of the reserved Elasticsearch instance.
PaymentOption (string) --
The payment option as defined in the reserved Elasticsearch instance offering.
RecurringCharges (list) --
The charge to your account regardless of whether you are creating any domains using the instance offering.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ElasticsearchService.Paginator.GetUpgradeHistory¶paginator = client.get_paginator('get_upgrade_history')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElasticsearchService.Client.get_upgrade_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DomainName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
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).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UpgradeHistories': [
{
'UpgradeName': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'StepsList': [
{
'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'Issues': [
'string',
],
'ProgressPercent': 123.0
},
]
},
],
}
Response Structure
(dict) --
Container for response returned by `` GetUpgradeHistory `` operation.
UpgradeHistories (list) --
A list of `` UpgradeHistory `` objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of `` GetUpgradeHistoryResponse `` object.
(dict) --
History of the last 10 Upgrades and Upgrade Eligibility Checks.
UpgradeName (string) --
A string that describes the update briefly
StartTimestamp (datetime) --
UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
UpgradeStatus (string) --
The overall status of the update. The status can take one of the following values:
StepsList (list) --
A list of `` UpgradeStepItem `` s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.
(dict) --
Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
UpgradeStep (string) --
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
UpgradeStepStatus (string) --
The status of a particular step during an upgrade. The status can take one of the following values:
Issues (list) --
A list of strings containing detailed information about the errors encountered in a particular step.
ProgressPercent (float) --
The Floating point value representing progress percentage of a particular step.
ElasticsearchService.Paginator.ListElasticsearchInstanceTypes¶paginator = client.get_paginator('list_elasticsearch_instance_types')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElasticsearchService.Client.list_elasticsearch_instance_types().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ElasticsearchVersion='string',
DomainName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ElasticsearchInstanceTypes': [
'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'m5.large.elasticsearch'|'m5.xlarge.elasticsearch'|'m5.2xlarge.elasticsearch'|'m5.4xlarge.elasticsearch'|'m5.12xlarge.elasticsearch'|'r5.large.elasticsearch'|'r5.xlarge.elasticsearch'|'r5.2xlarge.elasticsearch'|'r5.4xlarge.elasticsearch'|'r5.12xlarge.elasticsearch'|'c5.large.elasticsearch'|'c5.xlarge.elasticsearch'|'c5.2xlarge.elasticsearch'|'c5.4xlarge.elasticsearch'|'c5.9xlarge.elasticsearch'|'c5.18xlarge.elasticsearch'|'ultrawarm1.medium.elasticsearch'|'ultrawarm1.large.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
],
}
Response Structure
(dict) --
Container for the parameters returned by `` ListElasticsearchInstanceTypes `` operation.
ElasticsearchInstanceTypes (list) --
List of instance types supported by Amazon Elasticsearch service for given `` ElasticsearchVersion ``
ElasticsearchService.Paginator.ListElasticsearchVersions¶paginator = client.get_paginator('list_elasticsearch_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ElasticsearchService.Client.list_elasticsearch_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'ElasticsearchVersions': [
'string',
],
}
Response Structure
Container for the parameters for response received from `` ListElasticsearchVersions `` operation.
List of supported elastic search versions.