com.amazonaws.services.opensearch

Class AmazonOpenSearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.opensearch.AmazonOpenSearchClient

All Implemented Interfaces:

AmazonOpenSearch

Direct Known Subclasses:

AmazonOpenSearchAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonOpenSearchClient
extends AmazonWebServiceClient
implements AmazonOpenSearch

Client for accessing Amazon OpenSearch Service. All service calls made using this client are blocking, and will not return until the service call completes.

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.opensearch.AmazonOpenSearch

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AcceptInboundConnectionResult	acceptInboundConnection(AcceptInboundConnectionRequest request) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
AddTagsResult	addTags(AddTagsRequest request) Attaches tags to an existing Amazon OpenSearch Service domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest request) Associates a package with an Amazon OpenSearch Service domain.
AuthorizeVpcEndpointAccessResult	authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
static AmazonOpenSearchClientBuilder	builder()
CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomainResult	createDomain(CreateDomainRequest request) Creates an Amazon OpenSearch Service domain.
CreateOutboundConnectionResult	createOutboundConnection(CreateOutboundConnectionRequest request) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
CreatePackageResult	createPackage(CreatePackageRequest request) Creates a package for use with Amazon OpenSearch Service domains.
CreateVpcEndpointResult	createVpcEndpoint(CreateVpcEndpointRequest request) Creates an Amazon OpenSearch Service-managed VPC endpoint.
DeleteDomainResult	deleteDomain(DeleteDomainRequest request) Deletes an Amazon OpenSearch Service domain and all of its data.
DeleteInboundConnectionResult	deleteInboundConnection(DeleteInboundConnectionRequest request) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundConnectionResult	deleteOutboundConnection(DeleteOutboundConnectionRequest request) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
DeletePackageResult	deletePackage(DeletePackageRequest request) Deletes an Amazon OpenSearch Service package.
DeleteVpcEndpointResult	deleteVpcEndpoint(DeleteVpcEndpointRequest request) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
DescribeDomainResult	describeDomain(DescribeDomainRequest request) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest request) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
DescribeDomainChangeProgressResult	describeDomainChangeProgress(DescribeDomainChangeProgressRequest request) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
DescribeDomainConfigResult	describeDomainConfig(DescribeDomainConfigRequest request) Returns the configuration of an Amazon OpenSearch Service domain.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest request) Returns domain configuration information about the specified Amazon OpenSearch Service domains.
DescribeInboundConnectionsResult	describeInboundConnections(DescribeInboundConnectionsRequest request) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
DescribeOutboundConnectionsResult	describeOutboundConnections(DescribeOutboundConnectionsRequest request) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
DescribePackagesResult	describePackages(DescribePackagesRequest request) Describes all packages available to OpenSearch Service.
DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
DescribeReservedInstancesResult	describeReservedInstances(DescribeReservedInstancesRequest request) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
DescribeVpcEndpointsResult	describeVpcEndpoints(DescribeVpcEndpointsRequest request) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest request) Removes a package from the specified Amazon OpenSearch Service domain.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCompatibleVersionsResult	getCompatibleVersions(GetCompatibleVersionsRequest request) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest request) Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest request) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest request) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest request) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest request) Lists all Amazon OpenSearch Service domains associated with a given package.
ListInstanceTypeDetailsResult	listInstanceTypeDetails(ListInstanceTypeDetailsRequest request) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest request) Lists all packages associated with an Amazon OpenSearch Service domain.
ListTagsResult	listTags(ListTagsRequest request) Returns all resource tags for an Amazon OpenSearch Service domain.
ListVersionsResult	listVersions(ListVersionsRequest request) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
ListVpcEndpointAccessResult	listVpcEndpointAccess(ListVpcEndpointAccessRequest request) Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
ListVpcEndpointsResult	listVpcEndpoints(ListVpcEndpointsRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
ListVpcEndpointsForDomainResult	listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request) Allows you to purchase Amazon OpenSearch Service Reserved Instances.
RejectInboundConnectionResult	rejectInboundConnection(RejectInboundConnectionRequest request) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest request) Removes the specified set of tags from an Amazon OpenSearch Service domain.
RevokeVpcEndpointAccessResult	revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartServiceSoftwareUpdateResult	startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request) Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDomainConfigResult	updateDomainConfig(UpdateDomainConfigRequest request) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
UpdatePackageResult	updatePackage(UpdatePackageRequest request) Updates a package for use with Amazon OpenSearch Service domains.
UpdateVpcEndpointResult	updateVpcEndpoint(UpdateVpcEndpointRequest request) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
UpgradeDomainResult	upgradeDomain(UpgradeDomainRequest request) Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonOpenSearchClientBuilder builder()

acceptInboundConnection

public AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest request)

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

acceptInboundConnection in interface AmazonOpenSearch

Parameters:

acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.

Returns:

Result of the AcceptInboundConnection operation returned by the service.

Throws:

ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. 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.

addTags

public AddTagsResult addTags(AddTagsRequest request)

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

Specified by:

addTags in interface AmazonOpenSearch

Parameters:

addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.

Returns:

Result of the AddTags operation returned by the service.

Throws:

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.

associatePackage

public AssociatePackageResult associatePackage(AssociatePackageRequest request)

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

associatePackage in interface AmazonOpenSearch

Parameters:

associatePackageRequest - Container for the request parameters to the AssociatePackage operation.

Returns:

Result of the AssociatePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

authorizeVpcEndpointAccess

public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Specified by:

authorizeVpcEndpointAccess in interface AmazonOpenSearch

Parameters:

authorizeVpcEndpointAccessRequest -

Returns:

Result of the AuthorizeVpcEndpointAccess operation returned by the service.

Throws:

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.

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.

BaseException - An error occurred while processing the request.

cancelServiceSoftwareUpdate

public CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Specified by:

cancelServiceSoftwareUpdate in interface AmazonOpenSearch

Parameters:

cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.

Returns:

Result of the CancelServiceSoftwareUpdate operation returned by the service.

Throws:

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.

createDomain

public CreateDomainResult createDomain(CreateDomainRequest request)

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Specified by:

createDomain in interface AmazonOpenSearch

Parameters:

createDomainRequest -

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

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.

createOutboundConnection

public CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest request)

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

createOutboundConnection in interface AmazonOpenSearch

Parameters:

createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.

Returns:

Result of the CreateOutboundConnection operation returned by the service.

Throws:

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. 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.

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.

createPackage

public CreatePackageResult createPackage(CreatePackageRequest request)

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

createPackage in interface AmazonOpenSearch

Parameters:

createPackageRequest - Container for request parameters to the CreatePackage operation.

Returns:

Result of the CreatePackage operation returned by the service.

Throws:

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.

LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

createVpcEndpoint

public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Specified by:

createVpcEndpoint in interface AmazonOpenSearch

Parameters:

createVpcEndpointRequest -

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

Throws:

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

ValidationException - An exception for missing / invalid input fields. 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.

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

deleteDomain

public DeleteDomainResult deleteDomain(DeleteDomainRequest request)

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

Specified by:

deleteDomain in interface AmazonOpenSearch

Parameters:

deleteDomainRequest - Container for the parameters to the DeleteDomain operation.

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

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.

deleteInboundConnection

public DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest request)

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

deleteInboundConnection in interface AmazonOpenSearch

Parameters:

deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.

Returns:

Result of the DeleteInboundConnection operation returned by the service.

Throws:

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.

deleteOutboundConnection

public DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest request)

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

deleteOutboundConnection in interface AmazonOpenSearch

Parameters:

deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.

Returns:

Result of the DeleteOutboundConnection operation returned by the service.

Throws:

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.

deletePackage

public DeletePackageResult deletePackage(DeletePackageRequest request)

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

deletePackage in interface AmazonOpenSearch

Parameters:

deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.

Returns:

Result of the DeletePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

deleteVpcEndpoint

public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Specified by:

deleteVpcEndpoint in interface AmazonOpenSearch

Parameters:

deleteVpcEndpointRequest -

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

Throws:

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.

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.

BaseException - An error occurred while processing the request.

describeDomain

public DescribeDomainResult describeDomain(DescribeDomainRequest request)

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

Specified by:

describeDomain in interface AmazonOpenSearch

Parameters:

describeDomainRequest - Container for the parameters to the DescribeDomain operation.

Returns:

Result of the DescribeDomain operation returned by the service.

Throws:

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.

describeDomainAutoTunes

