@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonOpenSearch extends Object implements AmazonOpenSearch
AmazonOpenSearch
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractAmazonOpenSearch() |
Modifier and Type | Method and Description |
---|---|
AcceptInboundConnectionResult |
acceptInboundConnection(AcceptInboundConnectionRequest request)
Allows the remote domain owner to accept an inbound cross-cluster connection request.
|
AddTagsResult |
addTags(AddTagsRequest request)
Attaches tags to an existing domain.
|
AssociatePackageResult |
associatePackage(AssociatePackageRequest request)
Associates a package with an Amazon OpenSearch Service domain.
|
CancelServiceSoftwareUpdateResult |
cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a new Amazon OpenSearch Service domain.
|
CreateOutboundConnectionResult |
createOutboundConnection(CreateOutboundConnectionRequest request)
Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
|
CreatePackageResult |
createPackage(CreatePackageRequest request)
Create a package for use with Amazon OpenSearch Service domains.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Permanently deletes the specified domain and all of its data.
|
DeleteInboundConnectionResult |
deleteInboundConnection(DeleteInboundConnectionRequest request)
Allows the remote domain owner to delete an existing inbound cross-cluster connection.
|
DeleteOutboundConnectionResult |
deleteOutboundConnection(DeleteOutboundConnectionRequest request)
Allows the local domain owner to delete an existing outbound cross-cluster connection.
|
DeletePackageResult |
deletePackage(DeletePackageRequest request)
Deletes the package.
|
DescribeDomainResult |
describeDomain(DescribeDomainRequest request)
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint,
and domain ARN.
|
DescribeDomainAutoTunesResult |
describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)
Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity,
and scheduled date.
|
DescribeDomainChangeProgressResult |
describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)
Returns information about the current blue/green deployment happening on a domain, including a change ID, status,
and progress stages.
|
DescribeDomainConfigResult |
describeDomainConfig(DescribeDomainConfigRequest request)
Provides cluster configuration information about the specified domain, such as the state, creation date, update
version, and update date for cluster options.
|
DescribeDomainsResult |
describeDomains(DescribeDomainsRequest request)
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint,
and domain ARN.
|
DescribeInboundConnectionsResult |
describeInboundConnections(DescribeInboundConnectionsRequest request)
Lists all the inbound cross-cluster connections for a remote domain.
|
DescribeInstanceTypeLimitsResult |
describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)
Describe the limits for a given instance type and OpenSearch or Elasticsearch version.
|
DescribeOutboundConnectionsResult |
describeOutboundConnections(DescribeOutboundConnectionsRequest request)
Lists all the outbound cross-cluster connections for a local domain.
|
DescribePackagesResult |
describePackages(DescribePackagesRequest request)
Describes all packages available to Amazon OpenSearch Service domains.
|
DescribeReservedInstanceOfferingsResult |
describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)
Lists available reserved OpenSearch instance offerings.
|
DescribeReservedInstancesResult |
describeReservedInstances(DescribeReservedInstancesRequest request)
Returns information about reserved OpenSearch instances for this account.
|
DissociatePackageResult |
dissociatePackage(DissociatePackageRequest request)
Dissociates a package from the 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 list of upgrade-compatible versions of OpenSearch/Elasticsearch.
|
GetPackageVersionHistoryResult |
getPackageVersionHistory(GetPackageVersionHistoryRequest request)
Returns a list of 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 the domain.
|
GetUpgradeStatusResult |
getUpgradeStatus(GetUpgradeStatusRequest request)
Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
|
ListDomainNamesResult |
listDomainNames(ListDomainNamesRequest request)
Returns the names of all domains owned by the current user's account.
|
ListDomainsForPackageResult |
listDomainsForPackage(ListDomainsForPackageRequest request)
Lists all Amazon OpenSearch Service domains associated with the package.
|
ListInstanceTypeDetailsResult |
listInstanceTypeDetails(ListInstanceTypeDetailsRequest request) |
ListPackagesForDomainResult |
listPackagesForDomain(ListPackagesForDomainRequest request)
Lists all packages associated with the Amazon OpenSearch Service domain.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns all tags for the given domain.
|
ListVersionsResult |
listVersions(ListVersionsRequest request)
List all supported versions of OpenSearch and Elasticsearch.
|
PurchaseReservedInstanceOfferingResult |
purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)
Allows you to purchase reserved OpenSearch instances.
|
RejectInboundConnectionResult |
rejectInboundConnection(RejectInboundConnectionRequest request)
Allows the remote domain owner to reject an inbound cross-cluster connection request.
|
RemoveTagsResult |
removeTags(RemoveTagsRequest request)
Removes the specified set of tags from the given domain.
|
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 domain, such as setting the instance type and the number of
instances.
|
UpdatePackageResult |
updatePackage(UpdatePackageRequest request)
Updates a package for use with Amazon OpenSearch Service domains.
|
UpgradeDomainResult |
upgradeDomain(UpgradeDomainRequest request)
Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of
OpenSearch or Elasticsearch.
|
public AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest request)
AmazonOpenSearch
Allows the remote domain owner to accept an inbound cross-cluster connection request.
acceptInboundConnection
in interface AmazonOpenSearch
request
- Container for the parameters to the AcceptInboundConnection
operation.public AddTagsResult addTags(AddTagsRequest request)
AmazonOpenSearch
Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
addTags
in interface AmazonOpenSearch
request
- Container for the parameters to the AddTags
operation. Specifies the tags to attach
to the domain.public AssociatePackageResult associatePackage(AssociatePackageRequest request)
AmazonOpenSearch
Associates a package with an Amazon OpenSearch Service domain.
associatePackage
in interface AmazonOpenSearch
request
- Container for the request parameters to the AssociatePackage
operation.public CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)
AmazonOpenSearch
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this
operation before the AutomatedUpdateDate
and when the UpdateStatus
is in the
PENDING_UPDATE
state.
cancelServiceSoftwareUpdate
in interface AmazonOpenSearch
request
- Container for the parameters to the CancelServiceSoftwareUpdate
operation. Specifies
the name of the domain that you wish to cancel a service software update on.public CreateDomainResult createDomain(CreateDomainRequest request)
AmazonOpenSearch
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
createDomain
in interface AmazonOpenSearch
public CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest request)
AmazonOpenSearch
Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
createOutboundConnection
in interface AmazonOpenSearch
request
- Container for the parameters to the CreateOutboundConnection
operation.public CreatePackageResult createPackage(CreatePackageRequest request)
AmazonOpenSearch
Create a package for use with Amazon OpenSearch Service domains.
createPackage
in interface AmazonOpenSearch
request
- Container for request parameters to the CreatePackage
operation.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonOpenSearch
Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
deleteDomain
in interface AmazonOpenSearch
request
- Container for the parameters to the DeleteDomain
operation. Specifies the name of
the domain you want to delete.public DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest request)
AmazonOpenSearch
Allows the remote domain owner to delete an existing inbound cross-cluster connection.
deleteInboundConnection
in interface AmazonOpenSearch
request
- Container for the parameters to the DeleteInboundConnection
operation.public DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest request)
AmazonOpenSearch
Allows the local domain owner to delete an existing outbound cross-cluster connection.
deleteOutboundConnection
in interface AmazonOpenSearch
request
- Container for the parameters to the DeleteOutboundConnection
operation.public DeletePackageResult deletePackage(DeletePackageRequest request)
AmazonOpenSearch
Deletes the package.
deletePackage
in interface AmazonOpenSearch
request
- Container for the request parameters to the DeletePackage
operation.public DescribeDomainResult describeDomain(DescribeDomainRequest request)
AmazonOpenSearch
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
describeDomain
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeDomain
operation.public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)
AmazonOpenSearch
Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
describeDomainAutoTunes
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeDomainAutoTunes
operation.public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)
AmazonOpenSearch
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
describeDomainChangeProgress
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeDomainChangeProgress
operation. Specifies the
domain name and optional change specific identity for which you want progress information.public DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest request)
AmazonOpenSearch
Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
describeDomainConfig
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeDomainConfig
operation. Specifies the domain name
for which you want configuration information.public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)
AmazonOpenSearch
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
describeDomains
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeDomains
operation. By default, the API
returns the status of all domains.public DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest request)
AmazonOpenSearch
Lists all the inbound cross-cluster connections for a remote domain.
describeInboundConnections
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeInboundConnections
operation.public DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)
AmazonOpenSearch
Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing
domain, specify the DomainName
to see which limits you can modify.
describeInstanceTypeLimits
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeInstanceTypeLimits
operation.public DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest request)
AmazonOpenSearch
Lists all the outbound cross-cluster connections for a local domain.
describeOutboundConnections
in interface AmazonOpenSearch
request
- Container for the parameters to the DescribeOutboundConnections
operation.public DescribePackagesResult describePackages(DescribePackagesRequest request)
AmazonOpenSearch
Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
describePackages
in interface AmazonOpenSearch
request
- Container for the request parameters to the DescribePackage
operation.public DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)
AmazonOpenSearch
Lists available reserved OpenSearch instance offerings.
describeReservedInstanceOfferings
in interface AmazonOpenSearch
request
- Container for parameters to DescribeReservedInstanceOfferings
public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)
AmazonOpenSearch
Returns information about reserved OpenSearch instances for this account.
describeReservedInstances
in interface AmazonOpenSearch
request
- Container for parameters to DescribeReservedInstances
public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)
AmazonOpenSearch
Dissociates a package from the Amazon OpenSearch Service domain.
dissociatePackage
in interface AmazonOpenSearch
request
- Container for the request parameters to the DissociatePackage
operation.public GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest request)
AmazonOpenSearch
Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a
DomainName
to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that
specific domain.
getCompatibleVersions
in interface AmazonOpenSearch
request
- Container for the request parameters to GetCompatibleVersions
operation.public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)
AmazonOpenSearch
Returns a list of package versions, along with their creation time and commit message.
getPackageVersionHistory
in interface AmazonOpenSearch
request
- Container for the request parameters to the GetPackageVersionHistory
operation.public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)
AmazonOpenSearch
Retrieves the complete history of the last 10 upgrades performed on the domain.
getUpgradeHistory
in interface AmazonOpenSearch
request
- Container for the request parameters to the GetUpgradeHistory
operation.public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)
AmazonOpenSearch
Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
getUpgradeStatus
in interface AmazonOpenSearch
request
- Container for the request parameters to the GetUpgradeStatus
operation.public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
AmazonOpenSearch
Returns the names of all domains owned by the current user's account.
listDomainNames
in interface AmazonOpenSearch
request
- Container for the parameters to the ListDomainNames
operation.public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)
AmazonOpenSearch
Lists all Amazon OpenSearch Service domains associated with the package.
listDomainsForPackage
in interface AmazonOpenSearch
request
- Container for the request parameters to the ListDomainsForPackage
operation.public ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)
listInstanceTypeDetails
in interface AmazonOpenSearch
public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)
AmazonOpenSearch
Lists all packages associated with the Amazon OpenSearch Service domain.
listPackagesForDomain
in interface AmazonOpenSearch
request
- Container for the request parameters to the ListPackagesForDomain
operation.public ListTagsResult listTags(ListTagsRequest request)
AmazonOpenSearch
Returns all tags for the given domain.
listTags
in interface AmazonOpenSearch
request
- Container for the parameters to the ListTags
operation. Specify the ARN
of the domain that the tags you want to view are attached to.public ListVersionsResult listVersions(ListVersionsRequest request)
AmazonOpenSearch
List all supported versions of OpenSearch and Elasticsearch.
listVersions
in interface AmazonOpenSearch
request
- Container for the parameters to the ListVersions
operation.
Use MaxResults
to control the maximum number of results to retrieve in a single
call.
Use NextToken
in response to retrieve more results. If the received response does
not contain a NextToken, there are no more results to retrieve.
public PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)
AmazonOpenSearch
Allows you to purchase reserved OpenSearch instances.
purchaseReservedInstanceOffering
in interface AmazonOpenSearch
request
- Container for parameters to PurchaseReservedInstanceOffering
public RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest request)
AmazonOpenSearch
Allows the remote domain owner to reject an inbound cross-cluster connection request.
rejectInboundConnection
in interface AmazonOpenSearch
request
- Container for the parameters to the RejectInboundConnection
operation.public RemoveTagsResult removeTags(RemoveTagsRequest request)
AmazonOpenSearch
Removes the specified set of tags from the given domain.
removeTags
in interface AmazonOpenSearch
request
- Container for the parameters to the RemoveTags
operation. Specify the
ARN
for the domain from which you want to remove the specified TagKey
.public StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)
AmazonOpenSearch
Schedules a service software update for an Amazon OpenSearch Service domain.
startServiceSoftwareUpdate
in interface AmazonOpenSearch
request
- Container for the parameters to the StartServiceSoftwareUpdate
operation. Specifies
the name of the domain to schedule a service software update for.public UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest request)
AmazonOpenSearch
Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
updateDomainConfig
in interface AmazonOpenSearch
request
- Container for the parameters to the UpdateDomain
operation. Specifies the type and
number of instances in the domain cluster.public UpdatePackageResult updatePackage(UpdatePackageRequest request)
AmazonOpenSearch
Updates a package for use with Amazon OpenSearch Service domains.
updatePackage
in interface AmazonOpenSearch
request
- Container for request parameters to the UpdatePackage
operation.public UpgradeDomainResult upgradeDomain(UpgradeDomainRequest request)
AmazonOpenSearch
Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
upgradeDomain
in interface AmazonOpenSearch
request
- Container for the request parameters to UpgradeDomain
operation.public void shutdown()
AmazonOpenSearch
shutdown
in interface AmazonOpenSearch
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonOpenSearch
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AmazonOpenSearch
request
- The originally executed request.Copyright © 2022. All rights reserved.