AWS API Changes

2018/08/14 - Amazon Elasticsearch Service - 4 new 4 updated api methods

Changes Amazon Elasticsearch Service adds support for no downtime, in-place upgrade for Elasticsearch version 5.1 and above.

GetCompatibleElasticsearchVersions (new)

Link ¶

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

client.get_compatible_elasticsearch_versions(
    DomainName='string'
)

type DomainName

string

param DomainName

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).

rtype

dict

returns

Response Syntax

{
    'CompatibleElasticsearchVersions': [
        {
            'SourceVersion': 'string',
            'TargetVersions': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) --

Container for response returned by GetCompatibleElasticsearchVersions operation.
- CompatibleElasticsearchVersions (list) --
  
  A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.
  - (dict) --
    
    A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
    - SourceVersion (string) --
      
      The current version of Elasticsearch on which a domain is.
    - TargetVersions (list) --
      
      List of supported elastic search versions.
      - (string) --

GetUpgradeHistory (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_upgrade_history(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

type DomainName

string

param DomainName

[REQUIRED]

type MaxResults

integer

param MaxResults

Set this value to limit the number of results returned.

type NextToken

string

param NextToken

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.

rtype

dict

returns

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:
      - In Progress
      - Succeeded
      - Succeeded with Issues
      - Failed
    - 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:
        
        PreUpgradeCheck
        
        Snapshot
        
        Upgrade
        
        UpgradeStepStatus (string) --
        
        The status of a particular step during an upgrade. The status can take one of the following values:
        
        In Progress
        
        Succeeded
        
        Succeeded with Issues
        
        Failed
        
        Issues (list) --
        
        A list of strings containing detailed information about the errors encountered in a particular step.
        
        (string) --
        
        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

GetUpgradeStatus (new)

Link ¶

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

client.get_upgrade_status(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
    'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
    'UpgradeName': 'string'
}

Response Structure

(dict) --

Container for response returned by GetUpgradeStatus operation.
- UpgradeStep (string) --
  
  Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
  - PreUpgradeCheck
  - Snapshot
  - Upgrade
- StepStatus (string) --
  
  One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:
  - In Progress
  - Succeeded
  - Succeeded with Issues
  - Failed
- UpgradeName (string) --
  
  A string that describes the update briefly

UpgradeElasticsearchDomain (new)

Link ¶

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

client.upgrade_elasticsearch_domain(
    DomainName='string',
    TargetVersion='string',
    PerformCheckOnly=True|False
)

type DomainName

string

param DomainName

[REQUIRED]

type TargetVersion

string

param TargetVersion

[REQUIRED]

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

type PerformCheckOnly

boolean

param PerformCheckOnly

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

rtype

dict

returns

Response Syntax

{
    'DomainName': 'string',
    'TargetVersion': 'string',
    'PerformCheckOnly': True|False
}

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.

CreateElasticsearchDomain (updated)

Link ¶
Changes (response)

{'DomainStatus': {'UpgradeProcessing': 'boolean'}}

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

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'|'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,
        'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
        'DedicatedMasterCount': 123
    },
    EBSOptions={
        'EBSEnabled': True|False,
        'VolumeType': 'standard'|'gp2'|'io1',
        'VolumeSize': 123,
        'Iops': 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'
    },
    AdvancedOptions={
        'string': 'string'
    },
    LogPublishingOptions={
        'string': {
            'CloudWatchLogsLogGroupArn': 'string',
            'Enabled': True|False
        }
    }
)

type DomainName

string

param DomainName

[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 letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

type ElasticsearchVersion

string

param ElasticsearchVersion

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

type ElasticsearchClusterConfig

dict

param ElasticsearchClusterConfig

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

InstanceType (string) --

The instance type for an Elasticsearch cluster.
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.
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.

type EBSOptions

dict

param EBSOptions

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

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 IOPD for a Provisioned IOPS EBS volume (SSD).

type AccessPolicies

string

param AccessPolicies

IAM access policy as a JSON-formatted string.

type SnapshotOptions

dict

param SnapshotOptions

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

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.

type VPCOptions

dict

param VPCOptions

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

SubnetIds (list) --

Specifies the subnets for VPC endpoint.
- (string) --
SecurityGroupIds (list) --

Specifies the security groups for VPC endpoint.
- (string) --

type CognitoOptions

dict

param CognitoOptions

Options to specify the Cognito user and identity pools for Kibana authentication. 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.

type EncryptionAtRestOptions

dict

param EncryptionAtRestOptions

Specifies the Encryption At Rest Options.

Enabled (boolean) --

Specifies the option to enable Encryption At Rest.
KmsKeyId (string) --

Specifies the KMS Key ID for Encryption At Rest options.

type AdvancedOptions

dict

param AdvancedOptions

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.

(string) --
- (string) --

type LogPublishingOptions

dict

param LogPublishingOptions

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

(string) --

Type of Log File, it can be one of the following:
- INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
- SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
- ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
- (dict) --
  
  Log Publishing option that is set for given domain. Attributes and their details:
  - CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  - Enabled: Whether the log publishing for given log type is enabled or not
  - 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.

rtype

dict

returns

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'|'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,
            'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
            'DedicatedMasterCount': 123
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 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'
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        }
    }
}

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.
    - 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.
    - 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.
  - 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 IOPD for a Provisioned IOPS 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.
      - (string) --
    - AvailabilityZones (list) --
      
      The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
      - (string) --
    - SecurityGroupIds (list) --
      
      Specifies the security groups for VPC endpoint.
      - (string) --
  - 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.
  - AdvancedOptions (dict) --
    
    Specifies the status of the AdvancedOptions
    - (string) --
      - (string) --
  - LogPublishingOptions (dict) --
    
    Log publishing options for the given domain.
    - (string) --
      
      Type of Log File, it can be one of the following:
      - INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
      - SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
      - ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
      - (dict) --
        
        Log Publishing option that is set for given domain. Attributes and their details:
        
        CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
        
        Enabled: Whether the log publishing for given log type is enabled or not
        
        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.

