Table of Contents
DAX.Client¶A low-level client representing Amazon DynamoDB Accelerator (DAX):
client = session.create_client('dax')
These are the available methods:
can_paginate()create_cluster()create_parameter_group()create_subnet_group()decrease_replication_factor()delete_cluster()delete_parameter_group()delete_subnet_group()describe_clusters()describe_default_parameters()describe_events()describe_parameter_groups()describe_parameters()describe_subnet_groups()generate_presigned_url()get_paginator()get_waiter()increase_replication_factor()list_tags()reboot_node()tag_resource()untag_resource()update_cluster()update_parameter_group()update_subnet_group()can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
create_cluster(**kwargs)¶Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
ClusterName='string',
NodeType='string',
Description='string',
ReplicationFactor=123,
AvailabilityZones=[
'string',
],
SubnetGroupName='string',
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
IamRoleArn='string',
ParameterGroupName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
create_parameter_group(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_parameter_group(
ParameterGroupName='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ParameterGroup': {
'ParameterGroupName': 'string',
'Description': 'string'
}
}
Response Structure
|
create_subnet_group(**kwargs)¶Creates a new subnet group.
See also: AWS API Documentation
Request Syntax
response = client.create_subnet_group(
SubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SubnetGroup': {
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
}
}
Response Structure
|
decrease_replication_factor(**kwargs)¶Removes one or more nodes from a DAX cluster.
Note
You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.
See also: AWS API Documentation
Request Syntax
response = client.decrease_replication_factor(
ClusterName='string',
NewReplicationFactor=123,
AvailabilityZones=[
'string',
],
NodeIdsToRemove=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
delete_cluster(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_cluster(
ClusterName='string'
)
| Parameters: | ClusterName (string) – [REQUIRED] The name of the cluster to be deleted. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
delete_parameter_group(**kwargs)¶Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_parameter_group(
ParameterGroupName='string'
)
| Parameters: | ParameterGroupName (string) – [REQUIRED] The name of the parameter group to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'DeletionMessage': 'string'
}
Response Structure
|
delete_subnet_group(**kwargs)¶Deletes a subnet group.
Note
You cannot delete a subnet group if it is associated with any DAX clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_subnet_group(
SubnetGroupName='string'
)
| Parameters: | SubnetGroupName (string) – [REQUIRED] The name of the subnet group to delete. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'DeletionMessage': 'string'
}
Response Structure
|
describe_clusters(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_clusters(
ClusterNames=[
'string',
],
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'Clusters': [
{
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
},
]
}
Response Structure
|
describe_default_parameters(**kwargs)¶Returns the default system parameter information for the DAX caching software.
See also: AWS API Documentation
Request Syntax
response = client.describe_default_parameters(
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterType': 'DEFAULT'|'NODE_TYPE_SPECIFIC',
'ParameterValue': 'string',
'NodeTypeSpecificValues': [
{
'NodeType': 'string',
'Value': 'string'
},
],
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': 'TRUE'|'FALSE'|'CONDITIONAL',
'ChangeType': 'IMMEDIATE'|'REQUIRES_REBOOT'
},
]
}
Response Structure
|
describe_events(**kwargs)¶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 hour are returned; however, you can retrieve up to 14 days’ worth of events if necessary.
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceName='string',
SourceType='CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'Events': [
{
'SourceName': 'string',
'SourceType': 'CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
|
describe_parameter_groups(**kwargs)¶Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_parameter_groups(
ParameterGroupNames=[
'string',
],
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'ParameterGroups': [
{
'ParameterGroupName': 'string',
'Description': 'string'
},
]
}
Response Structure
|
describe_parameters(**kwargs)¶Returns the detailed parameter list for a particular parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_parameters(
ParameterGroupName='string',
Source='string',
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterType': 'DEFAULT'|'NODE_TYPE_SPECIFIC',
'ParameterValue': 'string',
'NodeTypeSpecificValues': [
{
'NodeType': 'string',
'Value': 'string'
},
],
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': 'TRUE'|'FALSE'|'CONDITIONAL',
'ChangeType': 'IMMEDIATE'|'REQUIRES_REBOOT'
},
]
}
Response Structure
|
describe_subnet_groups(**kwargs)¶Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_subnet_groups(
SubnetGroupNames=[
'string',
],
MaxResults=123,
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'NextToken': 'string',
'SubnetGroups': [
{
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
},
]
}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶increase_replication_factor(**kwargs)¶Adds one or more nodes to a DAX cluster.
See also: AWS API Documentation
Request Syntax
response = client.increase_replication_factor(
ClusterName='string',
NewReplicationFactor=123,
AvailabilityZones=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceName='string',
NextToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
|
reboot_node(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.reboot_node(
ClusterName='string',
NodeId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
tag_resource(**kwargs)¶Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
untag_resource(**kwargs)¶Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceName='string',
TagKeys=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
update_cluster(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_cluster(
ClusterName='string',
Description='string',
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
NotificationTopicStatus='string',
ParameterGroupName='string',
SecurityGroupIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Cluster': {
'ClusterName': 'string',
'Description': 'string',
'ClusterArn': 'string',
'TotalNodes': 123,
'ActiveNodes': 123,
'NodeType': 'string',
'Status': 'string',
'ClusterDiscoveryEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeIdsToRemove': [
'string',
],
'Nodes': [
{
'NodeId': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'NodeCreateTime': datetime(2015, 1, 1),
'AvailabilityZone': 'string',
'NodeStatus': 'string',
'ParameterGroupStatus': 'string'
},
],
'PreferredMaintenanceWindow': 'string',
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'SubnetGroup': 'string',
'SecurityGroups': [
{
'SecurityGroupIdentifier': 'string',
'Status': 'string'
},
],
'IamRoleArn': 'string',
'ParameterGroup': {
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'NodeIdsToReboot': [
'string',
]
}
}
}
Response Structure
|
update_parameter_group(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_parameter_group(
ParameterGroupName='string',
ParameterNameValues=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ParameterGroup': {
'ParameterGroupName': 'string',
'Description': 'string'
}
}
Response Structure
|
update_subnet_group(**kwargs)¶Modifies an existing subnet group.
See also: AWS API Documentation
Request Syntax
response = client.update_subnet_group(
SubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'SubnetGroup': {
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
}
}
Response Structure
|
The available paginators are: