MemoryDB

Client

class 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.

client = session.create_client('memorydb')

These are the available methods:

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'
    }
)
Parameters
  • ClusterNames (list) --

    [REQUIRED]

    The cluster names to apply the updates.

    • (string) --
  • ServiceUpdate (dict) --

    The unique ID of the service update

    • ServiceUpdateNameToApply (string) --

      The unique ID of the service update

Return type

dict

Returns

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
        },
    ],
    '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.

    • 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

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
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'
        },
    ]
)
Parameters
  • SourceSnapshotName (string) --

    [REQUIRED]

    The name of an existing snapshot from which to make a copy.

  • TargetSnapshotName (string) --

    [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.

  • TargetBucket (string) -- The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket .
  • KmsKeyId (string) -- The ID of the KMS key used to encrypt the target snapshot.
  • Tags (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.

    • (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.

Return type

dict

Returns

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)
                },
            ]
        }
    }
}

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

Exceptions

create_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'
        },
    ]
)
Parameters
  • ACLName (string) --

    [REQUIRED]

    The name of the Access Control List.

  • UserNames (list) --

    The list of users that belong to the Access Control List.

    • (string) --
  • Tags (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.

    • (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.

Return type

dict

Returns

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.

        • (string) --
      • 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

          • (string) --
        • UserNamesToAdd (list) --

          A list of users being added to the ACL

          • (string) --
      • Clusters (list) --

        A list of clusters associated with the ACL.

        • (string) --
      • ARN (string) --

        The Amazon Resource Name (ARN) of the ACL

Exceptions

create_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
)
Parameters
  • ClusterName (string) --

    [REQUIRED]

    The name of the cluster. This value must be unique as it also serves as the cluster identifier.

  • NodeType (string) --

    [REQUIRED]

    The compute and memory capacity of the nodes in the cluster.

  • ParameterGroupName (string) -- The name of the parameter group associated with the cluster.
  • Description (string) -- An optional description of the cluster.
  • NumShards (integer) -- The number of shards the cluster will contain. The default value is 1.
  • NumReplicasPerShard (integer) -- The number of replicas to apply to each shard. The default value is 1. The maximum is 5.
  • SubnetGroupName (string) -- The name of the subnet group to be used for the cluster.
  • SecurityGroupIds (list) --

    A list of security group names to associate with this cluster.

    • (string) --
  • 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.
  • Port (integer) -- The port number on which each of the nodes accepts connections.
  • SnsTopicArn (string) -- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
  • TLSEnabled (boolean) -- A flag to enable in-transit encryption on the cluster.
  • KmsKeyId (string) -- The ID of the KMS key used to encrypt the cluster.
  • SnapshotArns (list) --

    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.

    • (string) --
  • SnapshotName (string) -- The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
  • 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.
  • Tags (list) --

    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.

    • (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.

  • 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) --

    [REQUIRED]

    The name of the Access Control List to associate with the cluster.

  • EngineVersion (string) -- The version number of the Redis engine to be used for the cluster.
  • AutoMinorVersionUpgrade (boolean) -- When set to true, the cluster will automatically receive minor engine version upgrades after launch.
Return type

dict

Returns

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
    }
}

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.

Exceptions

create_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'
        },
    ]
)
Parameters
  • ParameterGroupName (string) --

    [REQUIRED]

    The name of the parameter group.

  • Family (string) --

    [REQUIRED]

    The name of the parameter group family that the parameter group can be used with.

  • Description (string) -- An optional description of the parameter group.
  • Tags (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.

    • (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.

Return type

dict

Returns

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

create_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'
        },
    ]
)
Parameters
  • ClusterName (string) --

    [REQUIRED]

    The snapshot is created from this cluster.

  • SnapshotName (string) --

    [REQUIRED]

    A name for the snapshot being created.

  • KmsKeyId (string) -- The ID of the KMS key used to encrypt the snapshot.
  • Tags (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.

    • (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.

Return type

dict

Returns

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)
                },
            ]
        }
    }
}

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

Exceptions