DeleteElasticsearchDomain (updated)

Link ¶
Changes (response)

{'DomainStatus': {'UpgradeProcessing': 'boolean'}}

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

client.delete_elasticsearch_domain(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

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

rtype

dict

returns

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'|'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,
            'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
            'DedicatedMasterCount': 123
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 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'
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        }
    }
}

Response Structure

(dict) --

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.
- DomainStatus (dict) --
  
  The status of the Elasticsearch domain being deleted.
  - 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.
    - 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.
    - 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.
  - 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 IOPD for a Provisioned IOPS 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.
      - (string) --
    - AvailabilityZones (list) --
      
      The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
      - (string) --
    - SecurityGroupIds (list) --
      
      Specifies the security groups for VPC endpoint.
      - (string) --
  - 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.
  - AdvancedOptions (dict) --
    
    Specifies the status of the AdvancedOptions
    - (string) --
      - (string) --
  - LogPublishingOptions (dict) --
    
    Log publishing options for the given domain.
    - (string) --
      
      Type of Log File, it can be one of the following:
      - INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
      - SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
      - ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
      - (dict) --
        
        Log Publishing option that is set for given domain. Attributes and their details:
        
        CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
        
        Enabled: Whether the log publishing for given log type is enabled or not
        
        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.

DescribeElasticsearchDomain (updated)

Link ¶
Changes (response)

{'DomainStatus': {'UpgradeProcessing': 'boolean'}}

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

client.describe_elasticsearch_domain(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

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

rtype

dict

returns

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'|'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,
            'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
            'DedicatedMasterCount': 123
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1',
            'VolumeSize': 123,
            'Iops': 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'
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        }
    }
}

Response Structure

