Table of Contents
MemoryDB.Client¶A low-level client representing Amazon MemoryDB
MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
import boto3
client = boto3.client('memorydb')
These are the available methods:
batch_update_cluster()can_paginate()close()copy_snapshot()create_acl()create_cluster()create_parameter_group()create_snapshot()create_subnet_group()create_user()delete_acl()delete_cluster()delete_parameter_group()delete_snapshot()delete_subnet_group()delete_user()describe_acls()describe_clusters()describe_engine_versions()describe_events()describe_parameter_groups()describe_parameters()describe_reserved_nodes()describe_reserved_nodes_offerings()describe_service_updates()describe_snapshots()describe_subnet_groups()describe_users()failover_shard()get_paginator()get_waiter()list_allowed_node_type_updates()list_tags()purchase_reserved_nodes_offering()reset_parameter_group()tag_resource()untag_resource()update_acl()update_cluster()update_parameter_group()update_subnet_group()update_user()batch_update_cluster(**kwargs)¶Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
See also: AWS API Documentation
Request Syntax
response = client.batch_update_cluster(
ClusterNames=[
'string',
],
ServiceUpdate={
'ServiceUpdateNameToApply': 'string'
}
)
[REQUIRED]
The cluster names to apply the updates.
The unique ID of the service update
The unique ID of the service update
dict
Response Syntax
{
'ProcessedClusters': [
{
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
},
],
'UnprocessedClusters': [
{
'ClusterName': 'string',
'ErrorType': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
ProcessedClusters (list) --
The list of clusters that have been updated.
(dict) --
Contains all of the attributes of a specific cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
UnprocessedClusters (list) --
The list of clusters where updates have not been applied.
(dict) --
A cluster whose updates have failed
ClusterName (string) --
The name of the cluster
ErrorType (string) --
The error type associated with the update failure
ErrorMessage (string) --
The error message associated with the update failure
Exceptions
MemoryDB.Client.exceptions.ServiceUpdateNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_snapshot(**kwargs)¶Makes a copy of an existing snapshot.
See also: AWS API Documentation
Request Syntax
response = client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of an existing snapshot from which to make a copy.
[REQUIRED]
A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
]
},
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
EngineVersion (string) --
The Redis engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.SnapshotAlreadyExistsFaultMemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.SnapshotQuotaExceededFaultMemoryDB.Client.exceptions.InvalidSnapshotStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionMemoryDB.Client.exceptions.TagQuotaPerResourceExceededcreate_acl(**kwargs)¶Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
See also: AWS API Documentation
Request Syntax
response = client.create_acl(
ACLName='string',
UserNames=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the Access Control List.
The list of users that belong to the Access Control List.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'ACL': {
'Name': 'string',
'Status': 'string',
'UserNames': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserNamesToRemove': [
'string',
],
'UserNamesToAdd': [
'string',
]
},
'Clusters': [
'string',
],
'ARN': 'string'
}
}
Response Structure
(dict) --
ACL (dict) --
The newly-created Access Control List.
Name (string) --
The name of the Access Control List
Status (string) --
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
UserNames (list) --
The list of user names that belong to the ACL.
MinimumEngineVersion (string) --
The minimum engine version supported for the ACL
PendingChanges (dict) --
A list of updates being applied to the ACL.
UserNamesToRemove (list) --
A list of user names being removed from the ACL
UserNamesToAdd (list) --
A list of users being added to the ACL
Clusters (list) --
A list of clusters associated with the ACL.
ARN (string) --
The Amazon Resource Name (ARN) of the ACL
Exceptions
MemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.DuplicateUserNameFaultMemoryDB.Client.exceptions.ACLAlreadyExistsFaultMemoryDB.Client.exceptions.DefaultUserRequiredMemoryDB.Client.exceptions.ACLQuotaExceededFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.TagQuotaPerResourceExceededcreate_cluster(**kwargs)¶Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
See also: AWS API Documentation
Request Syntax
response = client.create_cluster(
ClusterName='string',
NodeType='string',
ParameterGroupName='string',
Description='string',
NumShards=123,
NumReplicasPerShard=123,
SubnetGroupName='string',
SecurityGroupIds=[
'string',
],
MaintenanceWindow='string',
Port=123,
SnsTopicArn='string',
TLSEnabled=True|False,
KmsKeyId='string',
SnapshotArns=[
'string',
],
SnapshotName='string',
SnapshotRetentionLimit=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SnapshotWindow='string',
ACLName='string',
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
DataTiering=True|False
)
[REQUIRED]
The name of the cluster. This value must be unique as it also serves as the cluster identifier.
[REQUIRED]
The compute and memory capacity of the nodes in the cluster.
A list of security group names to associate with this cluster.
Specifies the weekly time range during which maintenance on the 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:
sunmontuewedthufrisatExample: sun:23:00-mon:01:30
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
[REQUIRED]
The name of the Access Control List to associate with the cluster.
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The newly-created cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.ClusterAlreadyExistsFaultMemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.ClusterQuotaForCustomerExceededFaultMemoryDB.Client.exceptions.NodeQuotaForClusterExceededFaultMemoryDB.Client.exceptions.NodeQuotaForCustomerExceededFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.InsufficientClusterCapacityFaultMemoryDB.Client.exceptions.InvalidVPCNetworkStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.ShardsPerClusterQuotaExceededFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionMemoryDB.Client.exceptions.InvalidCredentialsExceptionMemoryDB.Client.exceptions.TagQuotaPerResourceExceededMemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.InvalidACLStateFaultcreate_parameter_group(**kwargs)¶Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For more information, see Configuring engine parameters using parameter groups.
See also: AWS API Documentation
Request Syntax
response = client.create_parameter_group(
ParameterGroupName='string',
Family='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the parameter group.
[REQUIRED]
The name of the parameter group family that the parameter group can be used with.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'ParameterGroup': {
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
ParameterGroup (dict) --
The newly-created parameter group.
Name (string) --
The name of the parameter group
Family (string) --
The name of the parameter group family that this parameter group is compatible with.
Description (string) --
A description of the parameter group
ARN (string) --
The Amazon Resource Name (ARN) of the parameter group
Exceptions
MemoryDB.Client.exceptions.ParameterGroupQuotaExceededFaultMemoryDB.Client.exceptions.ParameterGroupAlreadyExistsFaultMemoryDB.Client.exceptions.InvalidParameterGroupStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.TagQuotaPerResourceExceededMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptioncreate_snapshot(**kwargs)¶Creates a copy of an entire cluster at a specific moment in time.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
ClusterName='string',
SnapshotName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The snapshot is created from this cluster.
[REQUIRED]
A name for the snapshot being created.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
]
},
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Snapshot (dict) --
The newly-created snapshot.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
EngineVersion (string) --
The Redis engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.SnapshotAlreadyExistsFaultMemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.SnapshotQuotaExceededFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.TagQuotaPerResourceExceededcreate_subnet_group(**kwargs)¶Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see Subnets and subnet groups.
See also: AWS API Documentation
Request Syntax
response = client.create_subnet_group(
SubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the subnet group.
[REQUIRED]
A list of VPC subnet IDs for the subnet group.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'SubnetGroup': {
'Name': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'Identifier': 'string',
'AvailabilityZone': {
'Name': 'string'
}
},
],
'ARN': 'string'
}
}
Response Structure
(dict) --
SubnetGroup (dict) --
The newly-created subnet group
Name (string) --
The name of the subnet group
Description (string) --
A 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 cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
Identifier (string) --
The unique identifier for the subnet.
AvailabilityZone (dict) --
The Availability Zone where the subnet resides
Name (string) --
The name of the Availability Zone.
ARN (string) --
The ARN (Amazon Resource Name) of the subnet group.
Exceptions
MemoryDB.Client.exceptions.SubnetGroupAlreadyExistsFaultMemoryDB.Client.exceptions.SubnetGroupQuotaExceededFaultMemoryDB.Client.exceptions.SubnetQuotaExceededFaultMemoryDB.Client.exceptions.InvalidSubnetMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.SubnetNotAllowedFaultMemoryDB.Client.exceptions.TagQuotaPerResourceExceededcreate_user(**kwargs)¶Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
See also: AWS API Documentation
Request Syntax
response = client.create_user(
UserName='string',
AuthenticationMode={
'Type': 'password',
'Passwords': [
'string',
]
},
AccessString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the user. This value must be unique as it also serves as the user identifier.
[REQUIRED]
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Indicates whether the user requires a password to authenticate. All newly-created users require a password.
The password(s) used for authentication
[REQUIRED]
Access permissions string used for this user.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'User': {
'Name': 'string',
'Status': 'string',
'AccessString': 'string',
'ACLNames': [
'string',
],
'MinimumEngineVersion': 'string',
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The newly-created user.
Name (string) --
The name of the user
Status (string) --
Indicates the user status. Can be "active", "modifying" or "deleting".
AccessString (string) --
Access permissions string used for this user.
ACLNames (list) --
The names of the Access Control Lists to which the user belongs
MinimumEngineVersion (string) --
The minimum engine version supported for the user
Authentication (dict) --
Denotes whether the user requires a password to authenticate.
Type (string) --
Indicates whether the user requires a password to authenticate.
PasswordCount (integer) --
The number of passwords belonging to the user. The maximum is two.
ARN (string) --
The Amazon Resource Name (ARN) of the user.
Exceptions
MemoryDB.Client.exceptions.UserAlreadyExistsFaultMemoryDB.Client.exceptions.UserQuotaExceededFaultMemoryDB.Client.exceptions.DuplicateUserNameFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionMemoryDB.Client.exceptions.TagQuotaPerResourceExceededdelete_acl(**kwargs)¶Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
See also: AWS API Documentation
Request Syntax
response = client.delete_acl(
ACLName='string'
)
[REQUIRED]
The name of the Access Control List to delete
{
'ACL': {
'Name': 'string',
'Status': 'string',
'UserNames': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserNamesToRemove': [
'string',
],
'UserNamesToAdd': [
'string',
]
},
'Clusters': [
'string',
],
'ARN': 'string'
}
}
Response Structure
The Access Control List object that has been deleted.
The name of the Access Control List
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
The list of user names that belong to the ACL.
The minimum engine version supported for the ACL
A list of updates being applied to the ACL.
A list of user names being removed from the ACL
A list of users being added to the ACL
A list of clusters associated with the ACL.
The Amazon Resource Name (ARN) of the ACL
Exceptions
MemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.InvalidACLStateFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptiondelete_cluster(**kwargs)¶Deletes a cluster. It also deletes all associated nodes and node endpoints
See also: AWS API Documentation
Request Syntax
response = client.delete_cluster(
ClusterName='string',
FinalSnapshotName='string'
)
[REQUIRED]
The name of the cluster to be deleted
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The cluster object that has been deleted
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.SnapshotAlreadyExistsFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondelete_parameter_group(**kwargs)¶Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. You cannot delete the default parameter groups in your account.
See also: AWS API Documentation
Request Syntax
response = client.delete_parameter_group(
ParameterGroupName='string'
)
[REQUIRED]
The name of the parameter group to delete.
{
'ParameterGroup': {
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
}
}
Response Structure
The parameter group that has been deleted.
The name of the parameter group
The name of the parameter group family that this parameter group is compatible with.
A description of the parameter group
The Amazon Resource Name (ARN) of the parameter group
Exceptions
MemoryDB.Client.exceptions.InvalidParameterGroupStateFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondelete_snapshot(**kwargs)¶Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot(
SnapshotName='string'
)
[REQUIRED]
The name of the snapshot to delete
{
'Snapshot': {
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
]
},
'DataTiering': 'true'|'false'
}
}
Response Structure
The snapshot object that has been deleted.
The name of the snapshot
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The ID of the KMS key used to encrypt the snapshot.
The ARN (Amazon Resource Name) of the snapshot.
The configuration of the cluster from which the snapshot was taken
The name of the cluster
The description of the cluster configuration
The node type used for the cluster
The Redis engine version used by the cluster
The specified maintenance window for the cluster
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
The port used by the cluster
The name of parameter group used by the cluster
The name of the subnet group used by the cluster
The ID of the VPC the cluster belongs to
The snapshot retention limit set by the cluster
The snapshot window set by the cluster
The number of shards in the cluster
The list of shards in the cluster
Provides details of a shard in a snapshot
The name of the shard
The configuration details of the shard
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
The number of read replica nodes in this shard.
The size of the shard's snapshot
The date and time that the shard's snapshot was created
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.InvalidSnapshotStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondelete_subnet_group(**kwargs)¶Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_subnet_group(
SubnetGroupName='string'
)
[REQUIRED]
The name of the subnet group to delete
{
'SubnetGroup': {
'Name': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'Identifier': 'string',
'AvailabilityZone': {
'Name': 'string'
}
},
],
'ARN': 'string'
}
}
Response Structure
The subnet group object that has been deleted.
The name of the subnet group
A description of the subnet group
The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
A list of subnets associated with the subnet group.
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
The unique identifier for the subnet.
The Availability Zone where the subnet resides
The name of the Availability Zone.
The ARN (Amazon Resource Name) of the subnet group.
Exceptions
MemoryDB.Client.exceptions.SubnetGroupInUseFaultMemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultdelete_user(**kwargs)¶Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
UserName='string'
)
[REQUIRED]
The name of the user to delete
{
'User': {
'Name': 'string',
'Status': 'string',
'AccessString': 'string',
'ACLNames': [
'string',
],
'MinimumEngineVersion': 'string',
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
}
}
Response Structure
The user object that has been deleted.
The name of the user
Indicates the user status. Can be "active", "modifying" or "deleting".
Access permissions string used for this user.
The names of the Access Control Lists to which the user belongs
The minimum engine version supported for the user
Denotes whether the user requires a password to authenticate.
Indicates whether the user requires a password to authenticate.
The number of passwords belonging to the user. The maximum is two.
The Amazon Resource Name (ARN) of the user.
Exceptions
MemoryDB.Client.exceptions.InvalidUserStateFaultMemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptiondescribe_acls(**kwargs)¶Returns a list of ACLs
See also: AWS API Documentation
Request Syntax
response = client.describe_acls(
ACLName='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ACLs': [
{
'Name': 'string',
'Status': 'string',
'UserNames': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserNamesToRemove': [
'string',
],
'UserNamesToAdd': [
'string',
]
},
'Clusters': [
'string',
],
'ARN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ACLs (list) --
The list of ACLs
(dict) --
An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
Name (string) --
The name of the Access Control List
Status (string) --
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
UserNames (list) --
The list of user names that belong to the ACL.
MinimumEngineVersion (string) --
The minimum engine version supported for the ACL
PendingChanges (dict) --
A list of updates being applied to the ACL.
UserNamesToRemove (list) --
A list of user names being removed from the ACL
UserNamesToAdd (list) --
A list of users being added to the ACL
Clusters (list) --
A list of clusters associated with the ACL.
ARN (string) --
The Amazon Resource Name (ARN) of the ACL
NextToken (string) --
If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Exceptions
MemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_clusters(**kwargs)¶Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
See also: AWS API Documentation
Request Syntax
response = client.describe_clusters(
ClusterName='string',
MaxResults=123,
NextToken='string',
ShowShardDetails=True|False
)
dict
Response Syntax
{
'NextToken': 'string',
'Clusters': [
{
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Clusters (list) --
A list of clusters
(dict) --
Contains all of the attributes of a specific cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_engine_versions(**kwargs)¶Returns a list of the available Redis engine versions.
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_versions(
EngineVersion='string',
ParameterGroupFamily='string',
MaxResults=123,
NextToken='string',
DefaultOnly=True|False
)
dict
Response Syntax
{
'NextToken': 'string',
'EngineVersions': [
{
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupFamily': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
EngineVersions (list) --
A list of engine version details. Each element in the list contains detailed information about one engine version.
(dict) --
Provides details of the Redis engine version
EngineVersion (string) --
The engine version
EnginePatchVersion (string) --
The patched engine version
ParameterGroupFamily (string) --
Specifies the name of the parameter group family to which the engine default parameters apply.
Exceptions
MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_events(**kwargs)¶Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, 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='node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Events': [
{
'SourceName': 'string',
'SourceType': 'node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Events (list) --
A list of events. Each element in the list contains detailed information about one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
SourceName (string) --
The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
SourceType (string) --
Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
Message (string) --
The text of the event.
Date (datetime) --
The date and time when the event occurred.
Exceptions
MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_parameter_groups(**kwargs)¶Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_parameter_groups(
ParameterGroupName='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ParameterGroups': [
{
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
ParameterGroups (list) --
A list of parameter groups. Each element in the list contains detailed information about one parameter group.
(dict) --
Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.
Name (string) --
The name of the parameter group
Family (string) --
The name of the parameter group family that this parameter group is compatible with.
Description (string) --
A description of the parameter group
ARN (string) --
The Amazon Resource Name (ARN) of the parameter group
Exceptions
MemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_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',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
he name of a specific parameter group to return details for.
dict
Response Syntax
{
'NextToken': 'string',
'Parameters': [
{
'Name': 'string',
'Value': 'string',
'Description': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'MinimumEngineVersion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Parameters (list) --
A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.
(dict) --
Describes an individual setting that controls some aspect of MemoryDB behavior.
Name (string) --
The name of the parameter
Value (string) --
The value of the parameter
Description (string) --
A description of the parameter
DataType (string) --
The parameter's data type
AllowedValues (string) --
The valid range of values for the parameter.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
Exceptions
MemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_reserved_nodes(**kwargs)¶Returns information about reserved nodes for this account, or about a specified reserved node.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_nodes(
ReservationId='string',
ReservedNodesOfferingId='string',
NodeType='string',
Duration='string',
OfferingType='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ReservedNodes': [
{
'ReservationId': 'string',
'ReservedNodesOfferingId': 'string',
'NodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'NodeCount': 123,
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReservedNodes (list) --
Returns information about reserved nodes for this account, or about a specified reserved node.
(dict) --
Represents the output of a PurchaseReservedNodesOffering operation.
ReservationId (string) --
A customer-specified identifier to track this reservation.
ReservedNodesOfferingId (string) --
The ID of the reserved node offering to purchase.
NodeType (string) --
The node type for the reserved nodes.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved node.
NodeCount (integer) --
The number of nodes that have been reserved.
OfferingType (string) --
The offering type of this reserved node.
State (string) --
The state of the reserved node.
RecurringCharges (list) --
The recurring price charged to run this reserved node.
(dict) --
The recurring charge to run this reserved node.
RecurringChargeAmount (float) --
The amount of the recurring charge to run this reserved node.
RecurringChargeFrequency (string) --
The frequency of the recurring price charged to run this reserved node.
ARN (string) --
The Amazon Resource Name (ARN) of the reserved node.
Exceptions
MemoryDB.Client.exceptions.ReservedNodeNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_reserved_nodes_offerings(**kwargs)¶Lists available reserved node offerings.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_nodes_offerings(
ReservedNodesOfferingId='string',
NodeType='string',
Duration='string',
OfferingType='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ReservedNodesOfferings': [
{
'ReservedNodesOfferingId': 'string',
'NodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
ReservedNodesOfferings (list) --
Lists available reserved node offerings.
(dict) --
The offering type of this node.
ReservedNodesOfferingId (string) --
The offering identifier.
NodeType (string) --
The node type for the reserved nodes. For more information, see Supported node types.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved node.
OfferingType (string) --
The offering type of this reserved node.
RecurringCharges (list) --
The recurring price charged to run this reserved node.
(dict) --
The recurring charge to run this reserved node.
RecurringChargeAmount (float) --
The amount of the recurring charge to run this reserved node.
RecurringChargeFrequency (string) --
The frequency of the recurring price charged to run this reserved node.
Exceptions
MemoryDB.Client.exceptions.ReservedNodesOfferingNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_service_updates(**kwargs)¶Returns details of the service updates
See also: AWS API Documentation
Request Syntax
response = client.describe_service_updates(
ServiceUpdateName='string',
ClusterNames=[
'string',
],
Status=[
'available'|'in-progress'|'complete'|'scheduled',
],
MaxResults=123,
NextToken='string'
)
The list of cluster names to identify service updates to apply
The status(es) of the service updates to filter on
dict
Response Syntax
{
'NextToken': 'string',
'ServiceUpdates': [
{
'ClusterName': 'string',
'ServiceUpdateName': 'string',
'ReleaseDate': datetime(2015, 1, 1),
'Description': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled',
'Type': 'security-update',
'NodesUpdated': 'string',
'AutoUpdateStartDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
ServiceUpdates (list) --
A list of service updates
(dict) --
An update that you can apply to your MemoryDB clusters.
ClusterName (string) --
The name of the cluster to which the service update applies
ServiceUpdateName (string) --
The unique ID of the service update
ReleaseDate (datetime) --
The date when the service update is initially available
Description (string) --
Provides details of the service update
Status (string) --
The status of the service update
Type (string) --
Reflects the nature of the service update
NodesUpdated (string) --
A list of nodes updated by the service update
AutoUpdateStartDate (datetime) --
The date at which the service update will be automatically applied
Exceptions
MemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_snapshots(**kwargs)¶Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.
See also: AWS API Documentation
Request Syntax
response = client.describe_snapshots(
ClusterName='string',
SnapshotName='string',
Source='string',
NextToken='string',
MaxResults=123,
ShowDetail=True|False
)
dict
Response Syntax
{
'NextToken': 'string',
'Snapshots': [
{
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
]
},
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Snapshots (list) --
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(dict) --
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
EngineVersion (string) --
The Redis engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiondescribe_subnet_groups(**kwargs)¶Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
See also: AWS API Documentation
Request Syntax
response = client.describe_subnet_groups(
SubnetGroupName='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'SubnetGroups': [
{
'Name': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'Identifier': 'string',
'AvailabilityZone': {
'Name': 'string'
}
},
],
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
SubnetGroups (list) --
A list of subnet groups. Each element in the list contains detailed information about one group.
(dict) --
Represents the output of one of the following operations:
A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.
Name (string) --
The name of the subnet group
Description (string) --
A 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 cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
Identifier (string) --
The unique identifier for the subnet.
AvailabilityZone (dict) --
The Availability Zone where the subnet resides
Name (string) --
The name of the Availability Zone.
ARN (string) --
The ARN (Amazon Resource Name) of the subnet group.
Exceptions
MemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultdescribe_users(**kwargs)¶Returns a list of users.
See also: AWS API Documentation
Request Syntax
response = client.describe_users(
UserName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
Filter to determine the list of users to return.
Used to streamline results of a search based on the property being filtered.
The property being filtered. For example, UserName.
The property values to filter on. For example, "user-123".
dict
Response Syntax
{
'Users': [
{
'Name': 'string',
'Status': 'string',
'AccessString': 'string',
'ACLNames': [
'string',
],
'MinimumEngineVersion': 'string',
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Users (list) --
A list of users.
(dict) --
You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.
Name (string) --
The name of the user
Status (string) --
Indicates the user status. Can be "active", "modifying" or "deleting".
AccessString (string) --
Access permissions string used for this user.
ACLNames (list) --
The names of the Access Control Lists to which the user belongs
MinimumEngineVersion (string) --
The minimum engine version supported for the user
Authentication (dict) --
Denotes whether the user requires a password to authenticate.
Type (string) --
Indicates whether the user requires a password to authenticate.
PasswordCount (integer) --
The number of passwords belonging to the user. The maximum is two.
ARN (string) --
The Amazon Resource Name (ARN) of the user.
NextToken (string) --
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Exceptions
MemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionfailover_shard(**kwargs)¶Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API.
See also: AWS API Documentation
Request Syntax
response = client.failover_shard(
ClusterName='string',
ShardName='string'
)
[REQUIRED]
The cluster being failed over
[REQUIRED]
The name of the shard
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The cluster being failed over
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.APICallRateForCustomerExceededFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.ShardNotFoundFaultMemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.TestFailoverNotAvailableFaultMemoryDB.Client.exceptions.InvalidKMSKeyFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_allowed_node_type_updates(**kwargs)¶Lists all available node types that you can scale to from your cluster's current node type. When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
See also: AWS API Documentation
Request Syntax
response = client.list_allowed_node_type_updates(
ClusterName='string'
)
[REQUIRED]
The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types you can scale up to.
{
'ScaleUpNodeTypes': [
'string',
],
'ScaleDownNodeTypes': [
'string',
]
}
Response Structure
A list node types which you can use to scale up your cluster.
A list node types which you can use to scale down your cluster.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionMemoryDB.Client.exceptions.InvalidParameterValueExceptionLists all tags currently on a named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. For more information, see Tagging your MemoryDB resources
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want the list of tags
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tags as key-value pairs.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.InvalidARNFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.ACLNotFoundFaultpurchase_reserved_nodes_offering(**kwargs)¶Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_nodes_offering(
ReservedNodesOfferingId='string',
ReservationId='string',
NodeCount=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the reserved node offering to purchase.
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'ReservedNode': {
'ReservationId': 'string',
'ReservedNodesOfferingId': 'string',
'NodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'NodeCount': 123,
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ARN': 'string'
}
}
Response Structure
(dict) --
ReservedNode (dict) --
Represents the output of a PurchaseReservedNodesOffering operation.
ReservationId (string) --
A customer-specified identifier to track this reservation.
ReservedNodesOfferingId (string) --
The ID of the reserved node offering to purchase.
NodeType (string) --
The node type for the reserved nodes.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved node.
NodeCount (integer) --
The number of nodes that have been reserved.
OfferingType (string) --
The offering type of this reserved node.
State (string) --
The state of the reserved node.
RecurringCharges (list) --
The recurring price charged to run this reserved node.
(dict) --
The recurring charge to run this reserved node.
RecurringChargeAmount (float) --
The amount of the recurring charge to run this reserved node.
RecurringChargeFrequency (string) --
The frequency of the recurring price charged to run this reserved node.
ARN (string) --
The Amazon Resource Name (ARN) of the reserved node.
Exceptions
MemoryDB.Client.exceptions.ReservedNodesOfferingNotFoundFaultMemoryDB.Client.exceptions.ReservedNodeAlreadyExistsFaultMemoryDB.Client.exceptions.ReservedNodeQuotaExceededFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.TagQuotaPerResourceExceededMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionreset_parameter_group(**kwargs)¶Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
See also: AWS API Documentation
Request Syntax
response = client.reset_parameter_group(
ParameterGroupName='string',
AllParameters=True|False,
ParameterNames=[
'string',
]
)
[REQUIRED]
The name of the parameter group to reset.
An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.
dict
Response Syntax
{
'ParameterGroup': {
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
ParameterGroup (dict) --
The parameter group being reset.
Name (string) --
The name of the parameter group
Family (string) --
The name of the parameter group family that this parameter group is compatible with.
Description (string) --
A description of the parameter group
ARN (string) --
The Amazon Resource Name (ARN) of the parameter group
Exceptions
MemoryDB.Client.exceptions.InvalidParameterGroupStateFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptiontag_resource(**kwargs)¶A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which the tags are to be added
[REQUIRED]
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
The key for the tag. May not be null.
The tag's value. May be null.
dict
Response Syntax
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
TagList (list) --
A list of tags as key-value pairs.
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.TagQuotaPerResourceExceededMemoryDB.Client.exceptions.InvalidARNFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultuntag_resource(**kwargs)¶Use this operation to remove tags on a resource
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to which the tags are to be removed
[REQUIRED]
The list of keys of the tags that are to be removed
dict
Response Syntax
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
TagList (list) --
The list of tags removed
(dict) --
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.SnapshotNotFoundFaultMemoryDB.Client.exceptions.InvalidARNFaultMemoryDB.Client.exceptions.TagNotFoundFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.ACLNotFoundFaultupdate_acl(**kwargs)¶Changes the list of users that belong to the Access Control List.
See also: AWS API Documentation
Request Syntax
response = client.update_acl(
ACLName='string',
UserNamesToAdd=[
'string',
],
UserNamesToRemove=[
'string',
]
)
[REQUIRED]
The name of the Access Control List
The list of users to add to the Access Control List
The list of users to remove from the Access Control List
dict
Response Syntax
{
'ACL': {
'Name': 'string',
'Status': 'string',
'UserNames': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserNamesToRemove': [
'string',
],
'UserNamesToAdd': [
'string',
]
},
'Clusters': [
'string',
],
'ARN': 'string'
}
}
Response Structure
(dict) --
ACL (dict) --
The updated Access Control List
Name (string) --
The name of the Access Control List
Status (string) --
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
UserNames (list) --
The list of user names that belong to the ACL.
MinimumEngineVersion (string) --
The minimum engine version supported for the ACL
PendingChanges (dict) --
A list of updates being applied to the ACL.
UserNamesToRemove (list) --
A list of user names being removed from the ACL
UserNamesToAdd (list) --
A list of users being added to the ACL
Clusters (list) --
A list of clusters associated with the ACL.
ARN (string) --
The Amazon Resource Name (ARN) of the ACL
Exceptions
MemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.DuplicateUserNameFaultMemoryDB.Client.exceptions.DefaultUserRequiredMemoryDB.Client.exceptions.InvalidACLStateFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionupdate_cluster(**kwargs)¶Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
See also: AWS API Documentation
Request Syntax
response = client.update_cluster(
ClusterName='string',
Description='string',
SecurityGroupIds=[
'string',
],
MaintenanceWindow='string',
SnsTopicArn='string',
SnsTopicStatus='string',
ParameterGroupName='string',
SnapshotWindow='string',
SnapshotRetentionLimit=123,
NodeType='string',
EngineVersion='string',
ReplicaConfiguration={
'ReplicaCount': 123
},
ShardConfiguration={
'ShardCount': 123
},
ACLName='string'
)
[REQUIRED]
The name of the cluster to update
The SecurityGroupIds to update
Specifies the weekly time range during which maintenance on the 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:
sunmontuewedthufrisatExample: sun:23:00-mon:01:30
The number of replicas that will reside in each shard
The number of replicas to scale up or down to
The number of shards in the cluster
The number of shards in the cluster
dict
Response Syntax
{
'Cluster': {
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
}
}
Response Structure
(dict) --
Cluster (dict) --
The updated cluster
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
Exceptions
MemoryDB.Client.exceptions.ClusterNotFoundFaultMemoryDB.Client.exceptions.InvalidClusterStateFaultMemoryDB.Client.exceptions.InvalidNodeStateFaultMemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.InvalidVPCNetworkStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidKMSKeyFaultMemoryDB.Client.exceptions.NodeQuotaForClusterExceededFaultMemoryDB.Client.exceptions.ClusterQuotaForCustomerExceededFaultMemoryDB.Client.exceptions.ShardsPerClusterQuotaExceededFaultMemoryDB.Client.exceptions.NodeQuotaForCustomerExceededFaultMemoryDB.Client.exceptions.NoOperationFaultMemoryDB.Client.exceptions.InvalidACLStateFaultMemoryDB.Client.exceptions.ACLNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionupdate_parameter_group(**kwargs)¶Updates 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 to update.
[REQUIRED]
An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.
Describes a name-value pair that is used to update the value of a parameter.
The name of the parameter
The value of the parameter
dict
Response Syntax
{
'ParameterGroup': {
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
ParameterGroup (dict) --
The updated parameter group
Name (string) --
The name of the parameter group
Family (string) --
The name of the parameter group family that this parameter group is compatible with.
Description (string) --
A description of the parameter group
ARN (string) --
The Amazon Resource Name (ARN) of the parameter group
Exceptions
MemoryDB.Client.exceptions.ParameterGroupNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterGroupStateFaultMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionupdate_subnet_group(**kwargs)¶Updates a subnet group. For more information, see Updating a 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
The EC2 subnet IDs for the subnet group.
dict
Response Syntax
{
'SubnetGroup': {
'Name': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'Identifier': 'string',
'AvailabilityZone': {
'Name': 'string'
}
},
],
'ARN': 'string'
}
}
Response Structure
(dict) --
SubnetGroup (dict) --
The updated subnet group
Name (string) --
The name of the subnet group
Description (string) --
A 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 cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
Identifier (string) --
The unique identifier for the subnet.
AvailabilityZone (dict) --
The Availability Zone where the subnet resides
Name (string) --
The name of the Availability Zone.
ARN (string) --
The ARN (Amazon Resource Name) of the subnet group.
Exceptions
MemoryDB.Client.exceptions.SubnetGroupNotFoundFaultMemoryDB.Client.exceptions.SubnetQuotaExceededFaultMemoryDB.Client.exceptions.SubnetInUseMemoryDB.Client.exceptions.InvalidSubnetMemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFaultMemoryDB.Client.exceptions.SubnetNotAllowedFaultupdate_user(**kwargs)¶Changes user password(s) and/or access string.
See also: AWS API Documentation
Request Syntax
response = client.update_user(
UserName='string',
AuthenticationMode={
'Type': 'password',
'Passwords': [
'string',
]
},
AccessString='string'
)
[REQUIRED]
The name of the user
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Indicates whether the user requires a password to authenticate. All newly-created users require a password.
The password(s) used for authentication
dict
Response Syntax
{
'User': {
'Name': 'string',
'Status': 'string',
'AccessString': 'string',
'ACLNames': [
'string',
],
'MinimumEngineVersion': 'string',
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
}
}
Response Structure
(dict) --
User (dict) --
The updated user
Name (string) --
The name of the user
Status (string) --
Indicates the user status. Can be "active", "modifying" or "deleting".
AccessString (string) --
Access permissions string used for this user.
ACLNames (list) --
The names of the Access Control Lists to which the user belongs
MinimumEngineVersion (string) --
The minimum engine version supported for the user
Authentication (dict) --
Denotes whether the user requires a password to authenticate.
Type (string) --
Indicates whether the user requires a password to authenticate.
PasswordCount (integer) --
The number of passwords belonging to the user. The maximum is two.
ARN (string) --
The Amazon Resource Name (ARN) of the user.
Exceptions
MemoryDB.Client.exceptions.UserNotFoundFaultMemoryDB.Client.exceptions.InvalidUserStateFaultMemoryDB.Client.exceptions.InvalidParameterValueExceptionMemoryDB.Client.exceptions.InvalidParameterCombinationExceptionThe available paginators are:
MemoryDB.Paginator.DescribeACLsMemoryDB.Paginator.DescribeClustersMemoryDB.Paginator.DescribeEngineVersionsMemoryDB.Paginator.DescribeEventsMemoryDB.Paginator.DescribeParameterGroupsMemoryDB.Paginator.DescribeParametersMemoryDB.Paginator.DescribeReservedNodesMemoryDB.Paginator.DescribeReservedNodesOfferingsMemoryDB.Paginator.DescribeServiceUpdatesMemoryDB.Paginator.DescribeSnapshotsMemoryDB.Paginator.DescribeSubnetGroupsMemoryDB.Paginator.DescribeUsersMemoryDB.Paginator.DescribeACLs¶paginator = client.get_paginator('describe_acls')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_acls().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ACLName='string',
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
{
'ACLs': [
{
'Name': 'string',
'Status': 'string',
'UserNames': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserNamesToRemove': [
'string',
],
'UserNamesToAdd': [
'string',
]
},
'Clusters': [
'string',
],
'ARN': 'string'
},
],
}
Response Structure
(dict) --
ACLs (list) --
The list of ACLs
(dict) --
An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
Name (string) --
The name of the Access Control List
Status (string) --
Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
UserNames (list) --
The list of user names that belong to the ACL.
MinimumEngineVersion (string) --
The minimum engine version supported for the ACL
PendingChanges (dict) --
A list of updates being applied to the ACL.
UserNamesToRemove (list) --
A list of user names being removed from the ACL
UserNamesToAdd (list) --
A list of users being added to the ACL
Clusters (list) --
A list of clusters associated with the ACL.
ARN (string) --
The Amazon Resource Name (ARN) of the ACL
MemoryDB.Paginator.DescribeClusters¶paginator = client.get_paginator('describe_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClusterName='string',
ShowShardDetails=True|False,
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
{
'Clusters': [
{
'Name': 'string',
'Description': 'string',
'Status': 'string',
'PendingUpdates': {
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'ACLs': {
'ACLToApply': 'string'
},
'ServiceUpdates': [
{
'ServiceUpdateName': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled'
},
]
},
'NumberOfShards': 123,
'Shards': [
{
'Name': 'string',
'Status': 'string',
'Slots': 'string',
'Nodes': [
{
'Name': 'string',
'Status': 'string',
'AvailabilityZone': 'string',
'CreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
}
},
],
'NumberOfNodes': 123
},
],
'AvailabilityMode': 'singleaz'|'multiaz',
'ClusterEndpoint': {
'Address': 'string',
'Port': 123
},
'NodeType': 'string',
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string',
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'SubnetGroupName': 'string',
'TLSEnabled': True|False,
'KmsKeyId': 'string',
'ARN': 'string',
'SnsTopicArn': 'string',
'SnsTopicStatus': 'string',
'SnapshotRetentionLimit': 123,
'MaintenanceWindow': 'string',
'SnapshotWindow': 'string',
'ACLName': 'string',
'AutoMinorVersionUpgrade': True|False,
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
Clusters (list) --
A list of clusters
(dict) --
Contains all of the attributes of a specific cluster.
Name (string) --
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
Description (string) --
A description of the cluster
Status (string) --
The status of the cluster. For example, Available, Updating, Creating.
PendingUpdates (dict) --
A group of settings that are currently being applied.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
The status of the online resharding slot migration
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
ACLs (dict) --
A list of ACLs associated with the cluster that are being updated
ACLToApply (string) --
A list of ACLs pending to be applied.
ServiceUpdates (list) --
A list of service updates being applied to the cluster
(dict) --
Update action that has yet to be processed for the corresponding apply/stop request
ServiceUpdateName (string) --
The unique ID of the service update
Status (string) --
The status of the service update
NumberOfShards (integer) --
The number of shards in the cluster
Shards (list) --
A list of shards that are members of the cluster.
(dict) --
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
Name (string) --
The name of the shard
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
Slots (string) --
The keyspace for this shard.
Nodes (list) --
A list containing information about individual nodes within the shard
(dict) --
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
Name (string) --
The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
Status (string) --
The status of the service update on the node
AvailabilityZone (string) --
The Availability Zone in which the node resides
CreateTime (datetime) --
The date and time when the node was created.
Endpoint (dict) --
The hostname for connecting to this node.
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NumberOfNodes (integer) --
The number of nodes in the shard
AvailabilityMode (string) --
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
ClusterEndpoint (dict) --
The cluster's configuration endpoint
Address (string) --
The DNS hostname of the node.
Port (integer) --
The port number that the engine is listening on.
NodeType (string) --
The cluster's node type
EngineVersion (string) --
The Redis engine version used by the cluster
EnginePatchVersion (string) --
The Redis engine patch version used by the cluster
ParameterGroupName (string) --
The name of the parameter group used by the cluster
ParameterGroupStatus (string) --
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
SecurityGroups (list) --
A list of security groups used by the cluster
(dict) --
Represents a single security group and its status.
SecurityGroupId (string) --
The identifier of the security group.
Status (string) --
The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
SubnetGroupName (string) --
The name of the subnet group used by the cluster
TLSEnabled (boolean) --
A flag to indicate if In-transit encryption is enabled
KmsKeyId (string) --
The ID of the KMS key used to encrypt the cluster
ARN (string) --
The Amazon Resource Name (ARN) of the cluster.
SnsTopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic
SnsTopicStatus (string) --
The SNS topic must be in Active status to receive notifications
SnapshotRetentionLimit (integer) --
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
MaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the 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.
SnapshotWindow (string) --
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
ACLName (string) --
The name of the Access Control List associated with this cluster.
AutoMinorVersionUpgrade (boolean) --
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
MemoryDB.Paginator.DescribeEngineVersions¶paginator = client.get_paginator('describe_engine_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_engine_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EngineVersion='string',
ParameterGroupFamily='string',
DefaultOnly=True|False,
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
{
'EngineVersions': [
{
'EngineVersion': 'string',
'EnginePatchVersion': 'string',
'ParameterGroupFamily': 'string'
},
]
}
Response Structure
(dict) --
EngineVersions (list) --
A list of engine version details. Each element in the list contains detailed information about one engine version.
(dict) --
Provides details of the Redis engine version
EngineVersion (string) --
The engine version
EnginePatchVersion (string) --
The patched engine version
ParameterGroupFamily (string) --
Specifies the name of the parameter group family to which the engine default parameters apply.
MemoryDB.Paginator.DescribeEvents¶paginator = client.get_paginator('describe_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceName='string',
SourceType='node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
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': 'node'|'parameter-group'|'subnet-group'|'cluster'|'user'|'acl',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Events (list) --
A list of events. Each element in the list contains detailed information about one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
SourceName (string) --
The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
SourceType (string) --
Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
Message (string) --
The text of the event.
Date (datetime) --
The date and time when the event occurred.
MemoryDB.Paginator.DescribeParameterGroups¶paginator = client.get_paginator('describe_parameter_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParameterGroupName='string',
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
{
'ParameterGroups': [
{
'Name': 'string',
'Family': 'string',
'Description': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
ParameterGroups (list) --
A list of parameter groups. Each element in the list contains detailed information about one parameter group.
(dict) --
Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.
Name (string) --
The name of the parameter group
Family (string) --
The name of the parameter group family that this parameter group is compatible with.
Description (string) --
A description of the parameter group
ARN (string) --
The Amazon Resource Name (ARN) of the parameter group
MemoryDB.Paginator.DescribeParameters¶paginator = client.get_paginator('describe_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ParameterGroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
he name of a specific parameter group to return details for.
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': [
{
'Name': 'string',
'Value': 'string',
'Description': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'MinimumEngineVersion': 'string'
},
]
}
Response Structure
(dict) --
Parameters (list) --
A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.
(dict) --
Describes an individual setting that controls some aspect of MemoryDB behavior.
Name (string) --
The name of the parameter
Value (string) --
The value of the parameter
Description (string) --
A description of the parameter
DataType (string) --
The parameter's data type
AllowedValues (string) --
The valid range of values for the parameter.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
MemoryDB.Paginator.DescribeReservedNodes¶paginator = client.get_paginator('describe_reserved_nodes')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_reserved_nodes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservationId='string',
ReservedNodesOfferingId='string',
NodeType='string',
Duration='string',
OfferingType='string',
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
{
'ReservedNodes': [
{
'ReservationId': 'string',
'ReservedNodesOfferingId': 'string',
'NodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'NodeCount': 123,
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ARN': 'string'
},
]
}
Response Structure
(dict) --
ReservedNodes (list) --
Returns information about reserved nodes for this account, or about a specified reserved node.
(dict) --
Represents the output of a PurchaseReservedNodesOffering operation.
ReservationId (string) --
A customer-specified identifier to track this reservation.
ReservedNodesOfferingId (string) --
The ID of the reserved node offering to purchase.
NodeType (string) --
The node type for the reserved nodes.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved node.
NodeCount (integer) --
The number of nodes that have been reserved.
OfferingType (string) --
The offering type of this reserved node.
State (string) --
The state of the reserved node.
RecurringCharges (list) --
The recurring price charged to run this reserved node.
(dict) --
The recurring charge to run this reserved node.
RecurringChargeAmount (float) --
The amount of the recurring charge to run this reserved node.
RecurringChargeFrequency (string) --
The frequency of the recurring price charged to run this reserved node.
ARN (string) --
The Amazon Resource Name (ARN) of the reserved node.
MemoryDB.Paginator.DescribeReservedNodesOfferings¶paginator = client.get_paginator('describe_reserved_nodes_offerings')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_reserved_nodes_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedNodesOfferingId='string',
NodeType='string',
Duration='string',
OfferingType='string',
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
{
'ReservedNodesOfferings': [
{
'ReservedNodesOfferingId': 'string',
'NodeType': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'OfferingType': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
ReservedNodesOfferings (list) --
Lists available reserved node offerings.
(dict) --
The offering type of this node.
ReservedNodesOfferingId (string) --
The offering identifier.
NodeType (string) --
The node type for the reserved nodes. For more information, see Supported node types.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved node.
OfferingType (string) --
The offering type of this reserved node.
RecurringCharges (list) --
The recurring price charged to run this reserved node.
(dict) --
The recurring charge to run this reserved node.
RecurringChargeAmount (float) --
The amount of the recurring charge to run this reserved node.
RecurringChargeFrequency (string) --
The frequency of the recurring price charged to run this reserved node.
MemoryDB.Paginator.DescribeServiceUpdates¶paginator = client.get_paginator('describe_service_updates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_service_updates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceUpdateName='string',
ClusterNames=[
'string',
],
Status=[
'available'|'in-progress'|'complete'|'scheduled',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The list of cluster names to identify service updates to apply
The status(es) of the service updates to filter on
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
{
'ServiceUpdates': [
{
'ClusterName': 'string',
'ServiceUpdateName': 'string',
'ReleaseDate': datetime(2015, 1, 1),
'Description': 'string',
'Status': 'available'|'in-progress'|'complete'|'scheduled',
'Type': 'security-update',
'NodesUpdated': 'string',
'AutoUpdateStartDate': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
ServiceUpdates (list) --
A list of service updates
(dict) --
An update that you can apply to your MemoryDB clusters.
ClusterName (string) --
The name of the cluster to which the service update applies
ServiceUpdateName (string) --
The unique ID of the service update
ReleaseDate (datetime) --
The date when the service update is initially available
Description (string) --
Provides details of the service update
Status (string) --
The status of the service update
Type (string) --
Reflects the nature of the service update
NodesUpdated (string) --
A list of nodes updated by the service update
AutoUpdateStartDate (datetime) --
The date at which the service update will be automatically applied
MemoryDB.Paginator.DescribeSnapshots¶paginator = client.get_paginator('describe_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ClusterName='string',
SnapshotName='string',
Source='string',
ShowDetail=True|False,
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
{
'Snapshots': [
{
'Name': 'string',
'Status': 'string',
'Source': 'string',
'KmsKeyId': 'string',
'ARN': 'string',
'ClusterConfiguration': {
'Name': 'string',
'Description': 'string',
'NodeType': 'string',
'EngineVersion': 'string',
'MaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'ParameterGroupName': 'string',
'SubnetGroupName': 'string',
'VpcId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumShards': 123,
'Shards': [
{
'Name': 'string',
'Configuration': {
'Slots': 'string',
'ReplicaCount': 123
},
'Size': 'string',
'SnapshotCreationTime': datetime(2015, 1, 1)
},
]
},
'DataTiering': 'true'|'false'
},
]
}
Response Structure
(dict) --
Snapshots (list) --
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(dict) --
Represents a copy of an entire cluster as of the time when the snapshot was taken.
Name (string) --
The name of the snapshot
Status (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source (string) --
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration (dict) --
The configuration of the cluster from which the snapshot was taken
Name (string) --
The name of the cluster
Description (string) --
The description of the cluster configuration
NodeType (string) --
The node type used for the cluster
EngineVersion (string) --
The Redis engine version used by the cluster
MaintenanceWindow (string) --
The specified maintenance window for the cluster
TopicArn (string) --
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port (integer) --
The port used by the cluster
ParameterGroupName (string) --
The name of parameter group used by the cluster
SubnetGroupName (string) --
The name of the subnet group used by the cluster
VpcId (string) --
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit (integer) --
The snapshot retention limit set by the cluster
SnapshotWindow (string) --
The snapshot window set by the cluster
NumShards (integer) --
The number of shards in the cluster
Shards (list) --
The list of shards in the cluster
(dict) --
Provides details of a shard in a snapshot
Name (string) --
The name of the shard
Configuration (dict) --
The configuration details of the shard
Slots (string) --
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount (integer) --
The number of read replica nodes in this shard.
Size (string) --
The size of the shard's snapshot
SnapshotCreationTime (datetime) --
The date and time that the shard's snapshot was created
DataTiering (string) --
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
MemoryDB.Paginator.DescribeSubnetGroups¶paginator = client.get_paginator('describe_subnet_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubnetGroupName='string',
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
{
'SubnetGroups': [
{
'Name': 'string',
'Description': 'string',
'VpcId': 'string',
'Subnets': [
{
'Identifier': 'string',
'AvailabilityZone': {
'Name': 'string'
}
},
],
'ARN': 'string'
},
]
}
Response Structure
(dict) --
SubnetGroups (list) --
A list of subnet groups. Each element in the list contains detailed information about one group.
(dict) --
Represents the output of one of the following operations:
A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.
Name (string) --
The name of the subnet group
Description (string) --
A 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 cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
Identifier (string) --
The unique identifier for the subnet.
AvailabilityZone (dict) --
The Availability Zone where the subnet resides
Name (string) --
The name of the Availability Zone.
ARN (string) --
The ARN (Amazon Resource Name) of the subnet group.
MemoryDB.Paginator.DescribeUsers¶paginator = client.get_paginator('describe_users')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from MemoryDB.Client.describe_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
UserName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter to determine the list of users to return.
Used to streamline results of a search based on the property being filtered.
The property being filtered. For example, UserName.
The property values to filter on. For example, "user-123".
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
{
'Users': [
{
'Name': 'string',
'Status': 'string',
'AccessString': 'string',
'ACLNames': [
'string',
],
'MinimumEngineVersion': 'string',
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
},
],
}
Response Structure
(dict) --
Users (list) --
A list of users.
(dict) --
You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.
Name (string) --
The name of the user
Status (string) --
Indicates the user status. Can be "active", "modifying" or "deleting".
AccessString (string) --
Access permissions string used for this user.
ACLNames (list) --
The names of the Access Control Lists to which the user belongs
MinimumEngineVersion (string) --
The minimum engine version supported for the user
Authentication (dict) --
Denotes whether the user requires a password to authenticate.
Type (string) --
Indicates whether the user requires a password to authenticate.
PasswordCount (integer) --
The number of passwords belonging to the user. The maximum is two.
ARN (string) --
The Amazon Resource Name (ARN) of the user.