create_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'
        },
    ]
)
Parameters
  • SubnetGroupName (string) --

    [REQUIRED]

    The name of the subnet group.

  • Description (string) -- A description for the subnet group.
  • SubnetIds (list) --

    [REQUIRED]

    A list of VPC subnet IDs for the subnet group.

    • (string) --
  • Tags (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.

    • (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.

Return type

dict

Returns

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

create_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'
        },
    ]
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The name of the user. This value must be unique as it also serves as the user identifier.

  • AuthenticationMode (dict) --

    [REQUIRED]

    Denotes the user's authentication properties, such as whether it requires a password to authenticate.

    • Type (string) --

      Indicates whether the user requires a password to authenticate. All newly-created users require a password.

    • Passwords (list) --

      The password(s) used for authentication

      • (string) --
  • AccessString (string) --

    [REQUIRED]

    Access permissions string used for this user.

  • Tags (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.

    • (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.

Return type

dict

Returns

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

        • (string) --
      • 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

delete_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'
)
Parameters
ACLName (string) --

[REQUIRED]

The name of the Access Control List to delete

Return type
dict
Returns
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 Access Control List object that has been deleted.

      • 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.

        • (string) --
      • 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

          • (string) --
        • UserNamesToAdd (list) --

          A list of users being added to the ACL

          • (string) --
      • Clusters (list) --

        A list of clusters associated with the ACL.

        • (string) --
      • ARN (string) --

        The Amazon Resource Name (ARN) of the ACL

Exceptions

delete_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'
)
Parameters
  • ClusterName (string) --

    [REQUIRED]

    The name of the cluster to be deleted

  • FinalSnapshotName (string) -- The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
Return type

dict

Returns

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
    }
}

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.

Exceptions

delete_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'
)
Parameters
ParameterGroupName (string) --

[REQUIRED]

The name of the parameter group to delete.

Return type
dict
Returns
Response Syntax
{
    'ParameterGroup': {
        'Name': 'string',
        'Family': 'string',
        'Description': 'string',
        'ARN': 'string'
    }
}

Response Structure

  • (dict) --
    • ParameterGroup (dict) --

      The parameter group that has been deleted.

      • 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

delete_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'
)
Parameters
SnapshotName (string) --

[REQUIRED]

The name of the snapshot to delete

Return type
dict
Returns
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)
                },
            ]
        }
    }
}

Response Structure

  • (dict) --
    • Snapshot (dict) --

      The snapshot object that has been deleted.

      • 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

Exceptions

delete_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'
)
Parameters
SubnetGroupName (string) --

[REQUIRED]

The name of the subnet group to delete

Return type
dict
Returns
Response Syntax
{
    'SubnetGroup': {
        'Name': 'string',
        'Description': 'string',
        'VpcId': 'string',
        'Subnets': [
            {
                'Identifier': 'string',
                'AvailabilityZone': {
                    'Name': 'string'
                }
            },
        ],
        'ARN': 'string'
    }
}

Response Structure

  • (dict) --
    • SubnetGroup (dict) --

      The subnet group object that has been deleted.

      • 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

delete_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'
)
Parameters
UserName (string) --

[REQUIRED]

The name of the user to delete

Return type
dict
Returns
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 user object that has been deleted.

      • 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

        • (string) --
      • 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

describe_acls(**kwargs)

Returns a list of ACLs

See also: AWS API Documentation

Request Syntax

response = client.describe_acls(
    ACLName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ACLName (string) -- The name of the ACL
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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.

          • (string) --
        • 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

            • (string) --
          • UserNamesToAdd (list) --

            A list of users being added to the ACL

            • (string) --
        • Clusters (list) --

          A list of clusters associated with the ACL.

          • (string) --
        • 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

describe_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
)
Parameters
  • ClusterName (string) -- The name of the cluster
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
  • ShowShardDetails (boolean) -- An optional flag that can be included in the request to retrieve information about the individual shard(s).
Return type

dict

Returns

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
        },
    ]
}

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.

Exceptions

describe_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
)
Parameters
  • EngineVersion (string) -- The Redis engine version
  • ParameterGroupFamily (string) -- The name of a specific parameter group family to return details for.
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
  • DefaultOnly (boolean) -- If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
Return type

dict

Returns

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

describe_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'
)
Parameters
  • SourceName (string) -- The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
  • SourceType (string) -- The event source to retrieve events for. If no value is specified, all events are returned.
  • StartTime (datetime) -- The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
  • EndTime (datetime) -- The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z
  • Duration (integer) -- The number of minutes worth of events to retrieve.
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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

describe_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'
)
Parameters
  • ParameterGroupName (string) -- The name of a specific parameter group to return details for.
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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

describe_parameters(**kwargs)

Returns the detailed parameter list for a particular parameter group.

See also: AWS API Documentation

Request Syntax

response = client.describe_parameters(
    ParameterGroupName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ParameterGroupName (string) --

    [REQUIRED]

    he name of a specific parameter group to return details for.

  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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

describe_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'
)
Parameters
  • ServiceUpdateName (string) -- The unique ID of the service update to describe.
  • ClusterNames (list) --

    The list of cluster names to identify service updates to apply

    • (string) --
  • Status (list) --

    The status(es) of the service updates to filter on

    • (string) --
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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

describe_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
)
Parameters
  • ClusterName (string) -- A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
  • SnapshotName (string) -- A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.
  • Source (string) -- If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
  • 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.
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • ShowDetail (boolean) -- A Boolean value which if true, the shard configuration is included in the snapshot description.
Return type

dict

Returns

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)
                    },
                ]
            }
        },
    ]
}

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

Exceptions

describe_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'
)
Parameters
  • SubnetGroupName (string) -- The name of the subnet group to return details for.
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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:

        • CreateSubnetGroup
        • UpdateSubnetGroup

        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

describe_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'
)
Parameters
  • UserName (string) -- The name of the user
  • Filters (list) --

    Filter to determine the list of users to return.

    • (dict) --

      Used to streamline results of a search based on the property being filtered.

      • Name (string) -- [REQUIRED]

        The property being filtered. For example, UserName.

      • Values (list) -- [REQUIRED]

        The property values to filter on. For example, "user-123".

        • (string) --
  • MaxResults (integer) -- The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
  • 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.
Return type

dict

Returns

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

          • (string) --
        • 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

failover_shard(**kwargs)

Used to failover a shard

See also: AWS API Documentation

Request Syntax

response = client.failover_shard(
    ClusterName='string',
    ShardName='string'
)
Parameters
  • ClusterName (string) --

    [REQUIRED]

    The cluster being failed over

  • ShardName (string) --

    [REQUIRED]

    The name of the shard

Return type

dict

Returns

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
    }
}

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.

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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'
)
Parameters
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.

Return type
dict
Returns
Response Syntax
{
    'ScaleUpNodeTypes': [
        'string',
    ],
    'ScaleDownNodeTypes': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • ScaleUpNodeTypes (list) --

      A list node types which you can use to scale up your cluster.

      • (string) --
    • ScaleDownNodeTypes (list) --

      A list node types which you can use to scale down your cluster.

      • (string) --

Exceptions

list_tags(**kwargs)

Lists 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'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which you want the list of tags

Return type
dict
Returns
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

reset_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',
    ]
)
Parameters
  • ParameterGroupName (string) --

    [REQUIRED]

    The name of the parameter group to reset.

  • AllParameters (boolean) -- If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.
  • ParameterNames (list) --

    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.

    • (string) --
Return type

dict

Returns

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

tag_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'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to which the tags are to be added

  • Tags (list) --

    [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.

    • (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.

Return type

dict

Returns

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

untag_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',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to which the tags are to be removed

  • TagKeys (list) --

    [REQUIRED]

    The list of keys of the tags that are to be removed

    • (string) --
Return type

dict

Returns

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

update_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',
    ]
)
Parameters
  • ACLName (string) --

    [REQUIRED]

    The name of the Access Control List

  • UserNamesToAdd (list) --

    The list of users to add to the Access Control List

    • (string) --
  • UserNamesToRemove (list) --

    The list of users to remove from the Access Control List

    • (string) --