public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Specified by:

describeDomainAutoTunes in interface AmazonOpenSearch

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

Throws:

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.

describeDomainChangeProgress

public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Specified by:

describeDomainChangeProgress in interface AmazonOpenSearch

Parameters:

describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.

Returns:

Result of the DescribeDomainChangeProgress operation returned by the service.

Throws:

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.

describeDomainConfig

public DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest request)

Returns the configuration of an Amazon OpenSearch Service domain.

Specified by:

describeDomainConfig in interface AmazonOpenSearch

Parameters:

describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.

Returns:

Result of the DescribeDomainConfig operation returned by the service.

Throws:

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.

describeDomains

public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Specified by:

describeDomains in interface AmazonOpenSearch

Parameters:

describeDomainsRequest - Container for the parameters to the DescribeDomains operation.

Returns:

Result of the DescribeDomains operation returned by the service.

Throws:

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.

describeInboundConnections

public DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest request)

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

describeInboundConnections in interface AmazonOpenSearch

Parameters:

describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.

Returns:

Result of the DescribeInboundConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an 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.

describeInstanceTypeLimits

public DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Specified by:

describeInstanceTypeLimits in interface AmazonOpenSearch

Parameters:

describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.

Returns:

Result of the DescribeInstanceTypeLimits operation returned by the service.

Throws:

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.

describeOutboundConnections

public DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest request)

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Specified by:

describeOutboundConnections in interface AmazonOpenSearch

Parameters:

describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.

Returns:

Result of the DescribeOutboundConnections operation returned by the service.

Throws:

InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an 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.

describePackages

public DescribePackagesResult describePackages(DescribePackagesRequest request)

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

describePackages in interface AmazonOpenSearch

Parameters:

describePackagesRequest - Container for the request parameters to the DescribePackage operation.

Returns:

Result of the DescribePackages operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

describeReservedInstanceOfferings

public DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Specified by:

describeReservedInstanceOfferings in interface AmazonOpenSearch

Parameters:

describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.

Returns:

Result of the DescribeReservedInstanceOfferings operation returned by the service.

Throws:

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.

describeReservedInstances

public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Specified by:

describeReservedInstances in interface AmazonOpenSearch

Parameters:

describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.

Returns:

Result of the DescribeReservedInstances operation returned by the service.

Throws:

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.

describeVpcEndpoints

public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Specified by:

describeVpcEndpoints in interface AmazonOpenSearch

Parameters:

describeVpcEndpointsRequest -

Returns:

Result of the DescribeVpcEndpoints operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

dissociatePackage

public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

dissociatePackage in interface AmazonOpenSearch

Parameters:

dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.

Returns:

Result of the DissociatePackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

getCompatibleVersions

public GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest request)

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Specified by:

getCompatibleVersions in interface AmazonOpenSearch

Parameters:

getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.

Returns:

Result of the GetCompatibleVersions operation returned by the service.

Throws:

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.

getPackageVersionHistory

public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)

Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

getPackageVersionHistory in interface AmazonOpenSearch

Parameters:

getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.

Returns:

Result of the GetPackageVersionHistory operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

getUpgradeHistory

public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Specified by:

getUpgradeHistory in interface AmazonOpenSearch

Parameters:

getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.

Returns:

Result of the GetUpgradeHistory operation returned by the service.

Throws:

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.

getUpgradeStatus

public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Specified by:

getUpgradeStatus in interface AmazonOpenSearch

Parameters:

getUpgradeStatusRequest - Container for the request parameters to the GetUpgradeStatus operation.

Returns:

Result of the GetUpgradeStatus operation returned by the service.

Throws:

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.

listDomainNames

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Specified by:

listDomainNames in interface AmazonOpenSearch

Parameters:

listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listDomainsForPackage

public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

listDomainsForPackage in interface AmazonOpenSearch

Parameters:

listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.

Returns:

Result of the ListDomainsForPackage operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listInstanceTypeDetails

public ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Specified by:

listInstanceTypeDetails in interface AmazonOpenSearch

Parameters:

listInstanceTypeDetailsRequest -

Returns:

Result of the ListInstanceTypeDetails operation returned by the service.

Throws:

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.

listPackagesForDomain

public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

listPackagesForDomain in interface AmazonOpenSearch

Parameters:

listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.

Returns:

Result of the ListPackagesForDomain operation returned by the service.

Throws:

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

listTags

public ListTagsResult listTags(ListTagsRequest request)

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Specified by:

listTags in interface AmazonOpenSearch

Parameters:

listTagsRequest - Container for the parameters to the ListTags operation.

Returns:

Result of the ListTags operation returned by the service.

Throws:

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.

listVersions

public ListVersionsResult listVersions(ListVersionsRequest request)

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

Specified by:

listVersions in interface AmazonOpenSearch

Parameters:

listVersionsRequest - Container for the request parameters to the ListVersions operation.

Returns:

Result of the ListVersions operation returned by the service.

Throws:

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.

listVpcEndpointAccess

public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Specified by:

listVpcEndpointAccess in interface AmazonOpenSearch

Parameters:

listVpcEndpointAccessRequest -

Returns:

Result of the ListVpcEndpointAccess operation returned by the service.

Throws:

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.

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.

BaseException - An error occurred while processing the request.

listVpcEndpoints

public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Specified by:

listVpcEndpoints in interface AmazonOpenSearch

Parameters:

listVpcEndpointsRequest -

Returns:

Result of the ListVpcEndpoints operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

BaseException - An error occurred while processing the request.

listVpcEndpointsForDomain

public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Specified by:

listVpcEndpointsForDomain in interface AmazonOpenSearch

Parameters:

listVpcEndpointsForDomainRequest -

Returns:

Result of the ListVpcEndpointsForDomain operation returned by the service.

Throws:

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.

DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.

BaseException - An error occurred while processing the request.

purchaseReservedInstanceOffering

public PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Specified by:

purchaseReservedInstanceOffering in interface AmazonOpenSearch

Parameters:

purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.

Returns:

Result of the PurchaseReservedInstanceOffering operation returned by the service.

Throws:

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.

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.

rejectInboundConnection

public RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest request)

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

Specified by:

rejectInboundConnection in interface AmazonOpenSearch

Parameters:

rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.

Returns:

Result of the RejectInboundConnection operation returned by the service.

Throws:

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.

removeTags

public RemoveTagsResult removeTags(RemoveTagsRequest request)

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Specified by:

removeTags in interface AmazonOpenSearch

Parameters:

removeTagsRequest - Container for the request parameters to the RemoveTags operation.

Returns:

Result of the RemoveTags operation returned by the service.

Throws:

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.

revokeVpcEndpointAccess

public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Specified by:

revokeVpcEndpointAccess in interface AmazonOpenSearch

Parameters:

revokeVpcEndpointAccessRequest -

Returns:

Result of the RevokeVpcEndpointAccess operation returned by the service.

Throws:

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.

BaseException - An error occurred while processing the request.

startServiceSoftwareUpdate

public StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Specified by:

startServiceSoftwareUpdate in interface AmazonOpenSearch

Parameters:

startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.

Returns:

Result of the StartServiceSoftwareUpdate operation returned by the service.

Throws:

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.

updateDomainConfig

public UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest request)

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Specified by:

updateDomainConfig in interface AmazonOpenSearch

Parameters:

updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.

Returns:

Result of the UpdateDomainConfig operation returned by the service.

Throws:

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.

updatePackage

public UpdatePackageResult updatePackage(UpdatePackageRequest request)

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Specified by:

updatePackage in interface AmazonOpenSearch

Parameters:

updatePackageRequest - Container for request parameters to the UpdatePackage operation.

Returns:

Result of the UpdatePackage operation returned by the service.

Throws:

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.

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.

AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.

ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.

updateVpcEndpoint

public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Specified by:

updateVpcEndpoint in interface AmazonOpenSearch

Parameters:

updateVpcEndpointRequest -

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

Throws:

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.

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.

ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.

BaseException - An error occurred while processing the request.

upgradeDomain

public UpgradeDomainResult upgradeDomain(UpgradeDomainRequest request)

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Specified by:

upgradeDomain in interface AmazonOpenSearch

Parameters:

upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.

Returns:

Result of the UpgradeDomain operation returned by the service.

Throws:

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.

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonOpenSearch

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonOpenSearch

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonOpenSearch

Overrides:

shutdown in class AmazonWebServiceClient