Expand description
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.
If you’re using the service, you’re probably looking for EsClient and Es.
Structs§
- Accept
Inbound Cross Cluster Search Connection Request Container for the parameters to the
AcceptInboundCrossClusterSearchConnectionoperation.- Accept
Inbound Cross Cluster Search Connection Response The result of a
AcceptInboundCrossClusterSearchConnectionoperation. Contains details of accepted inbound connection.- Access
Policies Status The configured access rules for the domain's document and search endpoints, and the current status of those rules.
- AddTags
Request Container for the parameters to the
AddTagsoperation. Specify the tags that you want to attach to the Elasticsearch domain.- Additional
Limit List of limits that are specific to a given InstanceType and for each of it's
InstanceRole.- Advanced
Options Status Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:
- Option to allow references to indices in an HTTP request body. Must be
falsewhen configuring access to individual sub-resources. By default, the value istrue. See Configuration Advanced Options for more information. - Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.
For more information, see Configuring Advanced Options.
- Option to allow references to indices in an HTTP request body. Must be
- Advanced
Security Options Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
- Advanced
Security Options Input Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
- Advanced
Security Options Status Specifies the status of advanced security options for the specified Elasticsearch domain.
- Associate
Package Request Container for request parameters to
AssociatePackageoperation.- Associate
Package Response Container for response returned by
AssociatePackageoperation.- Cancel
Elasticsearch Service Software Update Request Container for the parameters to the
CancelElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.- Cancel
Elasticsearch Service Software Update Response The result of a
CancelElasticsearchServiceSoftwareUpdateoperation. Contains the status of the update.- Cognito
Options Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
- Cognito
Options Status Status of the Cognito options for the specified Elasticsearch domain.
- Compatible
Versions Map A map from an
ElasticsearchVersionto a list of compatibleElasticsearchVersions to which the domain can be upgraded.- Create
Elasticsearch Domain Request - Create
Elasticsearch Domain Response The result of a
CreateElasticsearchDomainoperation. Contains the status of the newly created Elasticsearch domain.- Create
Outbound Cross Cluster Search Connection Request Container for the parameters to the
CreateOutboundCrossClusterSearchConnectionoperation.- Create
Outbound Cross Cluster Search Connection Response The result of a
CreateOutboundCrossClusterSearchConnectionrequest. Contains the details of the newly created cross-cluster search connection.- Create
Package Request Container for request parameters to
CreatePackageoperation.- Create
Package Response Container for response returned by
CreatePackageoperation.- Delete
Elasticsearch Domain Request Container for the parameters to the
DeleteElasticsearchDomainoperation. Specifies the name of the Elasticsearch domain that you want to delete.- Delete
Elasticsearch Domain Response The result of a
DeleteElasticsearchDomainrequest. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.- Delete
Inbound Cross Cluster Search Connection Request Container for the parameters to the
DeleteInboundCrossClusterSearchConnectionoperation.- Delete
Inbound Cross Cluster Search Connection Response The result of a
DeleteInboundCrossClusterSearchConnectionoperation. Contains details of deleted inbound connection.- Delete
Outbound Cross Cluster Search Connection Request Container for the parameters to the
DeleteOutboundCrossClusterSearchConnectionoperation.- Delete
Outbound Cross Cluster Search Connection Response The result of a
DeleteOutboundCrossClusterSearchConnectionoperation. Contains details of deleted outbound connection.- Delete
Package Request Container for request parameters to
DeletePackageoperation.- Delete
Package Response Container for response parameters to
DeletePackageoperation.- Describe
Elasticsearch Domain Config Request Container for the parameters to the
DescribeElasticsearchDomainConfigoperation. Specifies the domain name for which you want configuration information.- Describe
Elasticsearch Domain Config Response The result of a
DescribeElasticsearchDomainConfigrequest. Contains the configuration information of the requested domain.- Describe
Elasticsearch Domain Request Container for the parameters to the
DescribeElasticsearchDomainoperation.- Describe
Elasticsearch Domain Response The result of a
DescribeElasticsearchDomainrequest. Contains the status of the domain specified in the request.- Describe
Elasticsearch Domains Request Container for the parameters to the
DescribeElasticsearchDomainsoperation. By default, the API returns the status of all Elasticsearch domains.- Describe
Elasticsearch Domains Response The result of a
DescribeElasticsearchDomainsrequest. Contains the status of the specified domains or all domains owned by the account.- Describe
Elasticsearch Instance Type Limits Request Container for the parameters to
DescribeElasticsearchInstanceTypeLimitsoperation.- Describe
Elasticsearch Instance Type Limits Response Container for the parameters received from
DescribeElasticsearchInstanceTypeLimitsoperation.- Describe
Inbound Cross Cluster Search Connections Request Container for the parameters to the
DescribeInboundCrossClusterSearchConnectionsoperation.- Describe
Inbound Cross Cluster Search Connections Response The result of a
DescribeInboundCrossClusterSearchConnectionsrequest. Contains the list of connections matching the filter criteria.- Describe
Outbound Cross Cluster Search Connections Request Container for the parameters to the
DescribeOutboundCrossClusterSearchConnectionsoperation.- Describe
Outbound Cross Cluster Search Connections Response The result of a
DescribeOutboundCrossClusterSearchConnectionsrequest. Contains the list of connections matching the filter criteria.- Describe
Packages Filter Filter to apply in
DescribePackageresponse.- Describe
Packages Request Container for request parameters to
DescribePackageoperation.- Describe
Packages Response Container for response returned by
DescribePackagesoperation.- Describe
Reserved Elasticsearch Instance Offerings Request Container for parameters to
DescribeReservedElasticsearchInstanceOfferings- Describe
Reserved Elasticsearch Instance Offerings Response Container for results from
DescribeReservedElasticsearchInstanceOfferings- Describe
Reserved Elasticsearch Instances Request Container for parameters to
DescribeReservedElasticsearchInstances- Describe
Reserved Elasticsearch Instances Response Container for results from
DescribeReservedElasticsearchInstances- Dissociate
Package Request Container for request parameters to
DissociatePackageoperation.- Dissociate
Package Response Container for response returned by
DissociatePackageoperation.- Domain
Endpoint Options Options to configure endpoint for the Elasticsearch domain.
- Domain
Endpoint Options Status The configured endpoint options for the domain and their current status.
- Domain
Info - Domain
Information - Domain
Package Details Information on a package that is associated with a domain.
- EBSOptions
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
- EBSOptions
Status Status of the EBS options for the specified Elasticsearch domain.
- Elasticsearch
Cluster Config Specifies the configuration for the domain cluster, such as the type and number of instances.
- Elasticsearch
Cluster Config Status Specifies the configuration status for the specified Elasticsearch domain.
- Elasticsearch
Domain Config The configuration of an Elasticsearch domain.
- Elasticsearch
Domain Status The current status of an Elasticsearch domain.
- Elasticsearch
Version Status Status of the Elasticsearch version options for the specified Elasticsearch domain.
- Encryption
AtRest Options Specifies the Encryption At Rest Options.
- Encryption
AtRest Options Status Status of the Encryption At Rest options for the specified Elasticsearch domain.
- Error
Details - EsClient
- A client for the Amazon Elasticsearch Service API.
- Filter
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.
- GetCompatible
Elasticsearch Versions Request Container for request parameters to
GetCompatibleElasticsearchVersionsoperation.- GetCompatible
Elasticsearch Versions Response Container for response returned by
GetCompatibleElasticsearchVersionsoperation.- GetUpgrade
History Request Container for request parameters to
GetUpgradeHistoryoperation.- GetUpgrade
History Response Container for response returned by
GetUpgradeHistoryoperation.- GetUpgrade
Status Request Container for request parameters to
GetUpgradeStatusoperation.- GetUpgrade
Status Response Container for response returned by
GetUpgradeStatusoperation.- Inbound
Cross Cluster Search Connection Specifies details of an inbound connection.
- Inbound
Cross Cluster Search Connection Status Specifies the coonection status of an inbound cross-cluster search connection.
- Instance
Count Limits InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
- Instance
Limits InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
- Limits
Limits for given InstanceType and for each of it's role.
Limits contains followingStorageTypes,InstanceLimitsandAdditionalLimits- List
Domain Names Response The result of a
ListDomainNamesoperation. Contains the names of all Elasticsearch domains owned by this account.- List
Domains ForPackage Request Container for request parameters to
ListDomainsForPackageoperation.- List
Domains ForPackage Response Container for response parameters to
ListDomainsForPackageoperation.- List
Elasticsearch Instance Types Request Container for the parameters to the
ListElasticsearchInstanceTypesoperation.- List
Elasticsearch Instance Types Response Container for the parameters returned by
ListElasticsearchInstanceTypesoperation.- List
Elasticsearch Versions Request Container for the parameters to the
ListElasticsearchVersionsoperation.Use
MaxResultsto control the maximum number of results to retrieve in a single call.Use
NextTokenin response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.- List
Elasticsearch Versions Response Container for the parameters for response received from
ListElasticsearchVersionsoperation.- List
Packages ForDomain Request Container for request parameters to
ListPackagesForDomainoperation.- List
Packages ForDomain Response Container for response parameters to
ListPackagesForDomainoperation.- List
Tags Request Container for the parameters to the
ListTagsoperation. Specify theARNfor the Elasticsearch domain to which the tags are attached that you want to view are attached.- List
Tags Response The result of a
ListTagsoperation. Contains tags for all requested Elasticsearch domains.- LogPublishing
Option 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
- LogPublishing
Options Status The configured log publishing options for the domain and their current status.
- Master
User Options Credentials for the master user: username and password, ARN, or both.
- Node
ToNode Encryption Options Specifies the node-to-node encryption options.
- Node
ToNode Encryption Options Status Status of the node-to-node encryption options for the specified Elasticsearch domain.
- Option
Status Provides the current status of the entity.
- Outbound
Cross Cluster Search Connection Specifies details of an outbound connection.
- Outbound
Cross Cluster Search Connection Status Specifies the connection status of an outbound cross-cluster search connection.
- Package
Details Basic information about a package.
- Package
Source The S3 location for importing the package specified as
S3BucketNameandS3Key- Purchase
Reserved Elasticsearch Instance Offering Request Container for parameters to
PurchaseReservedElasticsearchInstanceOffering- Purchase
Reserved Elasticsearch Instance Offering Response Represents the output of a
PurchaseReservedElasticsearchInstanceOfferingoperation.- Recurring
Charge Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
- Reject
Inbound Cross Cluster Search Connection Request Container for the parameters to the
RejectInboundCrossClusterSearchConnectionoperation.- Reject
Inbound Cross Cluster Search Connection Response The result of a
RejectInboundCrossClusterSearchConnectionoperation. Contains details of rejected inbound connection.- Remove
Tags Request Container for the parameters to the
RemoveTagsoperation. Specify theARNfor the Elasticsearch domain from which you want to remove the specifiedTagKey.- Reserved
Elasticsearch Instance Details of a reserved Elasticsearch instance.
- Reserved
Elasticsearch Instance Offering Details of a reserved Elasticsearch instance offering.
- Service
Software Options The current options of an Elasticsearch domain service software options.
- Snapshot
Options Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is
0hours.- Snapshot
Options Status Status of a daily automated snapshot.
- Start
Elasticsearch Service Software Update Request Container for the parameters to the
StartElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.- Start
Elasticsearch Service Software Update Response The result of a
StartElasticsearchServiceSoftwareUpdateoperation. Contains the status of the update.- Storage
Type StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
- Storage
Type Limit Limits that are applicable for given storage type.
- Tag
Specifies a key value pair for a resource tag.
- Update
Elasticsearch Domain Config Request Container for the parameters to the
UpdateElasticsearchDomainoperation. Specifies the type and number of instances in the domain cluster.- Update
Elasticsearch Domain Config Response The result of an
UpdateElasticsearchDomainrequest. Contains the status of the Elasticsearch domain being updated.- Upgrade
Elasticsearch Domain Request Container for request parameters to
UpgradeElasticsearchDomainoperation.- Upgrade
Elasticsearch Domain Response Container for response returned by
UpgradeElasticsearchDomainoperation.- Upgrade
History History of the last 10 Upgrades and Upgrade Eligibility Checks.
- Upgrade
Step Item Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
- VPCDerived
Info Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
- VPCDerived
Info Status Status of the VPC options for the specified Elasticsearch domain.
- VPCOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
- Zone
Awareness Config Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.
Enums§
- Accept
Inbound Cross Cluster Search Connection Error - Errors returned by AcceptInboundCrossClusterSearchConnection
- AddTags
Error - Errors returned by AddTags
- Associate
Package Error - Errors returned by AssociatePackage
- Cancel
Elasticsearch Service Software Update Error - Errors returned by CancelElasticsearchServiceSoftwareUpdate
- Create
Elasticsearch Domain Error - Errors returned by CreateElasticsearchDomain
- Create
Outbound Cross Cluster Search Connection Error - Errors returned by CreateOutboundCrossClusterSearchConnection
- Create
Package Error - Errors returned by CreatePackage
- Delete
Elasticsearch Domain Error - Errors returned by DeleteElasticsearchDomain
- Delete
Elasticsearch Service Role Error - Errors returned by DeleteElasticsearchServiceRole
- Delete
Inbound Cross Cluster Search Connection Error - Errors returned by DeleteInboundCrossClusterSearchConnection
- Delete
Outbound Cross Cluster Search Connection Error - Errors returned by DeleteOutboundCrossClusterSearchConnection
- Delete
Package Error - Errors returned by DeletePackage
- Describe
Elasticsearch Domain Config Error - Errors returned by DescribeElasticsearchDomainConfig
- Describe
Elasticsearch Domain Error - Errors returned by DescribeElasticsearchDomain
- Describe
Elasticsearch Domains Error - Errors returned by DescribeElasticsearchDomains
- Describe
Elasticsearch Instance Type Limits Error - Errors returned by DescribeElasticsearchInstanceTypeLimits
- Describe
Inbound Cross Cluster Search Connections Error - Errors returned by DescribeInboundCrossClusterSearchConnections
- Describe
Outbound Cross Cluster Search Connections Error - Errors returned by DescribeOutboundCrossClusterSearchConnections
- Describe
Packages Error - Errors returned by DescribePackages
- Describe
Reserved Elasticsearch Instance Offerings Error - Errors returned by DescribeReservedElasticsearchInstanceOfferings
- Describe
Reserved Elasticsearch Instances Error - Errors returned by DescribeReservedElasticsearchInstances
- Dissociate
Package Error - Errors returned by DissociatePackage
- GetCompatible
Elasticsearch Versions Error - Errors returned by GetCompatibleElasticsearchVersions
- GetUpgrade
History Error - Errors returned by GetUpgradeHistory
- GetUpgrade
Status Error - Errors returned by GetUpgradeStatus
- List
Domain Names Error - Errors returned by ListDomainNames
- List
Domains ForPackage Error - Errors returned by ListDomainsForPackage
- List
Elasticsearch Instance Types Error - Errors returned by ListElasticsearchInstanceTypes
- List
Elasticsearch Versions Error - Errors returned by ListElasticsearchVersions
- List
Packages ForDomain Error - Errors returned by ListPackagesForDomain
- List
Tags Error - Errors returned by ListTags
- Purchase
Reserved Elasticsearch Instance Offering Error - Errors returned by PurchaseReservedElasticsearchInstanceOffering
- Reject
Inbound Cross Cluster Search Connection Error - Errors returned by RejectInboundCrossClusterSearchConnection
- Remove
Tags Error - Errors returned by RemoveTags
- Start
Elasticsearch Service Software Update Error - Errors returned by StartElasticsearchServiceSoftwareUpdate
- Update
Elasticsearch Domain Config Error - Errors returned by UpdateElasticsearchDomainConfig
- Upgrade
Elasticsearch Domain Error - Errors returned by UpgradeElasticsearchDomain
Traits§
- Es
- Trait representing the capabilities of the Amazon Elasticsearch Service API. Amazon Elasticsearch Service clients implement this trait.