Amazon MemoryDB

(1)

Amazon MemoryDB

API Reference

API Version 2021-01-01

(2)

Amazon MemoryDB: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

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’ ﬂexible and friendly data structures, APIs, and commands.

This document was last published on March 6, 2022.

(11)

Actions

The following actions are supported:

• BatchUpdateCluster (p. 3)

• CopySnapshot (p. 6)

• CreateACL (p. 10)

• CreateCluster (p. 13)

• CreateParameterGroup (p. 20)

• CreateSnapshot (p. 23)

• CreateSubnetGroup (p. 26)

• CreateUser (p. 29)

• DeleteACL (p. 32)

• DeleteCluster (p. 34)

• DeleteParameterGroup (p. 37)

• DeleteSnapshot (p. 39)

• DeleteSubnetGroup (p. 42)

• DeleteUser (p. 44)

• DescribeACLs (p. 46)

• DescribeClusters (p. 49)

• DescribeEngineVersions (p. 53)

• DescribeEvents (p. 56)

• DescribeParameterGroups (p. 59)

• DescribeParameters (p. 62)

• DescribeServiceUpdates (p. 65)

• DescribeSnapshots (p. 68)

• DescribeSubnetGroups (p. 72)

• DescribeUsers (p. 75)

• FailoverShard (p. 78)

• ListAllowedNodeTypeUpdates (p. 81)

• ListTags (p. 83)

• ResetParameterGroup (p. 85)

• TagResource (p. 87)

• UntagResource (p. 90)

• UpdateACL (p. 93)

• UpdateCluster (p. 96)

• UpdateParameterGroup (p. 102)

• UpdateSubnetGroup (p. 104)

• UpdateUser (p. 107)

(12)

BatchUpdateCluster

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

Request Syntax

{

"ClusterNames": [ "string" ], "ServiceUpdate": {

"ServiceUpdateNameToApply": "string"

}}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 156).

The request accepts the following data in JSON format.

ClusterNames (p. 3)

The cluster names to apply the updates.

Type: Array of strings

Array Members: Maximum number of 20 items.

Required: Yes ServiceUpdate (p. 3)

The unique ID of the service update Type: ServiceUpdateRequest (p. 141) object Required: No

Response Syntax

{

"ProcessedClusters": [ {

"ACLName": "string", "ARN": "string",

"AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": {

"Address": "string", "Port": number },

"Description": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string",

"MaintenanceWindow": "string", "Name": "string",

"NodeType": "string",

(13)

Response Syntax

"NumberOfShards": number, "ParameterGroupName": "string", "ParameterGroupStatus": "string", "PendingUpdates": {

"ACLs": {

"ACLToApply": "string"

},

"Resharding": { "SlotMigration": {

"ProgressPercentage": number }

},

"ServiceUpdates": [ {

"ServiceUpdateName": "string", "Status": "string"

} ] },

"SecurityGroups": [ {

"SecurityGroupId": "string", "Status": "string"

} ],

"Shards": [ {

"Name": "string", "Nodes": [ {

"AvailabilityZone": "string", "CreateTime": number,

"Endpoint": {

"Name": "string", "Status": "string"

} ],

"NumberOfNodes": number, "Slots": "string", "Status": "string"

} ],

"SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string",

"SubnetGroupName": "string", "TLSEnabled": boolean }

],

"UnprocessedClusters": [ {

"ClusterName": "string", "ErrorMessage": "string", "ErrorType": "string"

} ] }

(14)

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ProcessedClusters (p. 3)

The list of clusters that have been updated.

Type: Array of Cluster (p. 119) objects UnprocessedClusters (p. 3)

The list of clusters where updates have not been applied.

Type: Array of UnprocessedCluster (p. 153) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 158).

InvalidParameterValueException

HTTP Status Code: 400 ServiceUpdateNotFoundFault

HTTP Status Code: 400

CopySnapshot

Makes a copy of an existing snapshot.

Request Syntax

{ "KmsKeyId": "string",

"SourceSnapshotName": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ],

"TargetBucket": "string", "TargetSnapshotName": "string"

}

Request Parameters

