JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.opensearch

Interface AmazonOpenSearch

    • Method Detail

      • addTags

        AddTagsResult addTags(AddTagsRequest addTagsRequest)

        Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A 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 the allowed number of resources or sub-resources.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        AccessDeniedException - An error occurred because you don't have permissions to access the resource.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        BaseException - An error occurred while processing the request.

      • cancelDomainConfigChange

        CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)

        Cancels a pending configuration change on an Amazon OpenSearch Service domain.

        Parameters:
        cancelDomainConfigChangeRequest -
        Returns:
        Result of the CancelDomainConfigChange operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        AccessDeniedException - An error occurred because you don't have permissions to access the resource.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • describeDomainHealth

        DescribeDomainHealthResult describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest)

        Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

        Parameters:
        describeDomainHealthRequest - Container for the parameters to the DescribeDomainHealth operation.
        Returns:
        Result of the DescribeDomainHealth operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • describeDomainNodes

        DescribeDomainNodesResult describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest)

        Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

        Parameters:
        describeDomainNodesRequest - Container for the parameters to the DescribeDomainNodes operation.
        Returns:
        Result of the DescribeDomainNodes operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
        LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        AccessDeniedException - An error occurred because you don't have permissions to access the resource.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • getDataSource

        GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)

        Retrieves information about a direct query data source.

        Parameters:
        getDataSourceRequest - Container for the parameters to the GetDataSource operation.
        Returns:
        Result of the GetDataSource operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

      • getDomainMaintenanceStatus

        GetDomainMaintenanceStatusResult getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest)

        The status of the maintenance action.

        Parameters:
        getDomainMaintenanceStatusRequest - Container for the parameters to the GetDomainMaintenanceStatus operation.
        Returns:
        Result of the GetDomainMaintenanceStatus operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • getPackageVersionHistory

        GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)

        Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        AccessDeniedException - An error occurred because you don't have permissions to access the resource.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • listDomainMaintenances

        ListDomainMaintenancesResult listDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest)

        A list of maintenance actions for the domain.

        Parameters:
        listDomainMaintenancesRequest - Container for the parameters to the ListDomainMaintenances operation.
        Returns:
        Result of the ListDomainMaintenances operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • 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 accessing or deleting a resource that doesn't exist.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        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 - Request processing failed because of an unknown error, exception, or internal failure.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        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 - Request processing failed because of an unknown error, exception, or internal failure.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        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 doesn't exist.
        ResourceAlreadyExistsException - An exception for creating a resource that already exists.
        LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • 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 accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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 doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        BaseException - An error occurred while processing the request.

      • startDomainMaintenance

        StartDomainMaintenanceResult startDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest)

        Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

        Parameters:
        startDomainMaintenanceRequest - Container for the parameters to the StartDomainMaintenance operation.
        Returns:
        Result of the StartDomainMaintenance operation returned by the service.
        Throws:
        BaseException - An error occurred while processing the request.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.

      • 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 - Request processing failed because of an unknown error, exception, or internal failure.
        InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.
        LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.
        ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.

      • 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 doesn't exist.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.
        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 doesn't exist.
        ResourceAlreadyExistsException - An exception for creating a resource that already exists.
        DisabledOperationException - An error occured because the client wanted to access an unsupported operation.
        ValidationException - An exception for accessing or deleting a resource that doesn't exist.
        InternalException - Request processing failed because of an unknown error, exception, or internal failure.

      • 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.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /