com.amazonaws.services.dax.AmazonDax Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.dax;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.dax.model.*;
/**
* Interface for accessing Amazon DAX.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.dax.AbstractAmazonDax} instead.
*
*
*
* DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching
* frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can
* create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your
* application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDax {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "dax";
/**
*
* Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
*
*
* @param createClusterRequest
* @return Result of the CreateCluster operation returned by the service.
* @throws ClusterAlreadyExistsException
* You already have a DAX cluster with the given identifier.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws InsufficientClusterCapacityException
* There are not enough system resources to create the cluster you requested (or to resize an
* already-existing cluster).
* @throws SubnetGroupNotFoundException
* The requested subnet group name does not refer to an existing subnet group.
* @throws InvalidParameterGroupStateException
* One or more parameters in a parameter group are in an invalid state.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ClusterQuotaForCustomerExceededException
* You have attempted to exceed the maximum number of DAX clusters for your AWS account.
* @throws NodeQuotaForClusterExceededException
* You have attempted to exceed the maximum number of nodes for a DAX cluster.
* @throws NodeQuotaForCustomerExceededException
* You have attempted to exceed the maximum number of nodes for your AWS account.
* @throws InvalidVPCNetworkStateException
* The VPC network is in an invalid state.
* @throws TagQuotaPerResourceExceededException
* You have exceeded the maximum number of tags for this DAX cluster.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @throws ServiceQuotaExceededException
* You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a
* 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted
* clusters.
* @sample AmazonDax.CreateCluster
* @see AWS API
* Documentation
*/
CreateClusterResult createCluster(CreateClusterRequest createClusterRequest);
/**
*
* Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes
* in a DAX cluster.
*
*
* @param createParameterGroupRequest
* @return Result of the CreateParameterGroup operation returned by the service.
* @throws ParameterGroupQuotaExceededException
* You have attempted to exceed the maximum number of parameter groups.
* @throws ParameterGroupAlreadyExistsException
* The specified parameter group already exists.
* @throws InvalidParameterGroupStateException
* One or more parameters in a parameter group are in an invalid state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.CreateParameterGroup
* @see AWS API
* Documentation
*/
CreateParameterGroupResult createParameterGroup(CreateParameterGroupRequest createParameterGroupRequest);
/**
*
* Creates a new subnet group.
*
*
* @param createSubnetGroupRequest
* @return Result of the CreateSubnetGroup operation returned by the service.
* @throws SubnetGroupAlreadyExistsException
* The specified subnet group already exists.
* @throws SubnetGroupQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
* @throws SubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @sample AmazonDax.CreateSubnetGroup
* @see AWS API
* Documentation
*/
CreateSubnetGroupResult createSubnetGroup(CreateSubnetGroupRequest createSubnetGroupRequest);
/**
*
* Removes one or more nodes from a DAX cluster.
*
*
*
* You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do
* this, use DeleteCluster instead.
*
*
*
* @param decreaseReplicationFactorRequest
* @return Result of the DecreaseReplicationFactor operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws NodeNotFoundException
* None of the nodes in the cluster have the given node ID.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DecreaseReplicationFactor
* @see AWS
* API Documentation
*/
DecreaseReplicationFactorResult decreaseReplicationFactor(DecreaseReplicationFactorRequest decreaseReplicationFactorRequest);
/**
*
* Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints
* and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins
* deleting the cluster; you cannot cancel or revert this action.
*
*
* @param deleteClusterRequest
* @return Result of the DeleteCluster operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DeleteCluster
* @see AWS API
* Documentation
*/
DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest);
/**
*
* Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX
* clusters.
*
*
* @param deleteParameterGroupRequest
* @return Result of the DeleteParameterGroup operation returned by the service.
* @throws InvalidParameterGroupStateException
* One or more parameters in a parameter group are in an invalid state.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DeleteParameterGroup
* @see AWS API
* Documentation
*/
DeleteParameterGroupResult deleteParameterGroup(DeleteParameterGroupRequest deleteParameterGroupRequest);
/**
*
* Deletes a subnet group.
*
*
*
* You cannot delete a subnet group if it is associated with any DAX clusters.
*
*
*
* @param deleteSubnetGroupRequest
* @return Result of the DeleteSubnetGroup operation returned by the service.
* @throws SubnetGroupInUseException
* The specified subnet group is currently in use.
* @throws SubnetGroupNotFoundException
* The requested subnet group name does not refer to an existing subnet group.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @sample AmazonDax.DeleteSubnetGroup
* @see AWS API
* Documentation
*/
DeleteSubnetGroupResult deleteSubnetGroup(DeleteSubnetGroupRequest deleteSubnetGroupRequest);
/**
*
* Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific
* DAX cluster if a cluster identifier is supplied.
*
*
* If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes
* are successfully provisioned.
*
*
* If the cluster is in the DELETING state, only cluster level information will be displayed.
*
*
* If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the
* additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is
* available, the cluster is ready for use.
*
*
* If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is
* displayed.
*
*
* @param describeClustersRequest
* @return Result of the DescribeClusters operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DescribeClusters
* @see AWS API
* Documentation
*/
DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest);
/**
*
* Returns the default system parameter information for the DAX caching software.
*
*
* @param describeDefaultParametersRequest
* @return Result of the DescribeDefaultParameters operation returned by the service.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DescribeDefaultParameters
* @see AWS
* API Documentation
*/
DescribeDefaultParametersResult describeDefaultParameters(DescribeDefaultParametersRequest describeDefaultParametersRequest);
/**
*
* Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX
* cluster or parameter group by providing the name as a parameter.
*
*
* By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14
* days' worth of events if necessary.
*
*
* @param describeEventsRequest
* @return Result of the DescribeEvents operation returned by the service.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DescribeEvents
* @see AWS API
* Documentation
*/
DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest);
/**
*
* Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain
* only the descriptions for that group.
*
*
* @param describeParameterGroupsRequest
* @return Result of the DescribeParameterGroups operation returned by the service.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DescribeParameterGroups
* @see AWS
* API Documentation
*/
DescribeParameterGroupsResult describeParameterGroups(DescribeParameterGroupsRequest describeParameterGroupsRequest);
/**
*
* Returns the detailed parameter list for a particular parameter group.
*
*
* @param describeParametersRequest
* @return Result of the DescribeParameters operation returned by the service.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.DescribeParameters
* @see AWS API
* Documentation
*/
DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest);
/**
*
* Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the
* description of that group.
*
*
* @param describeSubnetGroupsRequest
* @return Result of the DescribeSubnetGroups operation returned by the service.
* @throws SubnetGroupNotFoundException
* The requested subnet group name does not refer to an existing subnet group.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @sample AmazonDax.DescribeSubnetGroups
* @see AWS API
* Documentation
*/
DescribeSubnetGroupsResult describeSubnetGroups(DescribeSubnetGroupsRequest describeSubnetGroupsRequest);
/**
*
* Adds one or more nodes to a DAX cluster.
*
*
* @param increaseReplicationFactorRequest
* @return Result of the IncreaseReplicationFactor operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws InsufficientClusterCapacityException
* There are not enough system resources to create the cluster you requested (or to resize an
* already-existing cluster).
* @throws InvalidVPCNetworkStateException
* The VPC network is in an invalid state.
* @throws NodeQuotaForClusterExceededException
* You have attempted to exceed the maximum number of nodes for a DAX cluster.
* @throws NodeQuotaForCustomerExceededException
* You have attempted to exceed the maximum number of nodes for your AWS account.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.IncreaseReplicationFactor
* @see AWS
* API Documentation
*/
IncreaseReplicationFactorResult increaseReplicationFactor(IncreaseReplicationFactorRequest increaseReplicationFactorRequest);
/**
*
* List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per
* account.
*
*
* @param listTagsRequest
* @return Result of the ListTags operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws InvalidARNException
* The Amazon Resource Name (ARN) supplied in the request is not valid.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.ListTags
* @see AWS API
* Documentation
*/
ListTagsResult listTags(ListTagsRequest listTagsRequest);
/**
*
* Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the
* node status is set to REBOOTING.
*
*
*
* RebootNode restarts the DAX engine process and does not remove the contents of the cache.
*
*
*
* @param rebootNodeRequest
* @return Result of the RebootNode operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws NodeNotFoundException
* None of the nodes in the cluster have the given node ID.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.RebootNode
* @see AWS API
* Documentation
*/
RebootNodeResult rebootNode(RebootNodeRequest rebootNodeRequest);
/**
*
* Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per
* account.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws TagQuotaPerResourceExceededException
* You have exceeded the maximum number of tags for this DAX cluster.
* @throws InvalidARNException
* The Amazon Resource Name (ARN) supplied in the request is not valid.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per
* second, per account.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws InvalidARNException
* The Amazon Resource Name (ARN) supplied in the request is not valid.
* @throws TagNotFoundException
* The tag does not exist.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration
* parameters by specifying the parameters and the new values.
*
*
* @param updateClusterRequest
* @return Result of the UpdateCluster operation returned by the service.
* @throws InvalidClusterStateException
* The requested DAX cluster is not in the available state.
* @throws ClusterNotFoundException
* The requested cluster ID does not refer to an existing DAX cluster.
* @throws InvalidParameterGroupStateException
* One or more parameters in a parameter group are in an invalid state.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.UpdateCluster
* @see AWS API
* Documentation
*/
UpdateClusterResult updateCluster(UpdateClusterRequest updateClusterRequest);
/**
*
* Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by
* submitting a list parameter name and value pairs.
*
*
* @param updateParameterGroupRequest
* @return Result of the UpdateParameterGroup operation returned by the service.
* @throws InvalidParameterGroupStateException
* One or more parameters in a parameter group are in an invalid state.
* @throws ParameterGroupNotFoundException
* The specified parameter group does not exist.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @throws InvalidParameterValueException
* The value for a parameter is invalid.
* @throws InvalidParameterCombinationException
* Two or more incompatible parameters were specified.
* @sample AmazonDax.UpdateParameterGroup
* @see AWS API
* Documentation
*/
UpdateParameterGroupResult updateParameterGroup(UpdateParameterGroupRequest updateParameterGroupRequest);
/**
*
* Modifies an existing subnet group.
*
*
* @param updateSubnetGroupRequest
* @return Result of the UpdateSubnetGroup operation returned by the service.
* @throws SubnetGroupNotFoundException
* The requested subnet group name does not refer to an existing subnet group.
* @throws SubnetQuotaExceededException
* The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
* @throws SubnetInUseException
* The requested subnet is being used by another subnet group.
* @throws InvalidSubnetException
* An invalid subnet identifier was specified.
* @throws ServiceLinkedRoleNotFoundException
* The specified service linked role (SLR) was not found.
* @sample AmazonDax.UpdateSubnetGroup
* @see AWS API
* Documentation
*/
UpdateSubnetGroupResult updateSubnetGroup(UpdateSubnetGroupRequest updateSubnetGroupRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}