com.amazonaws.services.opensearch

Interface AmazonOpenSearch

All Known Subinterfaces:

AmazonOpenSearchAsync

All Known Implementing Classes:

AbstractAmazonOpenSearch, AbstractAmazonOpenSearchAsync, AmazonOpenSearchAsyncClient, AmazonOpenSearchClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonOpenSearch

Interface for accessing Amazon OpenSearch Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonOpenSearch instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptInboundConnectionResult	acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
AddTagsResult	addTags(AddTagsRequest addTagsRequest) Attaches tags to an existing Amazon OpenSearch Service domain.
AssociatePackageResult	associatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon OpenSearch Service domain.
AuthorizeVpcEndpointAccessResult	authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates an Amazon OpenSearch Service domain.
CreateOutboundConnectionResult	createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
CreatePackageResult	createPackage(CreatePackageRequest createPackageRequest) Creates a package for use with Amazon OpenSearch Service domains.
CreateVpcEndpointResult	createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes an Amazon OpenSearch Service domain and all of its data.
DeleteInboundConnectionResult	deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
DeleteOutboundConnectionResult	deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
DeletePackageResult	deletePackage(DeletePackageRequest deletePackageRequest) Deletes an Amazon OpenSearch Service package.
DeleteVpcEndpointResult	deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
DescribeDomainResult	describeDomain(DescribeDomainRequest describeDomainRequest) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
DescribeDomainAutoTunesResult	describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
DescribeDomainChangeProgressResult	describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
DescribeDomainConfigResult	describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) Returns the configuration of an Amazon OpenSearch Service domain.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest describeDomainsRequest) Returns domain configuration information about the specified Amazon OpenSearch Service domains.
DescribeInboundConnectionsResult	describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
DescribeOutboundConnectionsResult	describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
DescribePackagesResult	describePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to OpenSearch Service.
DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
DescribeReservedInstancesResult	describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
DescribeVpcEndpointsResult	describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
DissociatePackageResult	dissociatePackage(DissociatePackageRequest dissociatePackageRequest) 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 getCompatibleVersionsRequest) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
GetPackageVersionHistoryResult	getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
GetUpgradeHistoryResult	getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
GetUpgradeStatusResult	getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
ListDomainsForPackageResult	listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon OpenSearch Service domains associated with a given package.
ListInstanceTypeDetailsResult	listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
ListPackagesForDomainResult	listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with an Amazon OpenSearch Service domain.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Returns all resource tags for an Amazon OpenSearch Service domain.
ListVersionsResult	listVersions(ListVersionsRequest listVersionsRequest) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
ListVpcEndpointAccessResult	listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest) 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 listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
ListVpcEndpointsForDomainResult	listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) Allows you to purchase Amazon OpenSearch Service Reserved Instances.
RejectInboundConnectionResult	rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
RemoveTagsResult	removeTags(RemoveTagsRequest removeTagsRequest) Removes the specified set of tags from an Amazon OpenSearch Service domain.
RevokeVpcEndpointAccessResult	revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) 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 startServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon OpenSearch Service domain.
UpdateDomainConfigResult	updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
UpdatePackageResult	updatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon OpenSearch Service domains.
UpdateVpcEndpointResult	updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
UpgradeDomainResult	upgradeDomain(UpgradeDomainRequest upgradeDomainRequest) Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptInboundConnection

AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest)

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.

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

AddTagsResult addTags(AddTagsRequest addTagsRequest)

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.

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

AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest)

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

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

AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)

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

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

CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest)

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.

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

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

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

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

CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)

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.

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

CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)

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

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

CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)

Creates an Amazon OpenSearch Service-managed VPC endpoint.

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

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)

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

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

DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)

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.

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

DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)

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.

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

DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)

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

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

DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

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

DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)

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

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

DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)

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.

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

DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)

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.

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

DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)

Returns the configuration of an Amazon OpenSearch Service domain.

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

DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)

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

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

DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)

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.

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

DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)

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

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

DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)

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.

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

DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest)

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

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

DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)

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

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

DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)

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

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

DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)

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

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

DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest)

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.

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

GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)

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

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

GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

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.

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

GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)

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

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

GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)

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

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

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

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

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

ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)

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

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

ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)

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

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

ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)

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

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

ListTagsResult listTags(ListTagsRequest listTagsRequest)

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

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

ListVersionsResult listVersions(ListVersionsRequest listVersionsRequest)

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

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

ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)

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.

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

ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)

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

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

ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)

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

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

PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

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

RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)

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

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

RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest)

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

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

RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)

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

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

StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)

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

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

UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)

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

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

UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest)

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

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

UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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

UpgradeDomainResult upgradeDomain(UpgradeDomainRequest upgradeDomainRequest)

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

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.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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