(dict) --

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.
- DomainStatus (dict) --
  
  The current status of the 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.
    - 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.
    - 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.
  - 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 IOPD for a Provisioned IOPS 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.
      - (string) --
    - AvailabilityZones (list) --
      
      The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
      - (string) --
    - SecurityGroupIds (list) --
      
      Specifies the security groups for VPC endpoint.
      - (string) --
  - 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.
  - AdvancedOptions (dict) --
    
    Specifies the status of the AdvancedOptions
    - (string) --
      - (string) --
  - LogPublishingOptions (dict) --
    
    Log publishing options for the given domain.
    - (string) --
      
      Type of Log File, it can be one of the following:
      - INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
      - SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
      - ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
      - (dict) --
        
        Log Publishing option that is set for given domain. Attributes and their details:
        
        CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
        
        Enabled: Whether the log publishing for given log type is enabled or not
        
        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.

DescribeElasticsearchDomains (updated)

Link ¶
Changes (response)

{'DomainStatusList': {'UpgradeProcessing': 'boolean'}}

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

client.describe_elasticsearch_domains(
    DomainNames=[
        'string',
    ]
)

type DomainNames

list

param DomainNames

[REQUIRED]

The Elasticsearch domains for which you want information.

(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).

rtype

dict

returns

Response Syntax

{
    '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'|'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,
                'DedicatedMasterType': 'm3.medium.elasticsearch'|'m3.large.elasticsearch'|'m3.xlarge.elasticsearch'|'m3.2xlarge.elasticsearch'|'m4.large.elasticsearch'|'m4.xlarge.elasticsearch'|'m4.2xlarge.elasticsearch'|'m4.4xlarge.elasticsearch'|'m4.10xlarge.elasticsearch'|'t2.micro.elasticsearch'|'t2.small.elasticsearch'|'t2.medium.elasticsearch'|'r3.large.elasticsearch'|'r3.xlarge.elasticsearch'|'r3.2xlarge.elasticsearch'|'r3.4xlarge.elasticsearch'|'r3.8xlarge.elasticsearch'|'i2.xlarge.elasticsearch'|'i2.2xlarge.elasticsearch'|'d2.xlarge.elasticsearch'|'d2.2xlarge.elasticsearch'|'d2.4xlarge.elasticsearch'|'d2.8xlarge.elasticsearch'|'c4.large.elasticsearch'|'c4.xlarge.elasticsearch'|'c4.2xlarge.elasticsearch'|'c4.4xlarge.elasticsearch'|'c4.8xlarge.elasticsearch'|'r4.large.elasticsearch'|'r4.xlarge.elasticsearch'|'r4.2xlarge.elasticsearch'|'r4.4xlarge.elasticsearch'|'r4.8xlarge.elasticsearch'|'r4.16xlarge.elasticsearch'|'i3.large.elasticsearch'|'i3.xlarge.elasticsearch'|'i3.2xlarge.elasticsearch'|'i3.4xlarge.elasticsearch'|'i3.8xlarge.elasticsearch'|'i3.16xlarge.elasticsearch',
                'DedicatedMasterCount': 123
            },
            'EBSOptions': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1',
                'VolumeSize': 123,
                'Iops': 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'
            },
            'AdvancedOptions': {
                'string': 'string'
            },
            'LogPublishingOptions': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            }
        },
    ]
}

Response Structure

(dict) --

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.
- DomainStatusList (list) --
  
  The status of the domains requested in the DescribeElasticsearchDomains request.
  - (dict) --
    
    The current status of an 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.
      - 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.
      - 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.
    - 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 IOPD for a Provisioned IOPS 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.
        
        (string) --
      - AvailabilityZones (list) --
        
        The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
        
        (string) --
      - SecurityGroupIds (list) --
        
        Specifies the security groups for VPC endpoint.
        
        (string) --
    - 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.
    - AdvancedOptions (dict) --
      
      Specifies the status of the AdvancedOptions
      - (string) --
        
        (string) --
    - LogPublishingOptions (dict) --
      
      Log publishing options for the given domain.
      - (string) --
        
        Type of Log File, it can be one of the following:
        
        INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
        
        SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
        
        ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
        
        (dict) --
        
        Log Publishing option that is set for given domain. Attributes and their details:
        
        CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
        
        Enabled: Whether the log publishing for given log type is enabled or not
        
        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.