Return type

dict

Returns

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.

        • (string) --
      • 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

          • (string) --
        • UserNamesToAdd (list) --

          A list of users being added to the ACL

          • (string) --
      • Clusters (list) --

        A list of clusters associated with the ACL.

        • (string) --
      • ARN (string) --

        The Amazon Resource Name (ARN) of the ACL

Exceptions

update_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'
)
Parameters
  • ClusterName (string) --

    [REQUIRED]

    The name of the cluster to update

  • Description (string) -- The description of the cluster to update
  • SecurityGroupIds (list) --

    The SecurityGroupIds to update

    • (string) --
  • MaintenanceWindow (string) -- The maintenance window to update
  • SnsTopicArn (string) -- The SNS topic ARN to update
  • SnsTopicStatus (string) -- The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
  • ParameterGroupName (string) -- The name of the parameter group to update
  • SnapshotWindow (string) -- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
  • SnapshotRetentionLimit (integer) -- The number of days for which MemoryDB retains automatic cluster 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.
  • NodeType (string) -- A valid node type that you want to scale this cluster up or down to.
  • EngineVersion (string) -- The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
  • ReplicaConfiguration (dict) --

    The number of replicas that will reside in each shard

    • ReplicaCount (integer) --

      The number of replicas to scale up or down to

  • ShardConfiguration (dict) --

    The number of shards in the cluster

    • ShardCount (integer) --

      The number of shards in the cluster

  • ACLName (string) -- The Access Control List that is associated with the cluster
Return type

dict

Returns

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
    }
}

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.

Exceptions

update_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'
        },
    ]
)
Parameters
  • ParameterGroupName (string) --

    [REQUIRED]

    The name of the parameter group to update.

  • ParameterNameValues (list) --

    [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.

    • (dict) --

      Describes a name-value pair that is used to update the value of a parameter.

      • ParameterName (string) --

        The name of the parameter

      • ParameterValue (string) --

        The value of the parameter

Return type

dict

Returns

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

update_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',
    ]
)
Parameters
  • SubnetGroupName (string) --

    [REQUIRED]

    The name of the subnet group

  • Description (string) -- A description of the subnet group
  • SubnetIds (list) --

    The EC2 subnet IDs for the subnet group.

    • (string) --
Return type

dict

Returns

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

update_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'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The name of the user

  • AuthenticationMode (dict) --

    Denotes the user's authentication properties, such as whether it requires a password to authenticate.

    • Type (string) --

      Indicates whether the user requires a password to authenticate. All newly-created users require a password.

    • Passwords (list) --

      The password(s) used for authentication

      • (string) --
  • AccessString (string) -- Access permissions string used for this user.
Return type

dict

Returns

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

        • (string) --
      • 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

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class MemoryDB.Client.exceptions.ACLAlreadyExistsFault

Example

try:
  ...
except client.exceptions.ACLAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ACLNotFoundFault

Example

try:
  ...
except client.exceptions.ACLNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ACLQuotaExceededFault

Example

try:
  ...
except client.exceptions.ACLQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.APICallRateForCustomerExceededFault

Example

try:
  ...
except client.exceptions.APICallRateForCustomerExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ClusterAlreadyExistsFault

Example

try:
  ...
except client.exceptions.ClusterAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ClusterNotFoundFault

Example

try:
  ...
except client.exceptions.ClusterNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ClusterQuotaForCustomerExceededFault

Example

try:
  ...
except client.exceptions.ClusterQuotaForCustomerExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.DefaultUserRequired

Example

try:
  ...
except client.exceptions.DefaultUserRequired as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.DuplicateUserNameFault

Example

try:
  ...
except client.exceptions.DuplicateUserNameFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InsufficientClusterCapacityFault

Example

try:
  ...
except client.exceptions.InsufficientClusterCapacityFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidACLStateFault

Example

try:
  ...
except client.exceptions.InvalidACLStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidARNFault

Example

try:
  ...
except client.exceptions.InvalidARNFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidClusterStateFault

Example

try:
  ...
except client.exceptions.InvalidClusterStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidCredentialsException

Example

try:
  ...
except client.exceptions.InvalidCredentialsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidKMSKeyFault

Example

try:
  ...
except client.exceptions.InvalidKMSKeyFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidNodeStateFault

Example

try:
  ...
except client.exceptions.InvalidNodeStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidParameterCombinationException

Example

try:
  ...
except client.exceptions.InvalidParameterCombinationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidParameterGroupStateFault

Example

try:
  ...
except client.exceptions.InvalidParameterGroupStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidParameterValueException

Example

try:
  ...
except client.exceptions.InvalidParameterValueException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidSnapshotStateFault

Example

try:
  ...
except client.exceptions.InvalidSnapshotStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidSubnet

Example

try:
  ...
except client.exceptions.InvalidSubnet as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidUserStateFault

Example

try:
  ...
except client.exceptions.InvalidUserStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.InvalidVPCNetworkStateFault

Example

try:
  ...
except client.exceptions.InvalidVPCNetworkStateFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.NoOperationFault

Example

try:
  ...
except client.exceptions.NoOperationFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.NodeQuotaForClusterExceededFault

Example

try:
  ...
except client.exceptions.NodeQuotaForClusterExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.NodeQuotaForCustomerExceededFault

Example

try:
  ...
except client.exceptions.NodeQuotaForCustomerExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ParameterGroupAlreadyExistsFault

Example

try:
  ...
except client.exceptions.ParameterGroupAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ParameterGroupNotFoundFault

Example

try:
  ...
except client.exceptions.ParameterGroupNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ParameterGroupQuotaExceededFault

Example

try:
  ...
except client.exceptions.ParameterGroupQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

Example

try:
  ...
except client.exceptions.ServiceLinkedRoleNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ServiceUpdateNotFoundFault

Example

try:
  ...
except client.exceptions.ServiceUpdateNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ShardNotFoundFault

Example

try:
  ...
except client.exceptions.ShardNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.ShardsPerClusterQuotaExceededFault

Example

try:
  ...
except client.exceptions.ShardsPerClusterQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SnapshotAlreadyExistsFault

Example

try:
  ...
except client.exceptions.SnapshotAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SnapshotNotFoundFault

Example

try:
  ...
except client.exceptions.SnapshotNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SnapshotQuotaExceededFault

Example

try:
  ...
except client.exceptions.SnapshotQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetGroupAlreadyExistsFault

Example

try:
  ...
except client.exceptions.SubnetGroupAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetGroupInUseFault

Example

try:
  ...
except client.exceptions.SubnetGroupInUseFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetGroupNotFoundFault

Example

try:
  ...
except client.exceptions.SubnetGroupNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetGroupQuotaExceededFault

Example

try:
  ...
except client.exceptions.SubnetGroupQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetInUse

Example

try:
  ...
except client.exceptions.SubnetInUse as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetNotAllowedFault

Example

try:
  ...
except client.exceptions.SubnetNotAllowedFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.SubnetQuotaExceededFault

Example

try:
  ...
except client.exceptions.SubnetQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.TagNotFoundFault

Example

try:
  ...
except client.exceptions.TagNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.TagQuotaPerResourceExceeded

Example

try:
  ...
except client.exceptions.TagQuotaPerResourceExceeded as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.TestFailoverNotAvailableFault

Example

try:
  ...
except client.exceptions.TestFailoverNotAvailableFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.UserAlreadyExistsFault

Example

try:
  ...
except client.exceptions.UserAlreadyExistsFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.UserNotFoundFault

Example

try:
  ...
except client.exceptions.UserNotFoundFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class MemoryDB.Client.exceptions.UserQuotaExceededFault

Example

try:
  ...
except client.exceptions.UserQuotaExceededFault as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: