Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

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

      The Amazon Elasticsearch Service multi-region endpoint
      The Amazon Elasticsearch Service multi-region endpoint
      GET
      /2015-01-01/es/domain/{DomainName}
      Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/domain/'
      Response Response Example
      200 - Example 1
      {
  "DomainStatus": {
    "DomainId": "string",
    "DomainName": "string",
    "ARN": "string",
    "Created": true,
    "Deleted": true,
    "Endpoint": "string",
    "Endpoints": {
      "property1": "string",
      "property2": "string"
    },
    "Processing": true,
    "UpgradeProcessing": true,
    "ElasticsearchVersion": "string",
    "ElasticsearchClusterConfig": {
      "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
      }
    },
    "EBSOptions": {
      "EBSEnabled": true,
      "VolumeType": "standard",
      "VolumeSize": 0,
      "Iops": 0,
      "Throughput": 0
    },
    "AccessPolicies": "string",
    "SnapshotOptions": {
      "AutomatedSnapshotStartHour": 0
    },
    "VPCOptions": {
      "VPCId": "string",
      "SubnetIds": [],
      "AvailabilityZones": [],
      "SecurityGroupIds": []
    },
    "CognitoOptions": {
      "Enabled": true,
      "UserPoolId": "string",
      "IdentityPoolId": "string",
      "RoleArn": "string"
    },
    "EncryptionAtRestOptions": {
      "Enabled": true,
      "KmsKeyId": "string"
    },
    "NodeToNodeEncryptionOptions": {
      "Enabled": true
    },
    "AdvancedOptions": {},
    "LogPublishingOptions": {
      "property1": {
        "CloudWatchLogsLogGroupArn": "string",
        "Enabled": true
      }
    },
    "ServiceSoftwareOptions": {
      "CurrentVersion": "string",
      "NewVersion": "string",
      "UpdateAvailable": true,
      "Cancellable": true,
      "UpdateStatus": "PENDING_UPDATE",
      "Description": "string",
      "AutomatedUpdateDate": "string",
      "OptionalDeployment": true
    },
    "DomainEndpointOptions": {
      "EnforceHTTPS": true,
      "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07",
      "CustomEndpointEnabled": true,
      "CustomEndpoint": "string",
      "CustomEndpointCertificateArn": "string"
    },
    "AdvancedSecurityOptions": {
      "Enabled": true,
      "InternalUserDatabaseEnabled": true,
      "SAMLOptions": {
        "Enabled": true,
        "Idp": {
          "MetadataContent": "string",
          "EntityId": "string"
        },
        "SubjectKey": "string",
        "RolesKey": "string",
        "SessionTimeoutMinutes": 0
      },
      "AnonymousAuthDisableDate": "string",
      "AnonymousAuthEnabled": true
    },
    "AutoTuneOptions": {
      "State": "ENABLED",
      "ErrorMessage": "string"
    },
    "ChangeProgressDetails": {
      "ChangeId": "string",
      "Message": "string"
    }
  }
}

      Request

      Path Params
      DomainName
      string 
      required
      The name of the Elasticsearch domain for which you want information.

      Responses

      🟢200Success
      application/json
      Body
      The result of a <code>DescribeElasticsearchDomain</code> request. Contains the status of the domain specified in the request.
      DomainStatus
      object 
      required
      The current status of the Elasticsearch domain.
      DomainId
      string 
      required
      The unique identifier for the specified Elasticsearch domain.
      >= 1 characters<= 64 characters
      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).
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      ARN
      string 
      required
      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 
      optional
      The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
      Deleted
      boolean 
      optional
      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 
      optional
      The Elasticsearch domain endpoint that you use to submit index and search requests.
      Endpoints
      object 
      optional
      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'.
      Processing
      boolean 
      optional
      The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
      UpgradeProcessing
      boolean 
      optional
      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 
      ElasticsearchVersionString
      optional
      Match pattern:
      ^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$
      ElasticsearchClusterConfig
      object 
      required
      The type and number of instances in the domain cluster.
      EBSOptions
      object 
      optional
      The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
      AccessPolicies
      string 
      optional
      IAM access policy as a JSON-formatted string.
      SnapshotOptions
      object 
      optional
      Specifies the status of the SnapshotOptions
      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 status of the EncryptionAtRestOptions.
      NodeToNodeEncryptionOptions
      object 
      optional
      Specifies the status of the NodeToNodeEncryptionOptions.
      AdvancedOptions
      object 
      optional
      Specifies the status of the AdvancedOptions
      LogPublishingOptions
      object 
      optional
      Log publishing options for the given domain.
      ServiceSoftwareOptions
      object 
      optional
      The current status of the Elasticsearch domain's service software.
      DomainEndpointOptions
      object 
      optional
      The current status of the Elasticsearch domain's endpoint options.
      AdvancedSecurityOptions
      object 
      optional
      The current status of the Elasticsearch domain's advanced security options.
      AutoTuneOptions
      object 
      optional
      The current status of the Elasticsearch domain's Auto-Tune options.
      ChangeProgressDetails
      object 
      optional
      Specifies change details of the domain configuration change.
      🟠480BaseException
      🟠481InternalException
      🟠482ResourceNotFoundException
      🟠483ValidationException
      Modified at 2023-08-15 04:15:53
      Previous
      /2015-01-01/es/domain/{DomainName}
      Next
      /2015-01-01/es/role
      Built with