@Generated(value="software.amazon.awssdk:codegen") public interface ElasticsearchClient extends SdkClient
builder()
method.
Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Attaches tags to an existing Elasticsearch domain.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Attaches tags to an existing Elasticsearch domain.
|
static ElasticsearchClientBuilder |
builder()
Create a builder that can be used to configure and create a
ElasticsearchClient. |
default CancelElasticsearchServiceSoftwareUpdateResponse |
cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest)
Cancels a scheduled service software update for an Amazon ES domain.
|
default CancelElasticsearchServiceSoftwareUpdateResponse |
cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest)
Cancels a scheduled service software update for an Amazon ES domain.
|
static ElasticsearchClient |
create()
Create a
ElasticsearchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateElasticsearchDomainResponse |
createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest)
Creates a new Elasticsearch domain.
|
default CreateElasticsearchDomainResponse |
createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)
Creates a new Elasticsearch domain.
|
default DeleteElasticsearchDomainResponse |
deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest)
Permanently deletes the specified Elasticsearch domain and all of its data.
|
default DeleteElasticsearchDomainResponse |
deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)
Permanently deletes the specified Elasticsearch domain and all of its data.
|
default DeleteElasticsearchServiceRoleResponse |
deleteElasticsearchServiceRole()
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
|
default DeleteElasticsearchServiceRoleResponse |
deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest)
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
|
default DeleteElasticsearchServiceRoleResponse |
deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest)
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
|
default DescribeElasticsearchDomainResponse |
describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest)
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,
domain endpoint, and domain ARN.
|
default DescribeElasticsearchDomainResponse |
describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,
domain endpoint, and domain ARN.
|
default DescribeElasticsearchDomainConfigResponse |
describeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest)
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation
date, update version, and update date for cluster options.
|
default DescribeElasticsearchDomainConfigResponse |
describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation
date, update version, and update date for cluster options.
|
default DescribeElasticsearchDomainsResponse |
describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest)
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,
domain endpoint, and domain ARN.
|
default DescribeElasticsearchDomainsResponse |
describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,
domain endpoint, and domain ARN.
|
default DescribeElasticsearchInstanceTypeLimitsResponse |
describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
|
default DescribeElasticsearchInstanceTypeLimitsResponse |
describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
|
default DescribeReservedElasticsearchInstanceOfferingsResponse |
describeReservedElasticsearchInstanceOfferings()
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstanceOfferingsResponse |
describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstanceOfferingsResponse |
describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstanceOfferingsIterable |
describeReservedElasticsearchInstanceOfferingsPaginator()
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstanceOfferingsIterable |
describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstanceOfferingsIterable |
describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)
Lists available reserved Elasticsearch instance offerings.
|
default DescribeReservedElasticsearchInstancesResponse |
describeReservedElasticsearchInstances()
Returns information about reserved Elasticsearch instances for this account.
|
default DescribeReservedElasticsearchInstancesResponse |
describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)
Returns information about reserved Elasticsearch instances for this account.
|
default DescribeReservedElasticsearchInstancesResponse |
describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)
Returns information about reserved Elasticsearch instances for this account.
|
default DescribeReservedElasticsearchInstancesIterable |
describeReservedElasticsearchInstancesPaginator()
Returns information about reserved Elasticsearch instances for this account.
|
default DescribeReservedElasticsearchInstancesIterable |
describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)
Returns information about reserved Elasticsearch instances for this account.
|
default DescribeReservedElasticsearchInstancesIterable |
describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)
Returns information about reserved Elasticsearch instances for this account.
|
default GetCompatibleElasticsearchVersionsResponse |
getCompatibleElasticsearchVersions()
Returns a list of upgrade compatible Elastisearch versions.
|
default GetCompatibleElasticsearchVersionsResponse |
getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest)
Returns a list of upgrade compatible Elastisearch versions.
|
default GetCompatibleElasticsearchVersionsResponse |
getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest)
Returns a list of upgrade compatible Elastisearch versions.
|
default GetUpgradeHistoryResponse |
getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
default GetUpgradeHistoryResponse |
getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
default GetUpgradeHistoryIterable |
getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
default GetUpgradeHistoryIterable |
getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
default GetUpgradeStatusResponse |
getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
|
default GetUpgradeStatusResponse |
getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
|
default ListDomainNamesResponse |
listDomainNames()
Returns the name of all Elasticsearch domains owned by the current user's account.
|
default ListDomainNamesResponse |
listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)
Returns the name of all Elasticsearch domains owned by the current user's account.
|
default ListDomainNamesResponse |
listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
Returns the name of all Elasticsearch domains owned by the current user's account.
|
default ListElasticsearchInstanceTypesResponse |
listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
default ListElasticsearchInstanceTypesResponse |
listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
default ListElasticsearchInstanceTypesIterable |
listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
default ListElasticsearchInstanceTypesIterable |
listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
default ListElasticsearchVersionsResponse |
listElasticsearchVersions()
List all supported Elasticsearch versions
|
default ListElasticsearchVersionsResponse |
listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)
List all supported Elasticsearch versions
|
default ListElasticsearchVersionsResponse |
listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)
List all supported Elasticsearch versions
|
default ListElasticsearchVersionsIterable |
listElasticsearchVersionsPaginator()
List all supported Elasticsearch versions
|
default ListElasticsearchVersionsIterable |
listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)
List all supported Elasticsearch versions
|
default ListElasticsearchVersionsIterable |
listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)
List all supported Elasticsearch versions
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns all tags for the given Elasticsearch domain.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Returns all tags for the given Elasticsearch domain.
|
default PurchaseReservedElasticsearchInstanceOfferingResponse |
purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest)
Allows you to purchase reserved Elasticsearch instances.
|
default PurchaseReservedElasticsearchInstanceOfferingResponse |
purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest)
Allows you to purchase reserved Elasticsearch instances.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified set of tags from the specified Elasticsearch domain.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified set of tags from the specified Elasticsearch domain.
|
static ServiceMetadata |
serviceMetadata() |
default StartElasticsearchServiceSoftwareUpdateResponse |
startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest)
Schedules a service software update for an Amazon ES domain.
|
default StartElasticsearchServiceSoftwareUpdateResponse |
startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest)
Schedules a service software update for an Amazon ES domain.
|
default UpdateElasticsearchDomainConfigResponse |
updateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest)
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type
and the number of instances.
|
default UpdateElasticsearchDomainConfigResponse |
updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type
and the number of instances.
|
default UpgradeElasticsearchDomainResponse |
upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest)
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch
version.
|
default UpgradeElasticsearchDomainResponse |
upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest)
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch
version.
|
serviceNameclosestatic final String SERVICE_NAME
static ElasticsearchClient create()
ElasticsearchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElasticsearchClientBuilder builder()
ElasticsearchClient.default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
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.
addTagsRequest - Container for the parameters to the AddTags operation. Specify the tags that you want
to attach to the Elasticsearch domain.BaseException - An error occurred while processing the request.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
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.
This is a convenience which creates an instance of the AddTagsRequest.Builder avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a request. Container
for the parameters to the AddTags operation. Specify the tags that you want to attach
to the Elasticsearch domain.BaseException - An error occurred while processing the request.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
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.
cancelElasticsearchServiceSoftwareUpdateRequest - 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.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
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.
This is a convenience which creates an instance of the
CancelElasticsearchServiceSoftwareUpdateRequest.Builder avoiding the need to create one manually via
CancelElasticsearchServiceSoftwareUpdateRequest.builder()
cancelElasticsearchServiceSoftwareUpdateRequest - A Consumer that will call methods on
CancelElasticsearchServiceSoftwareUpdateRequest.Builder to create a 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.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateElasticsearchDomainResponse createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
createElasticsearchDomainRequest - BaseException - An error occurred while processing the request.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateElasticsearchDomainResponse createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
This is a convenience which creates an instance of the CreateElasticsearchDomainRequest.Builder avoiding
the need to create one manually via CreateElasticsearchDomainRequest.builder()
createElasticsearchDomainRequest - A Consumer that will call methods on CreateElasticsearchDomainRequest.Builder to create a
request.BaseException - An error occurred while processing the request.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteElasticsearchDomainResponse deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
deleteElasticsearchDomainRequest - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the
name of the Elasticsearch domain that you want to delete.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteElasticsearchDomainResponse deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
This is a convenience which creates an instance of the DeleteElasticsearchDomainRequest.Builder avoiding
the need to create one manually via DeleteElasticsearchDomainRequest.builder()
deleteElasticsearchDomainRequest - A Consumer that will call methods on DeleteElasticsearchDomainRequest.Builder to create a
request. Container for the parameters to the DeleteElasticsearchDomain operation.
Specifies the name of the Elasticsearch domain that you want to delete.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole() throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
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.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondeleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest)default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
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.
deleteElasticsearchServiceRoleRequest - BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
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.
This is a convenience which creates an instance of the DeleteElasticsearchServiceRoleRequest.Builder
avoiding the need to create one manually via DeleteElasticsearchServiceRoleRequest.builder()
deleteElasticsearchServiceRoleRequest - A Consumer that will call methods on DeleteElasticsearchServiceRoleRequest.Builder to
create a request.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainResponse describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainResponse describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
This is a convenience which creates an instance of the DescribeElasticsearchDomainRequest.Builder
avoiding the need to create one manually via DescribeElasticsearchDomainRequest.builder()
describeElasticsearchDomainRequest - A Consumer that will call methods on DescribeElasticsearchDomainRequest.Builder to create
a request. Container for the parameters to the DescribeElasticsearchDomain operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
describeElasticsearchDomainConfigRequest - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies
the domain name for which you want configuration information.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
This is a convenience which creates an instance of the DescribeElasticsearchDomainConfigRequest.Builder
avoiding the need to create one manually via DescribeElasticsearchDomainConfigRequest.builder()
describeElasticsearchDomainConfigRequest - A Consumer that will call methods on DescribeElasticsearchDomainConfigRequest.Builder to
create a request. Container for the parameters to the DescribeElasticsearchDomainConfig
operation. Specifies the domain name for which you want configuration information.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainsResponse describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomainsRequest - Container for the parameters to the DescribeElasticsearchDomains operation. By
default, the API returns the status of all Elasticsearch domains.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchDomainsResponse describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
This is a convenience which creates an instance of the DescribeElasticsearchDomainsRequest.Builder
avoiding the need to create one manually via DescribeElasticsearchDomainsRequest.builder()
describeElasticsearchDomainsRequest - A Consumer that will call methods on DescribeElasticsearchDomainsRequest.Builder to create
a request. Container for the parameters to the DescribeElasticsearchDomains operation.
By default, the API returns the status of all Elasticsearch domains.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain,
specify the DomainName to know what Limits are supported for modifying.
describeElasticsearchInstanceTypeLimitsRequest - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain,
specify the DomainName to know what Limits are supported for modifying.
This is a convenience which creates an instance of the
DescribeElasticsearchInstanceTypeLimitsRequest.Builder avoiding the need to create one manually via
DescribeElasticsearchInstanceTypeLimitsRequest.builder()
describeElasticsearchInstanceTypeLimitsRequest - A Consumer that will call methods on
DescribeElasticsearchInstanceTypeLimitsRequest.Builder to create a request. Container for the
parameters to DescribeElasticsearchInstanceTypeLimits operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings() throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest)default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferingsResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstanceOfferingsRequest.Builder avoiding the need to create one manually
via DescribeReservedElasticsearchInstanceOfferingsRequest.builder()
describeReservedElasticsearchInstanceOfferingsRequest - A Consumer that will call methods on
DescribeReservedElasticsearchInstanceOfferingsRequest.Builder to create a request. Container for
parameters to DescribeReservedElasticsearchInstanceOfferingsResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator() throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
.describeReservedElasticsearchInstanceOfferingsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation.
ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest)default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
.describeReservedElasticsearchInstanceOfferingsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation.
describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferingsResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
.describeReservedElasticsearchInstanceOfferingsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstanceOfferingsRequest.Builder avoiding the need to create one manually
via DescribeReservedElasticsearchInstanceOfferingsRequest.builder()
describeReservedElasticsearchInstanceOfferingsRequest - A Consumer that will call methods on
DescribeReservedElasticsearchInstanceOfferingsRequest.Builder to create a request. Container for
parameters to DescribeReservedElasticsearchInstanceOfferingsResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances() throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest)default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstancesResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstancesRequest.Builder avoiding the need to create one manually via
DescribeReservedElasticsearchInstancesRequest.builder()
describeReservedElasticsearchInstancesRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstancesRequest.Builder
to create a request. Container for parameters to DescribeReservedElasticsearchInstancesResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator() throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
.describeReservedElasticsearchInstancesPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation.
ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest)default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
.describeReservedElasticsearchInstancesPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation.
describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstancesResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
.describeReservedElasticsearchInstancesPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstancesRequest.Builder avoiding the need to create one manually via
DescribeReservedElasticsearchInstancesRequest.builder()
describeReservedElasticsearchInstancesRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstancesRequest.Builder
to create a request. Container for parameters to DescribeReservedElasticsearchInstancesResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions() throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
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.
BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest)default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
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.
getCompatibleElasticsearchVersionsRequest - Container for request parameters to GetCompatibleElasticsearchVersions operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
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.
This is a convenience which creates an instance of the GetCompatibleElasticsearchVersionsRequest.Builder
avoiding the need to create one manually via GetCompatibleElasticsearchVersionsRequest.builder()
getCompatibleElasticsearchVersionsRequest - A Consumer that will call methods on GetCompatibleElasticsearchVersionsRequest.Builder to
create a request. Container for request parameters to
GetCompatibleElasticsearchVersions operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryResponse getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryResponse getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
This is a convenience which creates an instance of the GetUpgradeHistoryRequest.Builder avoiding the need
to create one manually via GetUpgradeHistoryRequest.builder()
getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request.
Container for request parameters to GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryIterable getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client
.getUpgradeHistoryPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)
operation.
getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryIterable getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client
.getUpgradeHistoryPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)
operation.
This is a convenience which creates an instance of the GetUpgradeHistoryRequest.Builder avoiding the need
to create one manually via GetUpgradeHistoryRequest.builder()
getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request.
Container for request parameters to GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
getUpgradeStatusRequest - Container for request parameters to GetUpgradeStatus operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeStatusResponse getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
This is a convenience which creates an instance of the GetUpgradeStatusRequest.Builder avoiding the need
to create one manually via GetUpgradeStatusRequest.builder()
getUpgradeStatusRequest - A Consumer that will call methods on GetUpgradeStatusRequest.Builder to create a request.
Container for request parameters to GetUpgradeStatus operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainNamesResponse listDomainNames() throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistDomainNames(ListDomainNamesRequest)default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
listDomainNamesRequest - BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
This is a convenience which creates an instance of the ListDomainNamesRequest.Builder avoiding the need
to create one manually via ListDomainNamesRequest.builder()
listDomainNamesRequest - A Consumer that will call methods on ListDomainNamesRequest.Builder to create a request.BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
This is a convenience which creates an instance of the ListElasticsearchInstanceTypesRequest.Builder
avoiding the need to create one manually via ListElasticsearchInstanceTypesRequest.builder()
listElasticsearchInstanceTypesRequest - A Consumer that will call methods on ListElasticsearchInstanceTypesRequest.Builder to
create a request. Container for the parameters to the ListElasticsearchInstanceTypes
operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client
.listElasticsearchInstanceTypesPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)
operation.
listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client
.listElasticsearchInstanceTypesPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)
operation.
This is a convenience which creates an instance of the ListElasticsearchInstanceTypesRequest.Builder
avoiding the need to create one manually via ListElasticsearchInstanceTypesRequest.builder()
listElasticsearchInstanceTypesRequest - A Consumer that will call methods on ListElasticsearchInstanceTypesRequest.Builder to
create a request. Container for the parameters to the ListElasticsearchInstanceTypes
operation.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchVersionsResponse listElasticsearchVersions() throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistElasticsearchVersions(ListElasticsearchVersionsRequest)default ListElasticsearchVersionsResponse listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
listElasticsearchVersionsRequest - 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.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchVersionsResponse listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
This is a convenience which creates an instance of the ListElasticsearchVersionsRequest.Builder avoiding
the need to create one manually via ListElasticsearchVersionsRequest.builder()
listElasticsearchVersionsRequest - A Consumer that will call methods on ListElasticsearchVersionsRequest.Builder to create a
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.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator() throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
.listElasticsearchVersionsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest)default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
.listElasticsearchVersionsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation.
listElasticsearchVersionsRequest - 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.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
.listElasticsearchVersionsPaginator(request);
for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)
operation.
This is a convenience which creates an instance of the ListElasticsearchVersionsRequest.Builder avoiding
the need to create one manually via ListElasticsearchVersionsRequest.builder()
listElasticsearchVersionsRequest - A Consumer that will call methods on ListElasticsearchVersionsRequest.Builder to create a
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.
BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns all tags for the given Elasticsearch domain.
listTagsRequest - 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.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns all tags for the given Elasticsearch domain.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a 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.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to purchase reserved Elasticsearch instances.
purchaseReservedElasticsearchInstanceOfferingRequest - Container for parameters to PurchaseReservedElasticsearchInstanceOfferingResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to purchase reserved Elasticsearch instances.
This is a convenience which creates an instance of the
PurchaseReservedElasticsearchInstanceOfferingRequest.Builder avoiding the need to create one manually via
PurchaseReservedElasticsearchInstanceOfferingRequest.builder()
purchaseReservedElasticsearchInstanceOfferingRequest - A Consumer that will call methods on
PurchaseReservedElasticsearchInstanceOfferingRequest.Builder to create a request. Container for
parameters to PurchaseReservedElasticsearchInstanceOfferingResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Removes the specified set of tags from the specified Elasticsearch domain.
removeTagsRequest - Container for the parameters to the RemoveTags operation. Specify the ARN
for the Elasticsearch domain from which you want to remove the specified TagKey.BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Removes the specified set of tags from the specified Elasticsearch domain.
This is a convenience which creates an instance of the RemoveTagsRequest.Builder avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a 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.BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Schedules a service software update for an Amazon ES domain.
startElasticsearchServiceSoftwareUpdateRequest - 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.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Schedules a service software update for an Amazon ES domain.
This is a convenience which creates an instance of the
StartElasticsearchServiceSoftwareUpdateRequest.Builder avoiding the need to create one manually via
StartElasticsearchServiceSoftwareUpdateRequest.builder()
startElasticsearchServiceSoftwareUpdateRequest - A Consumer that will call methods on
StartElasticsearchServiceSoftwareUpdateRequest.Builder to create a 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.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
updateElasticsearchDomainConfigRequest - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the
type and number of instances in the domain cluster.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
This is a convenience which creates an instance of the UpdateElasticsearchDomainConfigRequest.Builder
avoiding the need to create one manually via UpdateElasticsearchDomainConfigRequest.builder()
updateElasticsearchDomainConfigRequest - A Consumer that will call methods on UpdateElasticsearchDomainConfigRequest.Builder to
create a request. Container for the parameters to the UpdateElasticsearchDomain
operation. Specifies the type and number of instances in the domain cluster.BaseException - An error occurred while processing the request.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
upgradeElasticsearchDomainRequest - Container for request parameters to UpgradeElasticsearchDomain operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
This is a convenience which creates an instance of the UpgradeElasticsearchDomainRequest.Builder avoiding
the need to create one manually via UpgradeElasticsearchDomainRequest.builder()
upgradeElasticsearchDomainRequest - A Consumer that will call methods on UpgradeElasticsearchDomainRequest.Builder to create a
request. Container for request parameters to UpgradeElasticsearchDomain operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is
internal to the service) . Gives http status code of 500.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ElasticsearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.