KmsKeyId (p. 6)

The ID of the KMS key used to encrypt the target snapshot.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

SourceSnapshotName (p. 6)

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

Type: String Required: Yes Tags (p. 6)

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.

Type: Array of Tag (p. 152) objects

Required: No TargetBucket (p. 6)

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

(16)

Response Syntax

MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.

Type: String

Length Constraints: Maximum length of 255.

Pattern: ^[A-Za-z0-9._-]+$

Required: No

TargetSnapshotName (p. 6)

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.

Type: String Required: Yes

Response Syntax

{

"Snapshot": { "ARN": "string",

"ClusterConfiguration": { "Description": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "Name": "string",

"NodeType": "string", "NumShards": number,

"ParameterGroupName": "string", "Port": number,

"Shards": [ {

"Configuration": {

"ReplicaCount": number, "Slots": "string"

},

"Name": "string", "Size": "string",

"SnapshotCreationTime": number }

],

"SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SubnetGroupName": "string", "TopicArn": "string",

"VpcId": "string"

},

"KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string"

} }

Response Elements

(17)

Errors

Snapshot (p. 7)

Represents a copy of an entire cluster as of the time when the snapshot was taken.

Type: Snapshot (p. 147) object

Errors

InvalidParameterCombinationException

HTTP Status Code: 400 InvalidParameterValueException

HTTP Status Code: 400 InvalidSnapshotStateFault

HTTP Status Code: 400 ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400 SnapshotAlreadyExistsFault

HTTP Status Code: 400 SnapshotNotFoundFault

HTTP Status Code: 400 SnapshotQuotaExceededFault

HTTP Status Code: 400 TagQuotaPerResourceExceeded

CreateACL

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

Request Syntax

{ "ACLName": "string", "Tags": [

{

} ],

"UserNames": [ "string" ] }

Request Parameters

ACLName (p. 10)

The name of the Access Control List.

Required: No UserNames (p. 10)

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: No

(20)

Response Syntax

{

"ACL": {

"ARN": "string",

"Clusters": [ "string" ],

"MinimumEngineVersion": "string", "Name": "string",

"PendingChanges": {

"UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] },

"Status": "string", "UserNames": [ "string" ] }}

Response Elements

ACL (p. 11)

The newly-created Access Control List.

Type: ACL (p. 112) object

Errors

ACLAlreadyExistsFault

HTTP Status Code: 400 ACLQuotaExceededFault

HTTP Status Code: 400 DefaultUserRequired

HTTP Status Code: 400 DuplicateUserNameFault

(21)

See Also

UserNotFoundFault

CreateCluster

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

Request Syntax

{

"ACLName": "string",

"AutoMinorVersionUpgrade": boolean, "ClusterName": "string",

"Description": "string", "EngineVersion": "string", "KmsKeyId": "string",

"MaintenanceWindow": "string", "NodeType": "string",

"NumReplicasPerShard": number, "NumShards": number,

"SecurityGroupIds": [ "string" ], "SnapshotArns": [ "string" ], "SnapshotName": "string",

"SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SubnetGroupName": "string", "Tags": [

{

} ],

"TLSEnabled": boolean }

Request Parameters

ACLName (p. 13)

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

Type: String

Required: Yes

AutoMinorVersionUpgrade (p. 13)

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Type: Boolean

(23)

Request Parameters

Required: No ClusterName (p. 13)

The name of the cluster. This value must be unique as it also serves as the cluster identiﬁer.

Type: String Required: Yes Description (p. 13)

An optional description of the cluster.

Type: String Required: No EngineVersion (p. 13)

The version number of the Redis engine to be used for the cluster.

Type: String Required: No KmsKeyId (p. 13)

The ID of the KMS key used to encrypt the cluster.

Type: String Required: No

MaintenanceWindow (p. 13)

Speciﬁes the weekly time range during which maintenance on the cluster is performed. It is speciﬁed as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

• sun

• mon

• tue

• wed

• thu

• fri

• sat

Example: sun:23:00-mon:01:30 Type: String

Required: No NodeType (p. 13)

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

(24)

Request Parameters

NumReplicasPerShard (p. 13)

The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

Type: Integer Required: No NumShards (p. 13)

The number of shards the cluster will contain. The default value is 1.

Type: Integer Required: No

ParameterGroupName (p. 13)

The name of the parameter group associated with the cluster.

Type: String Required: No Port (p. 13)

The port number on which each of the nodes accepts connections.

Type: Integer Required: No SecurityGroupIds (p. 13)

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

Type: Array of strings Required: No

SnapshotArns (p. 13)

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot ﬁles stored in Amazon S3. The snapshot ﬁles are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Type: Array of strings Required: No

SnapshotName (p. 13)

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 (p. 13)

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.

Type: Integer

(25)

Response Syntax

Required: No

SnapshotWindow (p. 13)

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.

Type: String Required: No SnsTopicArn (p. 13)

The Amazon Resource Name (ARN) of the Amazon Simple Notiﬁcation Service (SNS) topic to which notiﬁcations are sent.

SubnetGroupName (p. 13)

The name of the subnet group to be used for the cluster.

Type: String Required: No Tags (p. 13)

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.

Required: No TLSEnabled (p. 13)

A ﬂag to enable in-transit encryption on the cluster.

Type: Boolean Required: No

Response Syntax

{

"Cluster": {

"Description": "string",

(26)

Response Elements

"EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string",

"NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string", "ParameterGroupStatus": "string", "PendingUpdates": {

"ACLs": {

},

} ] },

} ],

"Shards": [ {

"Endpoint": {

} ],

}

Response Elements

(27)

Errors

Cluster (p. 16)

The newly-created cluster.

Type: Cluster (p. 119) object

Errors

ACLNotFoundFault

HTTP Status Code: 400 ClusterAlreadyExistsFault

ClusterQuotaForCustomerExceededFault

HTTP Status Code: 400 InsuﬃcientClusterCapacityFault

HTTP Status Code: 400 InvalidACLStateFault

HTTP Status Code: 400 InvalidCredentialsException

HTTP Status Code: 400 InvalidVPCNetworkStateFault

NodeQuotaForClusterExceededFault

NodeQuotaForCustomerExceededFault HTTP Status Code: 400

ParameterGroupNotFoundFault

(28)

See Also

ShardsPerClusterQuotaExceededFault

HTTP Status Code: 400 SubnetGroupNotFoundFault

CreateParameterGroup

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 Conﬁguring engine parameters using parameter groups.

Request Syntax

{ "Description": "string", "Family": "string",

"ParameterGroupName": "string", "Tags": [

{

} ] }

Request Parameters

Description (p. 20)

An optional description of the parameter group.

Type: String Required: No Family (p. 20)

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

The name of the parameter group.

(30)

Response Syntax

Required: No

Response Syntax

{ "ParameterGroup": { "ARN": "string",

"Description": "string", "Family": "string", "Name": "string"

}}

Response Elements

ParameterGroup (p. 21)

The newly-created parameter group.

Type: ParameterGroup (p. 133) object

Errors

HTTP Status Code: 400 InvalidParameterGroupStateFault

ParameterGroupAlreadyExistsFault

ParameterGroupQuotaExceededFault

(31)

See Also

CreateSnapshot

Creates a copy of an entire cluster at a speciﬁc moment in time.

Request Syntax

{ "ClusterName": "string", "KmsKeyId": "string", "SnapshotName": "string", "Tags": [

{

} ] }

Request Parameters

ClusterName (p. 23)

The snapshot is created from this cluster.

Type: String Required: Yes KmsKeyId (p. 23)

The ID of the KMS key used to encrypt the snapshot.

Type: String Required: No SnapshotName (p. 23)

A name for the snapshot being created.

Required: No

(33)

Response Syntax

{ "Snapshot": { "ARN": "string",

"Shards": [ {

"Configuration": {

},

],

"VpcId": "string"

},

} }

Response Elements

Snapshot (p. 24)

The newly-created snapshot.

Errors

ClusterNotFoundFault HTTP Status Code: 400 InvalidClusterStateFault

(34)

See Also

