@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSElasticsearch extends Object implements AWSElasticsearch
AWSElasticsearch
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAWSElasticsearch() |
Modifier and Type | Method and Description |
---|---|
AddTagsResult |
addTags(AddTagsRequest request)
Attaches tags to an existing Elasticsearch domain.
|
CancelElasticsearchServiceSoftwareUpdateResult |
cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request)
Cancels a scheduled service software update for an Amazon ES domain.
|
CreateElasticsearchDomainResult |
createElasticsearchDomain(CreateElasticsearchDomainRequest request)
Creates a new Elasticsearch domain.
|
DeleteElasticsearchDomainResult |
deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)
Permanently deletes the specified Elasticsearch domain and all of its data.
|
DeleteElasticsearchServiceRoleResult |
deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
|
DescribeElasticsearchDomainResult |
describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,
domain endpoint, and domain ARN.
|
DescribeElasticsearchDomainConfigResult |
describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation
date, update version, and update date for cluster options.
|
DescribeElasticsearchDomainsResult |
describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,
domain endpoint, and domain ARN.
|
DescribeElasticsearchInstanceTypeLimitsResult |
describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
|
DescribeReservedElasticsearchInstanceOfferingsResult |
describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request)
Lists available reserved Elasticsearch instance offerings.
|
DescribeReservedElasticsearchInstancesResult |
describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request)
Returns information about reserved Elasticsearch instances for this account.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCompatibleElasticsearchVersionsResult |
getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request)
Returns a list of upgrade compatible Elastisearch versions.
|
GetUpgradeHistoryResult |
getUpgradeHistory(GetUpgradeHistoryRequest request)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
GetUpgradeStatusResult |
getUpgradeStatus(GetUpgradeStatusRequest request)
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
|
ListDomainNamesResult |
listDomainNames(ListDomainNamesRequest request)
Returns the name of all Elasticsearch domains owned by the current user's account.
|
ListElasticsearchInstanceTypesResult |
listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
ListElasticsearchVersionsResult |
listElasticsearchVersions(ListElasticsearchVersionsRequest request)
List all supported Elasticsearch versions
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns all tags for the given Elasticsearch domain.
|
PurchaseReservedElasticsearchInstanceOfferingResult |
purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request)
Allows you to purchase reserved Elasticsearch instances.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified set of tags from the specified Elasticsearch domain.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSElasticsearch.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartElasticsearchServiceSoftwareUpdateResult |
startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request)
Schedules a service software update for an Amazon ES domain.
|
UpdateElasticsearchDomainConfigResult |
updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type
and the number of instances.
|
UpgradeElasticsearchDomainResult |
upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request)
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch
version.
|
public void setEndpoint(String endpoint)
AWSElasticsearch
Callers can pass in just the endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://es.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSElasticsearch
endpoint
- The endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://es.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSElasticsearch
AWSElasticsearch.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSElasticsearch
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsResult addTags(AddTagsRequest request)
AWSElasticsearch
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
addTags
in interface AWSElasticsearch
request
- Container for the parameters to the AddTags
operation. Specify the tags that you want
to attach to the Elasticsearch domain.public CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request)
AWSElasticsearch
Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before
the AutomatedUpdateDate
and when the UpdateStatus
is in the PENDING_UPDATE
state.
cancelElasticsearchServiceSoftwareUpdate
in interface AWSElasticsearch
request
- Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate
operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software
update on.public CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest request)
AWSElasticsearch
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
createElasticsearchDomain
in interface AWSElasticsearch
public DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)
AWSElasticsearch
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
deleteElasticsearchDomain
in interface AWSElasticsearch
request
- Container for the parameters to the DeleteElasticsearchDomain
operation. Specifies the
name of the Elasticsearch domain that you want to delete.public DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)
AWSElasticsearch
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
deleteElasticsearchServiceRole
in interface AWSElasticsearch
public DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)
AWSElasticsearch
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomain
in interface AWSElasticsearch
request
- Container for the parameters to the DescribeElasticsearchDomain
operation.public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)
AWSElasticsearch
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
describeElasticsearchDomainConfig
in interface AWSElasticsearch
request
- Container for the parameters to the DescribeElasticsearchDomainConfig
operation. Specifies
the domain name for which you want configuration information.public DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)
AWSElasticsearch
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomains
in interface AWSElasticsearch
request
- Container for the parameters to the DescribeElasticsearchDomains
operation. By
default, the API returns the status of all Elasticsearch domains.public DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)
AWSElasticsearch
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain,
specify the DomainName
to know what Limits are supported for modifying.
describeElasticsearchInstanceTypeLimits
in interface AWSElasticsearch
request
- Container for the parameters to DescribeElasticsearchInstanceTypeLimits
operation.public DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request)
AWSElasticsearch
Lists available reserved Elasticsearch instance offerings.
describeReservedElasticsearchInstanceOfferings
in interface AWSElasticsearch
request
- Container for parameters to DescribeReservedElasticsearchInstanceOfferings
public DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request)
AWSElasticsearch
Returns information about reserved Elasticsearch instances for this account.
describeReservedElasticsearchInstances
in interface AWSElasticsearch
request
- Container for parameters to DescribeReservedElasticsearchInstances
public GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request)
AWSElasticsearch
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.
getCompatibleElasticsearchVersions
in interface AWSElasticsearch
request
- Container for request parameters to GetCompatibleElasticsearchVersions
operation.public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)
AWSElasticsearch
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
getUpgradeHistory
in interface AWSElasticsearch
request
- Container for request parameters to GetUpgradeHistory
operation.public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)
AWSElasticsearch
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
getUpgradeStatus
in interface AWSElasticsearch
request
- Container for request parameters to GetUpgradeStatus
operation.public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
AWSElasticsearch
Returns the name of all Elasticsearch domains owned by the current user's account.
listDomainNames
in interface AWSElasticsearch
public ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)
AWSElasticsearch
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
listElasticsearchInstanceTypes
in interface AWSElasticsearch
request
- Container for the parameters to the ListElasticsearchInstanceTypes
operation.public ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest request)
AWSElasticsearch
List all supported Elasticsearch versions
listElasticsearchVersions
in interface AWSElasticsearch
request
- Container for the parameters to the ListElasticsearchVersions
operation.
Use MaxResults
to control the maximum number of results to retrieve in a single
call.
Use NextToken
in response to retrieve more results. If the received response does
not contain a NextToken, then there are no more results to retrieve.
public ListTagsResult listTags(ListTagsRequest request)
AWSElasticsearch
Returns all tags for the given Elasticsearch domain.
listTags
in interface AWSElasticsearch
request
- Container for the parameters to the ListTags
operation. Specify the ARN
for the Elasticsearch domain to which the tags are attached that you want to view are attached.public PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request)
AWSElasticsearch
Allows you to purchase reserved Elasticsearch instances.
purchaseReservedElasticsearchInstanceOffering
in interface AWSElasticsearch
request
- Container for parameters to PurchaseReservedElasticsearchInstanceOffering
public RemoveTagsResult removeTags(RemoveTagsRequest request)
AWSElasticsearch
Removes the specified set of tags from the specified Elasticsearch domain.
removeTags
in interface AWSElasticsearch
request
- Container for the parameters to the RemoveTags
operation. Specify the ARN
for the Elasticsearch domain from which you want to remove the specified TagKey
.public StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request)
AWSElasticsearch
Schedules a service software update for an Amazon ES domain.
startElasticsearchServiceSoftwareUpdate
in interface AWSElasticsearch
request
- Container for the parameters to the StartElasticsearchServiceSoftwareUpdate
operation.
Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)
AWSElasticsearch
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
updateElasticsearchDomainConfig
in interface AWSElasticsearch
request
- Container for the parameters to the UpdateElasticsearchDomain
operation. Specifies the
type and number of instances in the domain cluster.public UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request)
AWSElasticsearch
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
upgradeElasticsearchDomain
in interface AWSElasticsearch
request
- Container for request parameters to UpgradeElasticsearchDomain
operation.public void shutdown()
AWSElasticsearch
shutdown
in interface AWSElasticsearch
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSElasticsearch
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSElasticsearch
request
- The originally executed request.Copyright © 2018. All rights reserved.