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

The Amazon Elasticsearch Service multi-region endpoint

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

GET

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/domain//config'

Response Example

200 - Example 1

{
  "DomainConfig": {
    "ElasticsearchVersion": {
      "Options": "string",
      "Status": {
        "CreationDate": "string",
        "UpdateDate": "string",
        "UpdateVersion": 0,
        "State": "RequiresIndexDocuments",
        "PendingDeletion": true
      }
    },
    "ElasticsearchClusterConfig": {
      "Options": {
        "InstanceType": "m3.medium.elasticsearch",
        "InstanceCount": 0,
        "DedicatedMasterEnabled": true,
        "ZoneAwarenessEnabled": true,
        "ZoneAwarenessConfig": {
          "AvailabilityZoneCount": 0
        },
        "DedicatedMasterType": "m3.medium.elasticsearch",
        "DedicatedMasterCount": 0,
        "WarmEnabled": true,
        "WarmType": "ultrawarm1.medium.elasticsearch",
        "WarmCount": 0,
        "ColdStorageOptions": {
          "Enabled": true
        }
      },
      "Status": {}
    },
    "EBSOptions": {
      "Options": {
        "EBSEnabled": true,
        "VolumeType": "standard",
        "VolumeSize": 0,
        "Iops": 0,
        "Throughput": 0
      },
      "Status": {}
    },
    "AccessPolicies": {
      "Options": "string",
      "Status": {}
    },
    "SnapshotOptions": {
      "Options": {
        "AutomatedSnapshotStartHour": 0
      },
      "Status": {}
    },
    "VPCOptions": {
      "Options": {
        "VPCId": "string",
        "SubnetIds": [],
        "AvailabilityZones": [],
        "SecurityGroupIds": []
      },
      "Status": {}
    },
    "CognitoOptions": {
      "Options": {
        "Enabled": true,
        "UserPoolId": "string",
        "IdentityPoolId": "string",
        "RoleArn": "string"
      },
      "Status": {}
    },
    "EncryptionAtRestOptions": {
      "Options": {
        "Enabled": true,
        "KmsKeyId": "string"
      },
      "Status": {}
    },
    "NodeToNodeEncryptionOptions": {
      "Options": {
        "Enabled": true
      },
      "Status": {}
    },
    "AdvancedOptions": {},
    "LogPublishingOptions": {
      "Options": {
        "property1": {
          "CloudWatchLogsLogGroupArn": "string",
          "Enabled": true
        }
      },
      "Status": {}
    },
    "DomainEndpointOptions": {
      "Options": {
        "EnforceHTTPS": true,
        "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07",
        "CustomEndpointEnabled": true,
        "CustomEndpoint": "string",
        "CustomEndpointCertificateArn": "string"
      },
      "Status": {}
    },
    "AdvancedSecurityOptions": {
      "Options": {
        "Enabled": true,
        "InternalUserDatabaseEnabled": true,
        "SAMLOptions": {
          "Enabled": true,
          "Idp": {
            "MetadataContent": "string",
            "EntityId": "string"
          },
          "SubjectKey": "string",
          "RolesKey": "string",
          "SessionTimeoutMinutes": 0
        },
        "AnonymousAuthDisableDate": "string",
        "AnonymousAuthEnabled": true
      },
      "Status": {}
    },
    "AutoTuneOptions": {
      "Options": {
        "DesiredState": "ENABLED",
        "RollbackOnDisable": "NO_ROLLBACK",
        "MaintenanceSchedules": []
      },
      "Status": {
        "CreationDate": "string",
        "UpdateDate": "string",
        "UpdateVersion": 0,
        "State": "ENABLED",
        "ErrorMessage": "string",
        "PendingDeletion": true
      }
    },
    "ChangeProgressDetails": {
      "ChangeId": "string",
      "Message": "string"
    }
  }
}

Request

Path Params

DomainName

string

required

The Elasticsearch domain that you want to get information about.

Responses

🟢200Success

application/json

Body

The result of a <code>DescribeElasticsearchDomainConfig</code> request. Contains the configuration information of the requested domain.

DomainConfig

object

required

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

ElasticsearchVersion

object

optional

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

ElasticsearchClusterConfig

object

optional

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

EBSOptions

object

optional

Specifies the EBSOptions for the Elasticsearch domain.

AccessPolicies

object

optional

IAM access policy as a JSON-formatted string.

SnapshotOptions

object

optional

Specifies the SnapshotOptions for the Elasticsearch domain.

VPCOptions

object

optional

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

CognitoOptions

object

optional

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

EncryptionAtRestOptions

object

optional

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

NodeToNodeEncryptionOptions

object

optional

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

AdvancedOptions

object

optional

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

LogPublishingOptions

object

optional

Log publishing options for the given domain.

DomainEndpointOptions

object

optional

Specifies the DomainEndpointOptions for the Elasticsearch domain.

AdvancedSecurityOptions

object

optional

Specifies AdvancedSecurityOptions for the domain.

AutoTuneOptions

object

optional

Specifies AutoTuneOptions for the domain.

ChangeProgressDetails

object

optional

Specifies change details of the domain configuration change.

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483ValidationException

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

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