HTTP Status Code: 400 SnapshotQuotaExceededFault

CreateSubnetGroup

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.

Request Syntax

{

"Description": "string", "SubnetGroupName": "string", "SubnetIds": [ "string" ], "Tags": [

{

} ]}

Request Parameters

Description (p. 26)

A description for the subnet group.

The name of the subnet group.

Type: String Required: Yes SubnetIds (p. 26)

A list of VPC subnet IDs for the subnet group.

Type: Array of strings Required: Yes Tags (p. 26)

(36)

Response Syntax

Required: No

Response Syntax

{ "SubnetGroup": { "ARN": "string",

"Description": "string", "Name": "string", "Subnets": [ {

"AvailabilityZone": { "Name": "string"

},

"Identifier": "string"

} ],

"VpcId": "string"

} }

Response Elements

SubnetGroup (p. 27)

The newly-created subnet group Type: SubnetGroup (p. 150) object

Errors

InvalidSubnet

HTTP Status Code: 400 SubnetGroupAlreadyExistsFault

HTTP Status Code: 400 SubnetGroupQuotaExceededFault

HTTP Status Code: 400 SubnetNotAllowedFault

(37)

See Also

HTTP Status Code: 400 SubnetQuotaExceededFault

CreateUser

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

Request Syntax

{

"AccessString": "string", "AuthenticationMode": { "Passwords": [ "string" ], "Type": "string"

},

"Tags": [ {

} ],

"UserName": "string"

}

Request Parameters

AccessString (p. 29)

Access permissions string used for this user.

Type: String Pattern: .*\S.*

Required: Yes

AuthenticationMode (p. 29)

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

Type: AuthenticationMode (p. 117) object Required: Yes

Tags (p. 29)

Required: No UserName (p. 29)

The name of the user. This value must be unique as it also serves as the user identiﬁer.

(39)

Response Syntax

Type: String

Required: Yes

Response Syntax

{ "User": {

"AccessString": "string", "ACLNames": [ "string" ], "ARN": "string",

"Authentication": { "PasswordCount": number, "Type": "string"

},

"Status": "string"

}}

Response Elements

User (p. 30)

The newly-created user.

Type: User (p. 154) object

Errors

DuplicateUserNameFault

(40)

See Also

UserAlreadyExistsFault

HTTP Status Code: 400 UserQuotaExceededFault

DeleteACL

Deletes an Access Control List. The ACL must ﬁrst be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

Request Syntax

{ "ACLName": "string"

}

Request Parameters

ACLName (p. 32)

The name of the Access Control List to delete Type: String

Required: Yes

Response Syntax

{

"ACL": {

"ARN": "string",

"PendingChanges": {

"Status": "string", "UserNames": [ "string" ] }}

Response Elements

ACL (p. 32)

The Access Control List object that has been deleted.

Type: ACL (p. 112) object

(42)

Errors

HTTP Status Code: 400 InvalidACLStateFault

DeleteCluster

Deletes a cluster. It also deletes all associated nodes and node endpoints

Request Syntax

{

"ClusterName": "string", "FinalSnapshotName": "string"

}

Request Parameters

ClusterName (p. 34)

The name of the cluster to be deleted Type: String

Required: Yes

FinalSnapshotName (p. 34)

The user-supplied name of a ﬁnal cluster snapshot. This is the unique name that identiﬁes the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

Response Syntax

{ "Cluster": {

"Description": "string",

"EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string",

"NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string",

(44)

Response Elements

"ParameterGroupStatus": "string", "PendingUpdates": {

"ACLs": {

},

} ] },

} ],

"Shards": [ {

"Endpoint": {

} ],

}

Response Elements

Cluster (p. 34)

The cluster object that has been deleted Type: Cluster (p. 119) object

(45)

Errors

ClusterNotFoundFault

HTTP Status Code: 400 InvalidClusterStateFault

DeleteParameterGroup

Deletes the speciﬁed 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.

Request Syntax

{ "ParameterGroupName": "string"

}

Request Parameters

The name of the parameter group to delete.

Response Syntax

