Table of Contents
A low-level client representing Amazon DynamoDB Accelerator (DAX):
import boto3
client = boto3.client('dax')
These are the available methods:
Check if an operation can be paginated.
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'
},
],
SSESpecification={
'Enabled': True|False
}
)
[REQUIRED]
The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
[REQUIRED]
The compute and memory capacity of the nodes in the cluster.
[REQUIRED]
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to 2 or more.
Note
AWS recommends that you have at least two read replicas per cluster.
The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
The name of the subnet group to be used for the replication group.
Warning
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:
Example: sun:05:00-sun:09:00
Note
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
Note
The Amazon SNS topic owner must be same as the DAX cluster owner.
[REQUIRED]
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
A set of tags to associate with the DAX cluster.
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
The value of the tag. Tag values are case-sensitive and can be null.
Represents the settings used to enable server-side encryption on the cluster.
Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
(dict) --
Cluster (dict) --
A description of the DAX cluster that you have created.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
)
[REQUIRED]
The name of the parameter group to apply to all of the clusters in this replication group.
dict
Response Syntax
{
'ParameterGroup': {
'ParameterGroupName': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
ParameterGroup (dict) --
Represents the output of a CreateParameterGroup action.
ParameterGroupName (string) --
The name of the parameter group.
Description (string) --
A description of the parameter group.
Creates a new subnet group.
See also: AWS API Documentation
Request Syntax
response = client.create_subnet_group(
SubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
[REQUIRED]
A name for the subnet group. This value is stored as a lowercase string.
[REQUIRED]
A list of VPC subnet IDs for the subnet group.
dict
Response Syntax
{
'SubnetGroup': {
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
}
}
Response Structure
(dict) --
SubnetGroup (dict) --
Represents the output of a CreateSubnetGroup operation.
SubnetGroupName (string) --
The name of the subnet group.
Description (string) --
The description of the subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
Subnets (list) --
A list of subnets associated with the subnet group.
(dict) --
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
SubnetIdentifier (string) --
The system-assigned identifier for the subnet.
SubnetAvailabilityZone (string) --
The Availability Zone (AZ) for subnet subnet.
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',
]
)
[REQUIRED]
The name of the DAX cluster from which you want to remove nodes.
[REQUIRED]
The new number of nodes for the DAX cluster.
The Availability Zone(s) from which to remove nodes.
The unique identifiers of the nodes to be removed from the cluster.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
(dict) --
Cluster (dict) --
A description of the DAX cluster, after you have decreased its replication factor.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
)
[REQUIRED]
The name of the cluster to be deleted.
{
'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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
A description of the DAX cluster that is being deleted.
The name of the DAX cluster.
The description of the cluster.
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
The total number of nodes in the cluster.
The number of nodes in the cluster that are active (i.e., capable of serving requests).
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
The current status of the cluster.
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
The DNS hostname of the endpoint.
The port number that applications should use to connect to the endpoint.
A list of nodes to be removed from the cluster.
A list of nodes that are currently in the cluster.
Represents an individual node within a DAX cluster.
A system-generated identifier for the node.
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
The DNS hostname of the endpoint.
The port number that applications should use to connect to the endpoint.
The date and time (in UNIX epoch format) when the node was launched.
The Availability Zone (AZ) in which the node has been deployed.
The current status of the node. For example: available .
The status of the parameter group associated with this node. For example, in-sync .
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
The Amazon Resource Name (ARN) that identifies the topic.
The current state of the topic.
The subnet group where the DAX cluster is running.
A list of security groups, and the status of each, for the nodes in the cluster.
An individual VPC security group and its status.
The unique ID for this security group.
The status of this security group.
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
The parameter group being used by nodes in the cluster.
The name of the parameter group.
The status of parameter updates.
The node IDs of one or more nodes to be rebooted.
The description of the server-side encryption status on the specified DAX cluster.
The current state of server-side encryption:
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'
)
[REQUIRED]
The name of the parameter group to delete.
{
'DeletionMessage': 'string'
}
Response Structure
A user-specified message for this action (i.e., a reason for deleting the parameter group).
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'
)
[REQUIRED]
The name of the subnet group to delete.
{
'DeletionMessage': 'string'
}
Response Structure
A user-specified message for this action (i.e., a reason for deleting the subnet group).
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'
)
The names of the DAX clusters being described.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
Clusters (list) --
The descriptions of your DAX clusters, in response to a DescribeClusters request.
(dict) --
Contains all of the attributes of a specific DAX cluster.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
)
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
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
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
Parameters (list) --
A list of parameters. Each element in the list represents one parameter.
(dict) --
Describes an individual setting that controls some aspect of DAX behavior.
ParameterName (string) --
The name of the parameter.
ParameterType (string) --
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
ParameterValue (string) --
The value for the parameter.
NodeTypeSpecificValues (list) --
A list of node types, and specific parameter values for each node.
(dict) --
Represents a parameter value that is applicable to a particular node type.
NodeType (string) --
A node type to which the parameter value applies.
Value (string) --
The parameter value for this node type.
Description (string) --
A description of the parameter
Source (string) --
How the parameter is defined. For example, system denotes a system-defined parameter.
DataType (string) --
The data type of the parameter. For example, integer :
AllowedValues (string) --
A range of values within which the parameter can be set.
IsModifiable (string) --
Whether the customer is allowed to modify the parameter.
ChangeType (string) --
The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.
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'
)
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
Response Syntax
{
'NextToken': 'string',
'Events': [
{
'SourceName': 'string',
'SourceType': 'CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
Events (list) --
An array of events. Each element in the array represents one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.
SourceName (string) --
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
SourceType (string) --
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
Message (string) --
A user-defined message associated with the event.
Date (datetime) --
The date and time when the event occurred.
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'
)
The names of the parameter groups.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
Response Syntax
{
'NextToken': 'string',
'ParameterGroups': [
{
'ParameterGroupName': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
ParameterGroups (list) --
An array of parameter groups. Each element in the array represents one parameter group.
(dict) --
A named set of parameters that are applied to all of the nodes in a DAX cluster.
ParameterGroupName (string) --
The name of the parameter group.
Description (string) --
A description of the parameter group.
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'
)
[REQUIRED]
The name of the parameter group.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
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
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
Parameters (list) --
A list of parameters within a parameter group. Each element in the list represents one parameter.
(dict) --
Describes an individual setting that controls some aspect of DAX behavior.
ParameterName (string) --
The name of the parameter.
ParameterType (string) --
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
ParameterValue (string) --
The value for the parameter.
NodeTypeSpecificValues (list) --
A list of node types, and specific parameter values for each node.
(dict) --
Represents a parameter value that is applicable to a particular node type.
NodeType (string) --
A node type to which the parameter value applies.
Value (string) --
The parameter value for this node type.
Description (string) --
A description of the parameter
Source (string) --
How the parameter is defined. For example, system denotes a system-defined parameter.
DataType (string) --
The data type of the parameter. For example, integer :
AllowedValues (string) --
A range of values within which the parameter can be set.
IsModifiable (string) --
Whether the customer is allowed to modify the parameter.
ChangeType (string) --
The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.
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'
)
The name of the subnet group.
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
dict
Response Syntax
{
'NextToken': 'string',
'SubnetGroups': [
{
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
Provides an identifier to allow retrieval of paginated results.
SubnetGroups (list) --
An array of subnet groups. Each element in the array represents a single subnet group.
(dict) --
Represents the output of one of the following actions:
SubnetGroupName (string) --
The name of the subnet group.
Description (string) --
The description of the subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
Subnets (list) --
A list of subnets associated with the subnet group.
(dict) --
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
SubnetIdentifier (string) --
The system-assigned identifier for the subnet.
SubnetAvailabilityZone (string) --
The Availability Zone (AZ) for subnet subnet.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
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',
]
)
[REQUIRED]
The name of the DAX cluster that will receive additional nodes.
[REQUIRED]
The new number of nodes for the DAX cluster.
The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
(dict) --
Cluster (dict) --
A description of the DAX cluster. with its new replication factor.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
)
[REQUIRED]
The name of the DAX resource to which the tags belong.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
A list of tags currently associated with the DAX cluster.
(dict) --
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
Key (string) --
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value (string) --
The value of the tag. Tag values are case-sensitive and can be null.
NextToken (string) --
If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.
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'
)
[REQUIRED]
The name of the DAX cluster containing the node to be rebooted.
[REQUIRED]
The system-assigned ID of the node to be rebooted.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
(dict) --
Cluster (dict) --
A description of the DAX cluster after a node has been rebooted.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
},
]
)
[REQUIRED]
The name of the DAX resource to which tags should be added.
[REQUIRED]
The tags to be assigned to the DAX resource.
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
The value of the tag. Tag values are case-sensitive and can be null.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The list of tags that are associated with the DAX resource.
(dict) --
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
Key (string) --
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value (string) --
The value of the tag. Tag values are case-sensitive and can be null.
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',
]
)
[REQUIRED]
The name of the DAX resource from which the tags should be removed.
[REQUIRED]
A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
The tag keys that have been removed from the cluster.
(dict) --
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
Key (string) --
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value (string) --
The value of the tag. Tag values are case-sensitive and can be null.
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',
]
)
[REQUIRED]
The name of the DAX cluster to be modified.
A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.
dict
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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
}
}
Response Structure
(dict) --
Cluster (dict) --
A description of the DAX cluster, after it has been modified.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
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'
},
]
)
[REQUIRED]
The name of the parameter group.
[REQUIRED]
An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.
An individual DAX parameter.
The name of the parameter.
The value of the parameter.
dict
Response Syntax
{
'ParameterGroup': {
'ParameterGroupName': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
ParameterGroup (dict) --
The parameter group that has been modified.
ParameterGroupName (string) --
The name of the parameter group.
Description (string) --
A description of the parameter group.
Modifies an existing subnet group.
See also: AWS API Documentation
Request Syntax
response = client.update_subnet_group(
SubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
[REQUIRED]
The name of the subnet group.
A list of subnet IDs in the subnet group.
dict
Response Syntax
{
'SubnetGroup': {
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
}
}
Response Structure
(dict) --
SubnetGroup (dict) --
The subnet group that has been modified.
SubnetGroupName (string) --
The name of the subnet group.
Description (string) --
The description of the subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
Subnets (list) --
A list of subnets associated with the subnet group.
(dict) --
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
SubnetIdentifier (string) --
The system-assigned identifier for the subnet.
SubnetAvailabilityZone (string) --
The Availability Zone (AZ) for subnet subnet.
The available paginators are:
paginator = client.get_paginator('describe_clusters')
Creates an iterator that will paginate through responses from DAX.Client.describe_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClusterNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the DAX clusters being described.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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',
]
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'
}
},
]
}
Response Structure
(dict) --
Clusters (list) --
The descriptions of your DAX clusters, in response to a DescribeClusters request.
(dict) --
Contains all of the attributes of a specific DAX cluster.
ClusterName (string) --
The name of the DAX cluster.
Description (string) --
The description of the cluster.
ClusterArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TotalNodes (integer) --
The total number of nodes in the cluster.
ActiveNodes (integer) --
The number of nodes in the cluster that are active (i.e., capable of serving requests).
NodeType (string) --
The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
Status (string) --
The current status of the cluster.
ClusterDiscoveryEndpoint (dict) --
The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeIdsToRemove (list) --
A list of nodes to be removed from the cluster.
Nodes (list) --
A list of nodes that are currently in the cluster.
(dict) --
Represents an individual node within a DAX cluster.
NodeId (string) --
A system-generated identifier for the node.
Endpoint (dict) --
The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.
Address (string) --
The DNS hostname of the endpoint.
Port (integer) --
The port number that applications should use to connect to the endpoint.
NodeCreateTime (datetime) --
The date and time (in UNIX epoch format) when the node was launched.
AvailabilityZone (string) --
The Availability Zone (AZ) in which the node has been deployed.
NodeStatus (string) --
The current status of the node. For example: available .
ParameterGroupStatus (string) --
The status of the parameter group associated with this node. For example, in-sync .
PreferredMaintenanceWindow (string) --
A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
SubnetGroup (string) --
The subnet group where the DAX cluster is running.
SecurityGroups (list) --
A list of security groups, and the status of each, for the nodes in the cluster.
(dict) --
An individual VPC security group and its status.
SecurityGroupIdentifier (string) --
The unique ID for this security group.
Status (string) --
The status of this security group.
IamRoleArn (string) --
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
ParameterGroup (dict) --
The parameter group being used by nodes in the cluster.
ParameterGroupName (string) --
The name of the parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
NodeIdsToReboot (list) --
The node IDs of one or more nodes to be rebooted.
SSEDescription (dict) --
The description of the server-side encryption status on the specified DAX cluster.
Status (string) --
The current state of server-side encryption:
paginator = client.get_paginator('describe_default_parameters')
Creates an iterator that will paginate through responses from DAX.Client.describe_default_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
A list of parameters. Each element in the list represents one parameter.
Describes an individual setting that controls some aspect of DAX behavior.
The name of the parameter.
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
The value for the parameter.
A list of node types, and specific parameter values for each node.
Represents a parameter value that is applicable to a particular node type.
A node type to which the parameter value applies.
The parameter value for this node type.
A description of the parameter
How the parameter is defined. For example, system denotes a system-defined parameter.
The data type of the parameter. For example, integer :
A range of values within which the parameter can be set.
Whether the customer is allowed to modify the parameter.
The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.
paginator = client.get_paginator('describe_events')
Creates an iterator that will paginate through responses from DAX.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceName='string',
SourceType='CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'SourceName': 'string',
'SourceType': 'CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Events (list) --
An array of events. Each element in the array represents one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.
SourceName (string) --
The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
SourceType (string) --
Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
Message (string) --
A user-defined message associated with the event.
Date (datetime) --
The date and time when the event occurred.
paginator = client.get_paginator('describe_parameter_groups')
Creates an iterator that will paginate through responses from DAX.Client.describe_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParameterGroupNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the parameter groups.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ParameterGroups': [
{
'ParameterGroupName': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
ParameterGroups (list) --
An array of parameter groups. Each element in the array represents one parameter group.
(dict) --
A named set of parameters that are applied to all of the nodes in a DAX cluster.
ParameterGroupName (string) --
The name of the parameter group.
Description (string) --
A description of the parameter group.
paginator = client.get_paginator('describe_parameters')
Creates an iterator that will paginate through responses from DAX.Client.describe_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParameterGroupName='string',
Source='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the parameter group.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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
(dict) --
Parameters (list) --
A list of parameters within a parameter group. Each element in the list represents one parameter.
(dict) --
Describes an individual setting that controls some aspect of DAX behavior.
ParameterName (string) --
The name of the parameter.
ParameterType (string) --
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
ParameterValue (string) --
The value for the parameter.
NodeTypeSpecificValues (list) --
A list of node types, and specific parameter values for each node.
(dict) --
Represents a parameter value that is applicable to a particular node type.
NodeType (string) --
A node type to which the parameter value applies.
Value (string) --
The parameter value for this node type.
Description (string) --
A description of the parameter
Source (string) --
How the parameter is defined. For example, system denotes a system-defined parameter.
DataType (string) --
The data type of the parameter. For example, integer :
AllowedValues (string) --
A range of values within which the parameter can be set.
IsModifiable (string) --
Whether the customer is allowed to modify the parameter.
ChangeType (string) --
The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.
paginator = client.get_paginator('describe_subnet_groups')
Creates an iterator that will paginate through responses from DAX.Client.describe_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubnetGroupNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of the subnet group.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SubnetGroups': [
{
'SubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': 'string'
},
]
},
]
}
Response Structure
(dict) --
SubnetGroups (list) --
An array of subnet groups. Each element in the array represents a single subnet group.
(dict) --
Represents the output of one of the following actions:
SubnetGroupName (string) --
The name of the subnet group.
Description (string) --
The description of the subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
Subnets (list) --
A list of subnets associated with the subnet group.
(dict) --
Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.
SubnetIdentifier (string) --
The system-assigned identifier for the subnet.
SubnetAvailabilityZone (string) --
The Availability Zone (AZ) for subnet subnet.
paginator = client.get_paginator('list_tags')
Creates an iterator that will paginate through responses from DAX.Client.list_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the DAX resource to which the tags belong.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
A list of tags currently associated with the DAX cluster.
(dict) --
A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: .
You cannot backdate the application of a tag.
Key (string) --
The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value (string) --
The value of the tag. Tag values are case-sensitive and can be null.