{

"ParameterGroup": { "ARN": "string",

"Description": "string", "Family": "string", "Name": "string"

}}

Response Elements

ParameterGroup (p. 37)

The parameter group that has been deleted.

Type: ParameterGroup (p. 133) object

Errors

(47)

See Also

HTTP Status Code: 400 InvalidParameterGroupStateFault

HTTP Status Code: 400 ParameterGroupNotFoundFault

DeleteSnapshot

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.

Request Syntax

{ "SnapshotName": "string"

}

Request Parameters

SnapshotName (p. 39)

The name of the snapshot to delete Type: String

Required: Yes

Response Syntax

{ "Snapshot": { "ARN": "string",

"Shards": [ {

"Configuration": {

},

],

"VpcId": "string"

},

(49)

Response Elements

}}

Response Elements

Snapshot (p. 39)

The snapshot object that has been deleted.

Errors

HTTP Status Code: 400 InvalidSnapshotStateFault

HTTP Status Code: 400 SnapshotNotFoundFault

DeleteSubnetGroup

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

Request Syntax

{ "SubnetGroupName": "string"

}

Request Parameters

The name of the subnet group to delete Type: String

Required: Yes

Response Syntax

{ "SubnetGroup": { "ARN": "string",

"Description": "string", "Name": "string", "Subnets": [ {

"AvailabilityZone": { "Name": "string"

},

"Identifier": "string"

} ],

"VpcId": "string"

} }

Response Elements

SubnetGroup (p. 42)

The subnet group object that has been deleted.

(52)

Errors

Type: SubnetGroup (p. 150) object

Errors

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400 SubnetGroupInUseFault

HTTP Status Code: 400 SubnetGroupNotFoundFault

DeleteUser

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

Request Syntax

{

"UserName": "string"

}

Request Parameters

UserName (p. 44)

The name of the user to delete Type: String

Required: Yes

Response Syntax

{ "User": {

"AccessString": "string", "ACLNames": [ "string" ], "ARN": "string",

"Authentication": { "PasswordCount": number, "Type": "string"

},

"Status": "string"

}}

Response Elements

User (p. 44)

The user object that has been deleted.

(54)

Errors

Type: User (p. 154) object

Errors

InvalidParameterValueException

HTTP Status Code: 400 InvalidUserStateFault

HTTP Status Code: 400 UserNotFoundFault

DescribeACLs

Returns a list of ACLs

Request Syntax

{

"ACLName": "string", "MaxResults": number, "NextToken": "string"

}

Request Parameters

ACLName (p. 46) The name of the ACL Type: String

Required: No MaxResults (p. 46)

The maximum number of records to include in the response. If more records exist than the speciﬁed MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer Required: No NextToken (p. 46)

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.

Response Syntax

{

"ACLs": [ {

"ARN": "string",

"PendingChanges": {

(56)

Response Elements

"Status": "string", "UserNames": [ "string" ] }

],

"NextToken": "string"

}

Response Elements

ACLs (p. 46) The list of ACLs

Type: Array of ACL (p. 112) objects NextToken (p. 46)

Type: String

Errors

DescribeClusters

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

Request Syntax

{

"ClusterName": "string", "MaxResults": number, "NextToken": "string", "ShowShardDetails": boolean }

Request Parameters

ClusterName (p. 49) The name of the cluster Type: String

Required: No MaxResults (p. 49)

The maximum number of records to include in the response. If more records exist than the speciﬁed MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer Required: No NextToken (p. 49)

An optional argument to pass in case the total number of records exceeds the value of MaxResults.

ShowShardDetails (p. 49)

An optional ﬂag that can be included in the request to retrieve information about the individual shard(s).

Type: Boolean Required: No

Amazon MemoryDB

Amazon MemoryDB

API Reference

API Version 2021-01-01

Amazon MemoryDB: API Reference

Table of Contents

Welcome

Actions

BatchUpdateCluster

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CopySnapshot

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateACL

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateCluster

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateParameterGroup

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateSnapshot

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateSubnetGroup

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

CreateUser

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DeleteACL

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DeleteCluster

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DeleteParameterGroup

Request Syntax