# Actions The following actions are supported: + [BatchUpdateCluster](API_BatchUpdateCluster.md) + [CopySnapshot](API_CopySnapshot.md) + [CreateACL](API_CreateACL.md) + [CreateCluster](API_CreateCluster.md) + [CreateMultiRegionCluster](API_CreateMultiRegionCluster.md) + [CreateParameterGroup](API_CreateParameterGroup.md) + [CreateSnapshot](API_CreateSnapshot.md) + [CreateSubnetGroup](API_CreateSubnetGroup.md) + [CreateUser](API_CreateUser.md) + [DeleteACL](API_DeleteACL.md) + [DeleteCluster](API_DeleteCluster.md) + [DeleteMultiRegionCluster](API_DeleteMultiRegionCluster.md) + [DeleteParameterGroup](API_DeleteParameterGroup.md) + [DeleteSnapshot](API_DeleteSnapshot.md) + [DeleteSubnetGroup](API_DeleteSubnetGroup.md) + [DeleteUser](API_DeleteUser.md) + [DescribeACLs](API_DescribeACLs.md) + [DescribeClusters](API_DescribeClusters.md) + [DescribeEngineVersions](API_DescribeEngineVersions.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeMultiRegionClusters](API_DescribeMultiRegionClusters.md) + [DescribeParameterGroups](API_DescribeParameterGroups.md) + [DescribeParameters](API_DescribeParameters.md) + [DescribeReservedNodes](API_DescribeReservedNodes.md) + [DescribeReservedNodesOfferings](API_DescribeReservedNodesOfferings.md) + [DescribeServiceUpdates](API_DescribeServiceUpdates.md) + [DescribeSnapshots](API_DescribeSnapshots.md) + [DescribeSubnetGroups](API_DescribeSubnetGroups.md) + [DescribeUsers](API_DescribeUsers.md) + [FailoverShard](API_FailoverShard.md) + [ListAllowedMultiRegionClusterUpdates](API_ListAllowedMultiRegionClusterUpdates.md) + [ListAllowedNodeTypeUpdates](API_ListAllowedNodeTypeUpdates.md) + [ListTags](API_ListTags.md) + [PurchaseReservedNodesOffering](API_PurchaseReservedNodesOffering.md) + [ResetParameterGroup](API_ResetParameterGroup.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateACL](API_UpdateACL.md) + [UpdateCluster](API_UpdateCluster.md) + [UpdateMultiRegionCluster](API_UpdateMultiRegionCluster.md) + [UpdateParameterGroup](API_UpdateParameterGroup.md) + [UpdateSubnetGroup](API_UpdateSubnetGroup.md) + [UpdateUser](API_UpdateUser.md) # 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/managing-updates.html#applying-updates). ## Request Syntax ``` { "ClusterNames": [ "string" ], "ServiceUpdate": { "ServiceUpdateNameToApply": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterNames](#API_BatchUpdateCluster_RequestSyntax) ** The cluster names to apply the updates. Type: Array of strings Array Members: Maximum number of 20 items. Required: Yes ** [ServiceUpdate](#API_BatchUpdateCluster_RequestSyntax) ** The unique ID of the service update Type: [ServiceUpdateRequest](API_ServiceUpdateRequest.md) object Required: No ## Response Syntax ``` { "ProcessedClusters": [ { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "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" } ] } ``` ## 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](#API_BatchUpdateCluster_ResponseSyntax) ** The list of clusters that have been updated. Type: Array of [Cluster](API_Cluster.md) objects ** [UnprocessedClusters](#API_BatchUpdateCluster_ResponseSyntax) ** The list of clusters where updates have not been applied. Type: Array of [UnprocessedCluster](API_UnprocessedCluster.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceUpdateNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/BatchUpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/BatchUpdateCluster) # 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 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [KmsKeyId](#API_CopySnapshot_RequestSyntax) ** The ID of the KMS key used to encrypt the target snapshot. Type: String Length Constraints: Maximum length of 2048. Required: No ** [SourceSnapshotName](#API_CopySnapshot_RequestSyntax) ** The name of an existing snapshot from which to make a copy. Type: String Required: Yes ** [Tags](#API_CopySnapshot_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ** [TargetBucket](#API_CopySnapshot_RequestSyntax) ** 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/snapshots-exporting.html). Type: String Length Constraints: Maximum length of 255. Pattern: `^[A-Za-z0-9._-]+$` Required: No ** [TargetSnapshotName](#API_CopySnapshot_RequestSyntax) ** 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. This value is stored as a lowercase string. Type: String Required: Yes ## Response Syntax ``` { "Snapshot": { "ARN": "string", "ClusterConfiguration": { "Description": "string", "Engine": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "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" }, "DataTiering": "string", "KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string" } } ``` ## 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. ** [Snapshot](#API_CopySnapshot_ResponseSyntax) ** Represents a copy of an entire cluster as of the time when the snapshot was taken. Type: [Snapshot](API_Snapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CopySnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CopySnapshot) # CreateACL Creates an Access Control List. For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). ## Request Syntax ``` { "ACLName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserNames": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_CreateACL_RequestSyntax) ** The name of the Access Control List. This value is stored as a lowercase string. Type: String Required: Yes ** [Tags](#API_CreateACL_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ** [UserNames](#API_CreateACL_RequestSyntax) ** 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 ## Response Syntax ``` { "ACL": { "ARN": "string", "Clusters": [ "string" ], "MinimumEngineVersion": "string", "Name": "string", "PendingChanges": { "UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] }, "Status": "string", "UserNames": [ "string" ] } } ``` ## 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. ** [ACL](#API_CreateACL_ResponseSyntax) ** The newly-created Access Control List. Type: [ACL](API_ACL.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLAlreadyExistsFault ** HTTP Status Code: 400 ** ACLQuotaExceededFault ** HTTP Status Code: 400 ** DefaultUserRequired ** HTTP Status Code: 400 ** DuplicateUserNameFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateACL) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateACL) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateACL) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateACL) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateACL) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateACL) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateACL) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateACL) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateACL) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateACL) # CreateCluster Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software. ## Request Syntax ``` { "ACLName": "string", "AutoMinorVersionUpgrade": boolean, "ClusterName": "string", "DataTiering": boolean, "Description": "string", "Engine": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "NetworkType": "string", "NodeType": "string", "NumReplicasPerShard": number, "NumShards": number, "ParameterGroupName": "string", "Port": number, "SecurityGroupIds": [ "string" ], "SnapshotArns": [ "string" ], "SnapshotName": "string", "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SubnetGroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TLSEnabled": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_CreateCluster_RequestSyntax) ** The name of the Access Control List to associate with the cluster. Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: Yes ** [AutoMinorVersionUpgrade](#API_CreateCluster_RequestSyntax) ** When set to true, the cluster will automatically receive minor engine version upgrades after launch. Type: Boolean Required: No ** [ClusterName](#API_CreateCluster_RequestSyntax) ** The name of the cluster. This value must be unique as it also serves as the cluster identifier. This value is stored as a lowercase string. Type: String Required: Yes ** [DataTiering](#API_CreateCluster_RequestSyntax) ** Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). Type: Boolean Required: No ** [Description](#API_CreateCluster_RequestSyntax) ** An optional description of the cluster. Type: String Required: No ** [Engine](#API_CreateCluster_RequestSyntax) ** The name of the engine to be used for the cluster. Type: String Required: No ** [EngineVersion](#API_CreateCluster_RequestSyntax) ** The version number of the Redis OSS engine to be used for the cluster. Type: String Required: No ** [IpDiscovery](#API_CreateCluster_RequestSyntax) ** The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'. Type: String Valid Values: `ipv4 | ipv6` Required: No ** [KmsKeyId](#API_CreateCluster_RequestSyntax) ** The ID of the KMS key used to encrypt the cluster. Type: String Required: No ** [MaintenanceWindow](#API_CreateCluster_RequestSyntax) ** Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for `ddd` are: + `sun` + `mon` + `tue` + `wed` + `thu` + `fri` + `sat` Example: `sun:23:00-mon:01:30` Type: String Required: No ** [MultiRegionClusterName](#API_CreateCluster_RequestSyntax) ** The name of the multi-Region cluster to be created. Type: String Required: No ** [NetworkType](#API_CreateCluster_RequestSyntax) ** Specifies the IP address type for the cluster. Valid values are 'ipv4', 'ipv6', or 'dual\$1stack'. When set to 'ipv4', the cluster will only be accessible via IPv4 addresses. When set to 'ipv6', the cluster will only be accessible via IPv6 addresses. When set to 'dual\$1stack', the cluster will be accessible via both IPv4 and IPv6 addresses. If not specified, the default is 'ipv4'. Type: String Valid Values: `ipv4 | ipv6 | dual_stack` Required: No ** [NodeType](#API_CreateCluster_RequestSyntax) ** The compute and memory capacity of the nodes in the cluster. Type: String Required: Yes ** [NumReplicasPerShard](#API_CreateCluster_RequestSyntax) ** The number of replicas to apply to each shard. The default value is 1. The maximum is 5. Type: Integer Required: No ** [NumShards](#API_CreateCluster_RequestSyntax) ** The number of shards the cluster will contain. The default value is 1. Type: Integer Required: No ** [ParameterGroupName](#API_CreateCluster_RequestSyntax) ** The name of the parameter group associated with the cluster. Type: String Required: No ** [Port](#API_CreateCluster_RequestSyntax) ** The port number on which each of the nodes accepts connections. Type: Integer Required: No ** [SecurityGroupIds](#API_CreateCluster_RequestSyntax) ** A list of security group names to associate with this cluster. Type: Array of strings Required: No ** [SnapshotArns](#API_CreateCluster_RequestSyntax) ** 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. Type: Array of strings Required: No ** [SnapshotName](#API_CreateCluster_RequestSyntax) ** 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. Type: String Required: No ** [SnapshotRetentionLimit](#API_CreateCluster_RequestSyntax) ** 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 Required: No ** [SnapshotWindow](#API_CreateCluster_RequestSyntax) ** 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](#API_CreateCluster_RequestSyntax) ** The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. Type: String Required: No ** [SubnetGroupName](#API_CreateCluster_RequestSyntax) ** The name of the subnet group to be used for the cluster. Type: String Required: No ** [Tags](#API_CreateCluster_RequestSyntax) ** 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ** [TLSEnabled](#API_CreateCluster_RequestSyntax) ** A flag to enable in-transit encryption on the cluster. Type: Boolean Required: No ## Response Syntax ``` { "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } } ``` ## 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. ** [Cluster](#API_CreateCluster_ResponseSyntax) ** The newly-created cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** ClusterAlreadyExistsFault ** HTTP Status Code: 400 ** ClusterQuotaForCustomerExceededFault ** HTTP Status Code: 400 ** InsufficientClusterCapacityFault ** HTTP Status Code: 400 ** InvalidACLStateFault ** HTTP Status Code: 400 ** InvalidCredentialsException ** HTTP Status Code: 400 ** InvalidMultiRegionClusterStateFault ** The requested operation cannot be performed on the multi-Region cluster in its current state. HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ** NodeQuotaForClusterExceededFault ** HTTP Status Code: 400 ** NodeQuotaForCustomerExceededFault ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** ShardsPerClusterQuotaExceededFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateCluster) # CreateMultiRegionCluster Creates a new multi-Region cluster. ## Request Syntax ``` { "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterNameSuffix": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumShards": number, "Tags": [ { "Key": "string", "Value": "string" } ], "TLSEnabled": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_CreateMultiRegionCluster_RequestSyntax) ** A description for the multi-Region cluster. Type: String Required: No ** [Engine](#API_CreateMultiRegionCluster_RequestSyntax) ** The name of the engine to be used for the multi-Region cluster. Type: String Required: No ** [EngineVersion](#API_CreateMultiRegionCluster_RequestSyntax) ** The version of the engine to be used for the multi-Region cluster. Type: String Required: No ** [MultiRegionClusterNameSuffix](#API_CreateMultiRegionCluster_RequestSyntax) ** A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions. This value is stored as a lowercase string. Type: String Required: Yes ** [MultiRegionParameterGroupName](#API_CreateMultiRegionCluster_RequestSyntax) ** The name of the multi-Region parameter group to be associated with the cluster. Type: String Required: No ** [NodeType](#API_CreateMultiRegionCluster_RequestSyntax) ** The node type to be used for the multi-Region cluster. Type: String Required: Yes ** [NumShards](#API_CreateMultiRegionCluster_RequestSyntax) ** The number of shards for the multi-Region cluster. Type: Integer Required: No ** [Tags](#API_CreateMultiRegionCluster_RequestSyntax) ** A list of tags to be applied to the multi-Region cluster. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ** [TLSEnabled](#API_CreateMultiRegionCluster_RequestSyntax) ** Whether to enable TLS encryption for the multi-Region cluster. Type: Boolean Required: No ## Response Syntax ``` { "MultiRegionCluster": { "ARN": "string", "Clusters": [ { "ARN": "string", "ClusterName": "string", "Region": "string", "Status": "string" } ], "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumberOfShards": number, "Status": "string", "TLSEnabled": boolean } } ``` ## 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. ** [MultiRegionCluster](#API_CreateMultiRegionCluster_ResponseSyntax) ** Details about the newly created multi-Region cluster. Type: [MultiRegionCluster](API_MultiRegionCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterQuotaForCustomerExceededFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterAlreadyExistsFault ** A multi-Region cluster with the specified name already exists. HTTP Status Code: 400 ** MultiRegionParameterGroupNotFoundFault ** The specified multi-Region parameter group does not exist. HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateMultiRegionCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateMultiRegionCluster) # 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 [Configuring engine parameters using parameter groups](https://docs.aws.amazon.com/MemoryDB/latest/devguide/parametergroups.html). ## Request Syntax ``` { "Description": "string", "Family": "string", "ParameterGroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_CreateParameterGroup_RequestSyntax) ** An optional description of the parameter group. Type: String Required: No ** [Family](#API_CreateParameterGroup_RequestSyntax) ** The name of the parameter group family that the parameter group can be used with. Type: String Required: Yes ** [ParameterGroupName](#API_CreateParameterGroup_RequestSyntax) ** The name of the parameter group. This value is stored as a lowercase string. Type: String Required: Yes ** [Tags](#API_CreateParameterGroup_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ## Response Syntax ``` { "ParameterGroup": { "ARN": "string", "Description": "string", "Family": "string", "Name": "string" } } ``` ## 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. ** [ParameterGroup](#API_CreateParameterGroup_ResponseSyntax) ** The newly-created parameter group. Type: [ParameterGroup](API_ParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterGroupStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupAlreadyExistsFault ** HTTP Status Code: 400 ** ParameterGroupQuotaExceededFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateParameterGroup) # CreateSnapshot Creates a copy of an entire cluster at a specific moment in time. ## Request Syntax ``` { "ClusterName": "string", "KmsKeyId": "string", "SnapshotName": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_CreateSnapshot_RequestSyntax) ** The snapshot is created from this cluster. Type: String Required: Yes ** [KmsKeyId](#API_CreateSnapshot_RequestSyntax) ** The ID of the KMS key used to encrypt the snapshot. Type: String Required: No ** [SnapshotName](#API_CreateSnapshot_RequestSyntax) ** A name for the snapshot being created. This value is stored as a lowercase string. Type: String Required: Yes ** [Tags](#API_CreateSnapshot_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ## Response Syntax ``` { "Snapshot": { "ARN": "string", "ClusterConfiguration": { "Description": "string", "Engine": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "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" }, "DataTiering": "string", "KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string" } } ``` ## 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. ** [Snapshot](#API_CreateSnapshot_ResponseSyntax) ** The newly-created snapshot. Type: [Snapshot](API_Snapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotAlreadyExistsFault ** HTTP Status Code: 400 ** SnapshotQuotaExceededFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateSnapshot) # 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/subnetgroups.html). ## Request Syntax ``` { "Description": "string", "SubnetGroupName": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_CreateSubnetGroup_RequestSyntax) ** A description for the subnet group. Type: String Required: No ** [SubnetGroupName](#API_CreateSubnetGroup_RequestSyntax) ** The name of the subnet group. This value is stored as a lowercase string. Type: String Required: Yes ** [SubnetIds](#API_CreateSubnetGroup_RequestSyntax) ** A list of VPC subnet IDs for the subnet group. Type: Array of strings Required: Yes ** [Tags](#API_CreateSubnetGroup_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ## Response Syntax ``` { "SubnetGroup": { "ARN": "string", "Description": "string", "Name": "string", "Subnets": [ { "AvailabilityZone": { "Name": "string" }, "Identifier": "string", "SupportedNetworkTypes": [ "string" ] } ], "SupportedNetworkTypes": [ "string" ], "VpcId": "string" } } ``` ## 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. ** [SubnetGroup](#API_CreateSubnetGroup_ResponseSyntax) ** The newly-created subnet group. Type: [SubnetGroup](API_SubnetGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidSubnet ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupAlreadyExistsFault ** HTTP Status Code: 400 ** SubnetGroupQuotaExceededFault ** HTTP Status Code: 400 ** SubnetNotAllowedFault ** HTTP Status Code: 400 ** SubnetQuotaExceededFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateSubnetGroup) # CreateUser Creates a MemoryDB user. For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). ## Request Syntax ``` { "AccessString": "string", "AuthenticationMode": { "Passwords": [ "string" ], "Type": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccessString](#API_CreateUser_RequestSyntax) ** Access permissions string used for this user. Type: String Pattern: `.*\S.*` Required: Yes ** [AuthenticationMode](#API_CreateUser_RequestSyntax) ** Denotes the user's authentication properties, such as whether it requires a password to authenticate. Type: [AuthenticationMode](API_AuthenticationMode.md) object Required: Yes ** [Tags](#API_CreateUser_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ** [UserName](#API_CreateUser_RequestSyntax) ** The name of the user. This value must be unique as it also serves as the user identifier. This value is stored as a lowercase string. Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: Yes ## Response Syntax ``` { "User": { "AccessString": "string", "ACLNames": [ "string" ], "ARN": "string", "Authentication": { "PasswordCount": number, "Type": "string" }, "MinimumEngineVersion": "string", "Name": "string", "Status": "string" } } ``` ## 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. ** [User](#API_CreateUser_ResponseSyntax) ** The newly-created user. Type: [User](API_User.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DuplicateUserNameFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ** UserAlreadyExistsFault ** HTTP Status Code: 400 ** UserQuotaExceededFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/CreateUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/CreateUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/CreateUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/CreateUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/CreateUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/CreateUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/CreateUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/CreateUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/CreateUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/CreateUser) # DeleteACL 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)](https://docs.aws.amazon.com/MemoryDB/latest/devguide/clusters.acls.html). ## Request Syntax ``` { "ACLName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_DeleteACL_RequestSyntax) ** The name of the Access Control List to delete. Type: String Required: Yes ## Response Syntax ``` { "ACL": { "ARN": "string", "Clusters": [ "string" ], "MinimumEngineVersion": "string", "Name": "string", "PendingChanges": { "UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] }, "Status": "string", "UserNames": [ "string" ] } } ``` ## 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. ** [ACL](#API_DeleteACL_ResponseSyntax) ** The Access Control List object that has been deleted. Type: [ACL](API_ACL.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** InvalidACLStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteACL) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteACL) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteACL) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteACL) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteACL) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteACL) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteACL) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteACL) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteACL) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteACL) # DeleteCluster Deletes a cluster. It also deletes all associated nodes and node endpoints. **Note** `CreateSnapshot` permission is required to create a final snapshot. Without this permission, the API call will fail with an `Access Denied` exception. ## Request Syntax ``` { "ClusterName": "string", "FinalSnapshotName": "string", "MultiRegionClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DeleteCluster_RequestSyntax) ** The name of the cluster to be deleted Type: String Required: Yes ** [FinalSnapshotName](#API_DeleteCluster_RequestSyntax) ** 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. Type: String Required: No ** [MultiRegionClusterName](#API_DeleteCluster_RequestSyntax) ** The name of the multi-Region cluster to be deleted. Type: String Required: No ## Response Syntax ``` { "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } } ``` ## 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. ** [Cluster](#API_DeleteCluster_ResponseSyntax) ** The cluster object that has been deleted. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotAlreadyExistsFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteCluster) # DeleteMultiRegionCluster Deletes an existing multi-Region cluster. ## Request Syntax ``` { "MultiRegionClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MultiRegionClusterName](#API_DeleteMultiRegionCluster_RequestSyntax) ** The name of the multi-Region cluster to be deleted. Type: String Required: Yes ## Response Syntax ``` { "MultiRegionCluster": { "ARN": "string", "Clusters": [ { "ARN": "string", "ClusterName": "string", "Region": "string", "Status": "string" } ], "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumberOfShards": number, "Status": "string", "TLSEnabled": boolean } } ``` ## 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. ** [MultiRegionCluster](#API_DeleteMultiRegionCluster_ResponseSyntax) ** Details about the deleted multi-Region cluster. Type: [MultiRegionCluster](API_MultiRegionCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidMultiRegionClusterStateFault ** The requested operation cannot be performed on the multi-Region cluster in its current state. HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteMultiRegionCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteMultiRegionCluster) # DeleteParameterGroup 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. ## Request Syntax ``` { "ParameterGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ParameterGroupName](#API_DeleteParameterGroup_RequestSyntax) ** The name of the parameter group to delete. Type: String Required: Yes ## Response Syntax ``` { "ParameterGroup": { "ARN": "string", "Description": "string", "Family": "string", "Name": "string" } } ``` ## 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. ** [ParameterGroup](#API_DeleteParameterGroup_ResponseSyntax) ** The parameter group that has been deleted. Type: [ParameterGroup](API_ParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterGroupStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteParameterGroup) # 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 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SnapshotName](#API_DeleteSnapshot_RequestSyntax) ** The name of the snapshot to delete. Type: String Required: Yes ## Response Syntax ``` { "Snapshot": { "ARN": "string", "ClusterConfiguration": { "Description": "string", "Engine": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "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" }, "DataTiering": "string", "KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string" } } ``` ## 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. ** [Snapshot](#API_DeleteSnapshot_ResponseSyntax) ** The snapshot object that has been deleted. Type: [Snapshot](API_Snapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** InvalidSnapshotStateFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteSnapshot) # 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 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [SubnetGroupName](#API_DeleteSubnetGroup_RequestSyntax) ** 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", "SupportedNetworkTypes": [ "string" ] } ], "SupportedNetworkTypes": [ "string" ], "VpcId": "string" } } ``` ## 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. ** [SubnetGroup](#API_DeleteSubnetGroup_ResponseSyntax) ** The subnet group object that has been deleted. Type: [SubnetGroup](API_SubnetGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupInUseFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteSubnetGroup) # 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 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [UserName](#API_DeleteUser_RequestSyntax) ** The name of the user to delete Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: Yes ## Response Syntax ``` { "User": { "AccessString": "string", "ACLNames": [ "string" ], "ARN": "string", "Authentication": { "PasswordCount": number, "Type": "string" }, "MinimumEngineVersion": "string", "Name": "string", "Status": "string" } } ``` ## 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. ** [User](#API_DeleteUser_ResponseSyntax) ** The user object that has been deleted. Type: [User](API_User.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValueException ** HTTP Status Code: 400 ** InvalidUserStateFault ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DeleteUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DeleteUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DeleteUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DeleteUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DeleteUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DeleteUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DeleteUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DeleteUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DeleteUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DeleteUser) # DescribeACLs Returns a list of ACLs. ## Request Syntax ``` { "ACLName": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_DescribeACLs_RequestSyntax) ** The name of the ACL. Type: String Required: No ** [MaxResults](#API_DescribeACLs_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeACLs_RequestSyntax) ** 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. Type: String Required: No ## Response Syntax ``` { "ACLs": [ { "ARN": "string", "Clusters": [ "string" ], "MinimumEngineVersion": "string", "Name": "string", "PendingChanges": { "UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] }, "Status": "string", "UserNames": [ "string" ] } ], "NextToken": "string" } ``` ## 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. ** [ACLs](#API_DescribeACLs_ResponseSyntax) ** The list of ACLs. Type: Array of [ACL](API_ACL.md) objects ** [NextToken](#API_DescribeACLs_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeACLs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeACLs) # 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 For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DescribeClusters_RequestSyntax) ** The name of the cluster. Type: String Required: No ** [MaxResults](#API_DescribeClusters_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeClusters_RequestSyntax) ** 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. Type: String Required: No ** [ShowShardDetails](#API_DescribeClusters_RequestSyntax) ** An optional flag that can be included in the request to retrieve information about the individual shard(s). Type: Boolean Required: No ## Response Syntax ``` { "Clusters": [ { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } ], "NextToken": "string" } ``` ## 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. ** [Clusters](#API_DescribeClusters_ResponseSyntax) ** A list of clusters Type: Array of [Cluster](API_Cluster.md) objects ** [NextToken](#API_DescribeClusters_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeClusters) # DescribeEngineVersions Returns a list of the available Redis OSS engine versions. ## Request Syntax ``` { "DefaultOnly": boolean, "Engine": "string", "EngineVersion": "string", "MaxResults": number, "NextToken": "string", "ParameterGroupFamily": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [DefaultOnly](#API_DescribeEngineVersions_RequestSyntax) ** If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned. Type: Boolean Required: No ** [Engine](#API_DescribeEngineVersions_RequestSyntax) ** The name of the engine for which to list available versions. Type: String Required: No ** [EngineVersion](#API_DescribeEngineVersions_RequestSyntax) ** The Redis OSS engine version Type: String Required: No ** [MaxResults](#API_DescribeEngineVersions_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeEngineVersions_RequestSyntax) ** 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. Type: String Required: No ** [ParameterGroupFamily](#API_DescribeEngineVersions_RequestSyntax) ** The name of a specific parameter group family to return details for. Type: String Required: No ## Response Syntax ``` { "EngineVersions": [ { "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "ParameterGroupFamily": "string" } ], "NextToken": "string" } ``` ## 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. ** [EngineVersions](#API_DescribeEngineVersions_ResponseSyntax) ** A list of engine version details. Each element in the list contains detailed information about one engine version. Type: Array of [EngineVersionInfo](API_EngineVersionInfo.md) objects ** [NextToken](#API_DescribeEngineVersions_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeEngineVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeEngineVersions) # DescribeEvents 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. ## Request Syntax ``` { "Duration": number, "EndTime": number, "MaxResults": number, "NextToken": "string", "SourceName": "string", "SourceType": "string", "StartTime": number } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Duration](#API_DescribeEvents_RequestSyntax) ** The number of minutes worth of events to retrieve. Type: Integer Required: No ** [EndTime](#API_DescribeEvents_RequestSyntax) ** The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z Type: Timestamp Required: No ** [MaxResults](#API_DescribeEvents_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeEvents_RequestSyntax) ** 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. Type: String Required: No ** [SourceName](#API_DescribeEvents_RequestSyntax) ** The identifier of the event source for which events are returned. If not specified, all sources are included in the response. Type: String Required: No ** [SourceType](#API_DescribeEvents_RequestSyntax) ** The event source to retrieve events for. If no value is specified, all events are returned. Type: String Valid Values: `node | parameter-group | subnet-group | cluster | user | acl` Required: No ** [StartTime](#API_DescribeEvents_RequestSyntax) ** The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z Type: Timestamp Required: No ## Response Syntax ``` { "Events": [ { "Date": number, "Message": "string", "SourceName": "string", "SourceType": "string" } ], "NextToken": "string" } ``` ## 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. ** [Events](#API_DescribeEvents_ResponseSyntax) ** A list of events. Each element in the list contains detailed information about one event. Type: Array of [Event](API_Event.md) objects ** [NextToken](#API_DescribeEvents_ResponseSyntax) ** 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. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeEvents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeEvents) # DescribeMultiRegionClusters Returns details about one or more multi-Region clusters. ## Request Syntax ``` { "MaxResults": number, "MultiRegionClusterName": "string", "NextToken": "string", "ShowClusterDetails": boolean } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeMultiRegionClusters_RequestSyntax) ** The maximum number of results to return. Type: Integer Required: No ** [MultiRegionClusterName](#API_DescribeMultiRegionClusters_RequestSyntax) ** The name of a specific multi-Region cluster to describe. Type: String Required: No ** [NextToken](#API_DescribeMultiRegionClusters_RequestSyntax) ** A token to specify where to start paginating. Type: String Required: No ** [ShowClusterDetails](#API_DescribeMultiRegionClusters_RequestSyntax) ** Details about the multi-Region cluster. Type: Boolean Required: No ## Response Syntax ``` { "MultiRegionClusters": [ { "ARN": "string", "Clusters": [ { "ARN": "string", "ClusterName": "string", "Region": "string", "Status": "string" } ], "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumberOfShards": number, "Status": "string", "TLSEnabled": boolean } ], "NextToken": "string" } ``` ## 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. ** [MultiRegionClusters](#API_DescribeMultiRegionClusters_ResponseSyntax) ** A list of multi-Region clusters. Type: Array of [MultiRegionCluster](API_MultiRegionCluster.md) objects ** [NextToken](#API_DescribeMultiRegionClusters_ResponseSyntax) ** A token to use to retrieve the next page of results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeMultiRegionClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeMultiRegionClusters) # DescribeParameterGroups Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ParameterGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeParameterGroups_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeParameterGroups_RequestSyntax) ** 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. Type: String Required: No ** [ParameterGroupName](#API_DescribeParameterGroups_RequestSyntax) ** The name of a specific parameter group to return details for. Type: String Required: No ## Response Syntax ``` { "NextToken": "string", "ParameterGroups": [ { "ARN": "string", "Description": "string", "Family": "string", "Name": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeParameterGroups_ResponseSyntax) ** 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. Type: String ** [ParameterGroups](#API_DescribeParameterGroups_ResponseSyntax) ** A list of parameter groups. Each element in the list contains detailed information about one parameter group. Type: Array of [ParameterGroup](API_ParameterGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeParameterGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeParameterGroups) # DescribeParameters Returns the detailed parameter list for a particular parameter group. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ParameterGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeParameters_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeParameters_RequestSyntax) ** 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. Type: String Required: No ** [ParameterGroupName](#API_DescribeParameters_RequestSyntax) ** he name of a specific parameter group to return details for. Type: String Required: Yes ## Response Syntax ``` { "NextToken": "string", "Parameters": [ { "AllowedValues": "string", "DataType": "string", "Description": "string", "MinimumEngineVersion": "string", "Name": "string", "Value": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeParameters_ResponseSyntax) ** 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. Type: String ** [Parameters](#API_DescribeParameters_ResponseSyntax) ** A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter. Type: Array of [Parameter](API_Parameter.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeParameters) # DescribeReservedNodes Returns information about reserved nodes for this account, or about a specified reserved node. ## Request Syntax ``` { "Duration": "string", "MaxResults": number, "NextToken": "string", "NodeType": "string", "OfferingType": "string", "ReservationId": "string", "ReservedNodesOfferingId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Duration](#API_DescribeReservedNodes_RequestSyntax) ** The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration. Type: String Required: No ** [MaxResults](#API_DescribeReservedNodes_RequestSyntax) ** The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Type: Integer Required: No ** [NextToken](#API_DescribeReservedNodes_RequestSyntax) ** An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Required: No ** [NodeType](#API_DescribeReservedNodes_RequestSyntax) ** The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see [Supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported). Type: String Required: No ** [OfferingType](#API_DescribeReservedNodes_RequestSyntax) ** The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"\$1"Partial Upfront"\$1 "No Upfront" Type: String Required: No ** [ReservationId](#API_DescribeReservedNodes_RequestSyntax) ** The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID. Type: String Required: No ** [ReservedNodesOfferingId](#API_DescribeReservedNodes_RequestSyntax) ** The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier. Type: String Required: No ## Response Syntax ``` { "NextToken": "string", "ReservedNodes": [ { "ARN": "string", "Duration": number, "FixedPrice": number, "NodeCount": number, "NodeType": "string", "OfferingType": "string", "RecurringCharges": [ { "RecurringChargeAmount": number, "RecurringChargeFrequency": "string" } ], "ReservationId": "string", "ReservedNodesOfferingId": "string", "StartTime": number, "State": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeReservedNodes_ResponseSyntax) ** An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String ** [ReservedNodes](#API_DescribeReservedNodes_ResponseSyntax) ** Returns information about reserved nodes for this account, or about a specified reserved node. Type: Array of [ReservedNode](API_ReservedNode.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ReservedNodeNotFoundFault ** The requested node does not exist. HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeReservedNodes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeReservedNodes) # DescribeReservedNodesOfferings Lists available reserved node offerings. ## Request Syntax ``` { "Duration": "string", "MaxResults": number, "NextToken": "string", "NodeType": "string", "OfferingType": "string", "ReservedNodesOfferingId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Duration](#API_DescribeReservedNodesOfferings_RequestSyntax) ** Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration. Type: String Required: No ** [MaxResults](#API_DescribeReservedNodesOfferings_RequestSyntax) ** The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Type: Integer Required: No ** [NextToken](#API_DescribeReservedNodesOfferings_RequestSyntax) ** An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String Required: No ** [NodeType](#API_DescribeReservedNodesOfferings_RequestSyntax) ** The node type for the reserved nodes. For more information, see [Supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported). Type: String Required: No ** [OfferingType](#API_DescribeReservedNodesOfferings_RequestSyntax) ** The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"\$1"Partial Upfront"\$1 "No Upfront" Type: String Required: No ** [ReservedNodesOfferingId](#API_DescribeReservedNodesOfferings_RequestSyntax) ** The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. Type: String Required: No ## Response Syntax ``` { "NextToken": "string", "ReservedNodesOfferings": [ { "Duration": number, "FixedPrice": number, "NodeType": "string", "OfferingType": "string", "RecurringCharges": [ { "RecurringChargeAmount": number, "RecurringChargeFrequency": "string" } ], "ReservedNodesOfferingId": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeReservedNodesOfferings_ResponseSyntax) ** An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. Type: String ** [ReservedNodesOfferings](#API_DescribeReservedNodesOfferings_ResponseSyntax) ** Lists available reserved node offerings. Type: Array of [ReservedNodesOffering](API_ReservedNodesOffering.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ReservedNodesOfferingNotFoundFault ** The requested node offering does not exist. HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeReservedNodesOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeReservedNodesOfferings) # DescribeServiceUpdates Returns details of the service updates. ## Request Syntax ``` { "ClusterNames": [ "string" ], "MaxResults": number, "NextToken": "string", "ServiceUpdateName": "string", "Status": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterNames](#API_DescribeServiceUpdates_RequestSyntax) ** The list of cluster names to identify service updates to apply. Type: Array of strings Array Members: Maximum number of 20 items. Required: No ** [MaxResults](#API_DescribeServiceUpdates_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeServiceUpdates_RequestSyntax) ** 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. Type: String Required: No ** [ServiceUpdateName](#API_DescribeServiceUpdates_RequestSyntax) ** The unique ID of the service update to describe. Type: String Required: No ** [Status](#API_DescribeServiceUpdates_RequestSyntax) ** The status(es) of the service updates to filter on. Type: Array of strings Array Members: Maximum number of 4 items. Valid Values: `available | in-progress | complete | scheduled` Required: No ## Response Syntax ``` { "NextToken": "string", "ServiceUpdates": [ { "AutoUpdateStartDate": number, "ClusterName": "string", "Description": "string", "Engine": "string", "NodesUpdated": "string", "ReleaseDate": number, "ServiceUpdateName": "string", "Status": "string", "Type": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeServiceUpdates_ResponseSyntax) ** 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. Type: String ** [ServiceUpdates](#API_DescribeServiceUpdates_ResponseSyntax) ** A list of service updates Type: Array of [ServiceUpdate](API_ServiceUpdate.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeServiceUpdates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeServiceUpdates) # DescribeSnapshots 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. ## Request Syntax ``` { "ClusterName": "string", "MaxResults": number, "NextToken": "string", "ShowDetail": boolean, "SnapshotName": "string", "Source": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_DescribeSnapshots_RequestSyntax) ** A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described. Type: String Required: No ** [MaxResults](#API_DescribeSnapshots_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeSnapshots_RequestSyntax) ** 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. Type: String Required: No ** [ShowDetail](#API_DescribeSnapshots_RequestSyntax) ** A Boolean value which if true, the shard configuration is included in the snapshot description. Type: Boolean Required: No ** [SnapshotName](#API_DescribeSnapshots_RequestSyntax) ** A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described. Type: String Required: No ** [Source](#API_DescribeSnapshots_RequestSyntax) ** 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. Type: String Required: No ## Response Syntax ``` { "NextToken": "string", "Snapshots": [ { "ARN": "string", "ClusterConfiguration": { "Description": "string", "Engine": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "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" }, "DataTiering": "string", "KmsKeyId": "string", "Name": "string", "Source": "string", "Status": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeSnapshots_ResponseSyntax) ** 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. Type: String ** [Snapshots](#API_DescribeSnapshots_ResponseSyntax) ** A list of snapshots. Each item in the list contains detailed information about one snapshot. Type: Array of [Snapshot](API_Snapshot.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeSnapshots) # DescribeSubnetGroups Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "SubnetGroupName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeSubnetGroups_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeSubnetGroups_RequestSyntax) ** 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. Type: String Required: No ** [SubnetGroupName](#API_DescribeSubnetGroups_RequestSyntax) ** The name of the subnet group to return details for. Type: String Required: No ## Response Syntax ``` { "NextToken": "string", "SubnetGroups": [ { "ARN": "string", "Description": "string", "Name": "string", "Subnets": [ { "AvailabilityZone": { "Name": "string" }, "Identifier": "string", "SupportedNetworkTypes": [ "string" ] } ], "SupportedNetworkTypes": [ "string" ], "VpcId": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeSubnetGroups_ResponseSyntax) ** 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. Type: String ** [SubnetGroups](#API_DescribeSubnetGroups_ResponseSyntax) ** A list of subnet groups. Each element in the list contains detailed information about one group. Type: Array of [SubnetGroup](API_SubnetGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeSubnetGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeSubnetGroups) # DescribeUsers Returns a list of users. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "UserName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_DescribeUsers_RequestSyntax) ** Filter to determine the list of users to return. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_DescribeUsers_RequestSyntax) ** 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. Type: Integer Required: No ** [NextToken](#API_DescribeUsers_RequestSyntax) ** 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. Type: String Required: No ** [UserName](#API_DescribeUsers_RequestSyntax) ** The name of the user. Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: No ## Response Syntax ``` { "NextToken": "string", "Users": [ { "AccessString": "string", "ACLNames": [ "string" ], "ARN": "string", "Authentication": { "PasswordCount": number, "Type": "string" }, "MinimumEngineVersion": "string", "Name": "string", "Status": "string" } ] } ``` ## 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. ** [NextToken](#API_DescribeUsers_ResponseSyntax) ** 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. Type: String ** [Users](#API_DescribeUsers_ResponseSyntax) ** A list of users. Type: Array of [User](API_User.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/DescribeUsers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/DescribeUsers) # FailoverShard Used to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large scale operational events, Amazon may block this API. ## Request Syntax ``` { "ClusterName": "string", "ShardName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_FailoverShard_RequestSyntax) ** The cluster being failed over. Type: String Required: Yes ** [ShardName](#API_FailoverShard_RequestSyntax) ** The name of the shard. Type: String Required: Yes ## Response Syntax ``` { "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } } ``` ## 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. ** [Cluster](#API_FailoverShard_ResponseSyntax) ** The cluster being failed over. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** APICallRateForCustomerExceededFault ** HTTP Status Code: 400 ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidKMSKeyFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ShardNotFoundFault ** HTTP Status Code: 400 ** TestFailoverNotAvailableFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/FailoverShard) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/FailoverShard) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/FailoverShard) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/FailoverShard) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/FailoverShard) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/FailoverShard) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/FailoverShard) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/FailoverShard) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/FailoverShard) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/FailoverShard) # ListAllowedMultiRegionClusterUpdates Lists the allowed updates for a multi-Region cluster. ## Request Syntax ``` { "MultiRegionClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MultiRegionClusterName](#API_ListAllowedMultiRegionClusterUpdates_RequestSyntax) ** The name of the multi-Region cluster. Type: String Required: Yes ## Response Syntax ``` { "ScaleDownNodeTypes": [ "string" ], "ScaleUpNodeTypes": [ "string" ] } ``` ## 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. ** [ScaleDownNodeTypes](#API_ListAllowedMultiRegionClusterUpdates_ResponseSyntax) ** The node types that the cluster can be scaled down to. Type: Array of strings ** [ScaleUpNodeTypes](#API_ListAllowedMultiRegionClusterUpdates_ResponseSyntax) ** The node types that the cluster can be scaled up to. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/ListAllowedMultiRegionClusterUpdates) # ListAllowedNodeTypeUpdates 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. ## Request Syntax ``` { "ClusterName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ClusterName](#API_ListAllowedNodeTypeUpdates_RequestSyntax) ** 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. Type: String Required: Yes ## Response Syntax ``` { "ScaleDownNodeTypes": [ "string" ], "ScaleUpNodeTypes": [ "string" ] } ``` ## 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. ** [ScaleDownNodeTypes](#API_ListAllowedNodeTypeUpdates_ResponseSyntax) ** A list node types which you can use to scale down your cluster. Type: Array of strings ** [ScaleUpNodeTypes](#API_ListAllowedNodeTypeUpdates_ResponseSyntax) ** A list node types which you can use to scale up your cluster. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/ListAllowedNodeTypeUpdates) # ListTags 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). When you add or remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). ## Request Syntax ``` { "ResourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_ListTags_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource for which you want the list of tags. Type: String Required: Yes ## Response Syntax ``` { "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## 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. ** [TagList](#API_ListTags_ResponseSyntax) ** A list of tags as key-value pairs. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidARNFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ** MultiRegionParameterGroupNotFoundFault ** The specified multi-Region parameter group does not exist. HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/ListTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/ListTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/ListTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/ListTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/ListTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/ListTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/ListTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/ListTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/ListTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/ListTags) # PurchaseReservedNodesOffering Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable. ## Request Syntax ``` { "NodeCount": number, "ReservationId": "string", "ReservedNodesOfferingId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [NodeCount](#API_PurchaseReservedNodesOffering_RequestSyntax) ** The number of node instances to reserve. Type: Integer Required: No ** [ReservationId](#API_PurchaseReservedNodesOffering_RequestSyntax) ** A customer-specified identifier to track this reservation. Type: String Required: No ** [ReservedNodesOfferingId](#API_PurchaseReservedNodesOffering_RequestSyntax) ** The ID of the reserved node offering to purchase. Type: String Required: Yes ** [Tags](#API_PurchaseReservedNodesOffering_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: No ## Response Syntax ``` { "ReservedNode": { "ARN": "string", "Duration": number, "FixedPrice": number, "NodeCount": number, "NodeType": "string", "OfferingType": "string", "RecurringCharges": [ { "RecurringChargeAmount": number, "RecurringChargeFrequency": "string" } ], "ReservationId": "string", "ReservedNodesOfferingId": "string", "StartTime": number, "State": "string" } } ``` ## 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. ** [ReservedNode](#API_PurchaseReservedNodesOffering_ResponseSyntax) ** Represents the output of a `PurchaseReservedNodesOffering` operation. Type: [ReservedNode](API_ReservedNode.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ReservedNodeAlreadyExistsFault ** You already have a reservation with the given identifier. HTTP Status Code: 400 ** ReservedNodeQuotaExceededFault ** The request cannot be processed because it would exceed the user's node quota. HTTP Status Code: 400 ** ReservedNodesOfferingNotFoundFault ** The requested node offering does not exist. HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/PurchaseReservedNodesOffering) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/PurchaseReservedNodesOffering) # ResetParameterGroup 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. ## Request Syntax ``` { "AllParameters": boolean, "ParameterGroupName": "string", "ParameterNames": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AllParameters](#API_ResetParameterGroup_RequestSyntax) ** 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. Type: Boolean Required: No ** [ParameterGroupName](#API_ResetParameterGroup_RequestSyntax) ** The name of the parameter group to reset. Type: String Required: Yes ** [ParameterNames](#API_ResetParameterGroup_RequestSyntax) ** 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. Type: Array of strings Required: No ## Response Syntax ``` { "ParameterGroup": { "ARN": "string", "Description": "string", "Family": "string", "Name": "string" } } ``` ## 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. ** [ParameterGroup](#API_ResetParameterGroup_ResponseSyntax) ** The parameter group being reset. Type: [ParameterGroup](API_ParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterGroupStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/ResetParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/ResetParameterGroup) # TagResource Use this operation to add tags to a resource. 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. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). When you add tags to multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). You can specify cost-allocation tags for 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging.html). ## Request Syntax ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to which the tags are to be added. Type: String Required: Yes ** [Tags](#API_TagResource_RequestSyntax) ** 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](API_Tag.md) objects Array Members: Maximum number of 200 items. Required: Yes ## Response Syntax ``` { "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## 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. ** [TagList](#API_TagResource_ResponseSyntax) ** A list of tags as key-value pairs. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidARNFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ** MultiRegionParameterGroupNotFoundFault ** The specified multi-Region parameter group does not exist. HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ** TagQuotaPerResourceExceeded ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/TagResource) # UntagResource Use this operation to remove tags on a resource. 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. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). When you remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see [Tagging your MemoryDB resources](https://docs.aws.amazon.com/MemoryDB/latest/devguide/Tagging-Resources.html). You can specify cost-allocation tags for 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](https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging.html). ## Request Syntax ``` { "ResourceArn": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ResourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to which the tags are to be removed. Type: String Required: Yes ** [TagKeys](#API_UntagResource_RequestSyntax) ** The list of keys of the tags that are to be removed. Type: Array of strings Required: Yes ## Response Syntax ``` { "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## 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. ** [TagList](#API_UntagResource_ResponseSyntax) ** The list of tags removed. Type: Array of [Tag](API_Tag.md) objects Array Members: Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** ClusterNotFoundFault ** HTTP Status Code: 400 ** InvalidARNFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ** MultiRegionParameterGroupNotFoundFault ** The specified multi-Region parameter group does not exist. HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SnapshotNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ** TagNotFoundFault ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UntagResource) # UpdateACL Changes the list of users that belong to the Access Control List. ## Request Syntax ``` { "ACLName": "string", "UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_UpdateACL_RequestSyntax) ** The name of the Access Control List. Type: String Required: Yes ** [UserNamesToAdd](#API_UpdateACL_RequestSyntax) ** The list of users to add 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 ** [UserNamesToRemove](#API_UpdateACL_RequestSyntax) ** The list of users to remove from 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 ## Response Syntax ``` { "ACL": { "ARN": "string", "Clusters": [ "string" ], "MinimumEngineVersion": "string", "Name": "string", "PendingChanges": { "UserNamesToAdd": [ "string" ], "UserNamesToRemove": [ "string" ] }, "Status": "string", "UserNames": [ "string" ] } } ``` ## 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. ** [ACL](#API_UpdateACL_ResponseSyntax) ** The updated Access Control List. Type: [ACL](API_ACL.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** DefaultUserRequired ** HTTP Status Code: 400 ** DuplicateUserNameFault ** HTTP Status Code: 400 ** InvalidACLStateFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateACL) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateACL) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateACL) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateACL) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateACL) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateACL) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateACL) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateACL) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateACL) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateACL) # UpdateCluster 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. ## Request Syntax ``` { "ACLName": "string", "ClusterName": "string", "Description": "string", "Engine": "string", "EngineVersion": "string", "IpDiscovery": "string", "MaintenanceWindow": "string", "NodeType": "string", "ParameterGroupName": "string", "ReplicaConfiguration": { "ReplicaCount": number }, "SecurityGroupIds": [ "string" ], "ShardConfiguration": { "ShardCount": number }, "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ACLName](#API_UpdateCluster_RequestSyntax) ** The Access Control List that is associated with the cluster. Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: No ** [ClusterName](#API_UpdateCluster_RequestSyntax) ** The name of the cluster to update. Type: String Required: Yes ** [Description](#API_UpdateCluster_RequestSyntax) ** The description of the cluster to update. Type: String Required: No ** [Engine](#API_UpdateCluster_RequestSyntax) ** The name of the engine to be used for the cluster. Type: String Required: No ** [EngineVersion](#API_UpdateCluster_RequestSyntax) ** 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. Type: String Required: No ** [IpDiscovery](#API_UpdateCluster_RequestSyntax) ** The mechanism for discovering IP addresses for the cluster discovery protocol. Valid values are 'ipv4' or 'ipv6'. When set to 'ipv4', cluster discovery functions such as cluster slots, cluster shards, and cluster nodes will return IPv4 addresses for cluster nodes. When set to 'ipv6', the cluster discovery functions return IPv6 addresses for cluster nodes. The value must be compatible with the NetworkType parameter. If not specified, the default is 'ipv4'. Type: String Valid Values: `ipv4 | ipv6` Required: No ** [MaintenanceWindow](#API_UpdateCluster_RequestSyntax) ** Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for `ddd` are: + `sun` + `mon` + `tue` + `wed` + `thu` + `fri` + `sat` Example: `sun:23:00-mon:01:30` Type: String Required: No ** [NodeType](#API_UpdateCluster_RequestSyntax) ** A valid node type that you want to scale this cluster up or down to. Type: String Required: No ** [ParameterGroupName](#API_UpdateCluster_RequestSyntax) ** The name of the parameter group to update. Type: String Required: No ** [ReplicaConfiguration](#API_UpdateCluster_RequestSyntax) ** The number of replicas that will reside in each shard. Type: [ReplicaConfigurationRequest](API_ReplicaConfigurationRequest.md) object Required: No ** [SecurityGroupIds](#API_UpdateCluster_RequestSyntax) ** The SecurityGroupIds to update. Type: Array of strings Required: No ** [ShardConfiguration](#API_UpdateCluster_RequestSyntax) ** The number of shards in the cluster. Type: [ShardConfigurationRequest](API_ShardConfigurationRequest.md) object Required: No ** [SnapshotRetentionLimit](#API_UpdateCluster_RequestSyntax) ** 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. Type: Integer Required: No ** [SnapshotWindow](#API_UpdateCluster_RequestSyntax) ** The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster. Type: String Required: No ** [SnsTopicArn](#API_UpdateCluster_RequestSyntax) ** The SNS topic ARN to update. Type: String Required: No ** [SnsTopicStatus](#API_UpdateCluster_RequestSyntax) ** The status of the Amazon SNS notification topic. Notifications are sent only if the status is active. Type: String Required: No ## Response Syntax ``` { "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "string", "NodeType": "string", "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": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } } ``` ## 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. ** [Cluster](#API_UpdateCluster_ResponseSyntax) ** The updated cluster. Type: [Cluster](API_Cluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ACLNotFoundFault ** HTTP Status Code: 400 ** ClusterNotFoundFault ** HTTP Status Code: 400 ** ClusterQuotaForCustomerExceededFault ** HTTP Status Code: 400 ** InvalidACLStateFault ** HTTP Status Code: 400 ** InvalidClusterStateFault ** HTTP Status Code: 400 ** InvalidKMSKeyFault ** HTTP Status Code: 400 ** InvalidNodeStateFault ** HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** HTTP Status Code: 400 ** NodeQuotaForClusterExceededFault ** HTTP Status Code: 400 ** NodeQuotaForCustomerExceededFault ** HTTP Status Code: 400 ** NoOperationFault ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** ShardsPerClusterQuotaExceededFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateCluster) # UpdateMultiRegionCluster Updates the configuration of an existing multi-Region cluster. ## Request Syntax ``` { "Description": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "ShardConfiguration": { "ShardCount": number }, "UpdateStrategy": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateMultiRegionCluster_RequestSyntax) ** A new description for the multi-Region cluster. Type: String Required: No ** [EngineVersion](#API_UpdateMultiRegionCluster_RequestSyntax) ** The new engine version to be used for the multi-Region cluster. Type: String Required: No ** [MultiRegionClusterName](#API_UpdateMultiRegionCluster_RequestSyntax) ** The name of the multi-Region cluster to be updated. Type: String Required: Yes ** [MultiRegionParameterGroupName](#API_UpdateMultiRegionCluster_RequestSyntax) ** The new multi-Region parameter group to be associated with the cluster. Type: String Required: No ** [NodeType](#API_UpdateMultiRegionCluster_RequestSyntax) ** The new node type to be used for the multi-Region cluster. Type: String Required: No ** [ShardConfiguration](#API_UpdateMultiRegionCluster_RequestSyntax) ** A request to configure the sharding properties of a cluster Type: [ShardConfigurationRequest](API_ShardConfigurationRequest.md) object Required: No ** [UpdateStrategy](#API_UpdateMultiRegionCluster_RequestSyntax) ** The strategy to use for the update operation. Supported values are "coordinated" or "uncoordinated". Type: String Valid Values: `coordinated | uncoordinated` Required: No ## Response Syntax ``` { "MultiRegionCluster": { "ARN": "string", "Clusters": [ { "ARN": "string", "ClusterName": "string", "Region": "string", "Status": "string" } ], "Description": "string", "Engine": "string", "EngineVersion": "string", "MultiRegionClusterName": "string", "MultiRegionParameterGroupName": "string", "NodeType": "string", "NumberOfShards": number, "Status": "string", "TLSEnabled": boolean } } ``` ## 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. ** [MultiRegionCluster](#API_UpdateMultiRegionCluster_ResponseSyntax) ** The status of updating the multi-Region cluster. Type: [MultiRegionCluster](API_MultiRegionCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidMultiRegionClusterStateFault ** The requested operation cannot be performed on the multi-Region cluster in its current state. HTTP Status Code: 400 ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** MultiRegionClusterNotFoundFault ** The specified multi-Region cluster does not exist. HTTP Status Code: 400 ** MultiRegionParameterGroupNotFoundFault ** The specified multi-Region parameter group does not exist. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateMultiRegionCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateMultiRegionCluster) # UpdateParameterGroup 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. ## Request Syntax ``` { "ParameterGroupName": "string", "ParameterNameValues": [ { "ParameterName": "string", "ParameterValue": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ParameterGroupName](#API_UpdateParameterGroup_RequestSyntax) ** The name of the parameter group to update. Type: String Required: Yes ** [ParameterNameValues](#API_UpdateParameterGroup_RequestSyntax) ** 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. Type: Array of [ParameterNameValue](API_ParameterNameValue.md) objects Required: Yes ## Response Syntax ``` { "ParameterGroup": { "ARN": "string", "Description": "string", "Family": "string", "Name": "string" } } ``` ## 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. ** [ParameterGroup](#API_UpdateParameterGroup_ResponseSyntax) ** The updated parameter group Type: [ParameterGroup](API_ParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterGroupStateFault ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** ParameterGroupNotFoundFault ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateParameterGroup) # UpdateSubnetGroup Updates a subnet group. For more information, see [Updating a subnet group](https://docs.aws.amazon.com/MemoryDB/latest/devguide/ubnetGroups.Modifying.html) ## Request Syntax ``` { "Description": "string", "SubnetGroupName": "string", "SubnetIds": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateSubnetGroup_RequestSyntax) ** A description of the subnet group Type: String Required: No ** [SubnetGroupName](#API_UpdateSubnetGroup_RequestSyntax) ** The name of the subnet group Type: String Required: Yes ** [SubnetIds](#API_UpdateSubnetGroup_RequestSyntax) ** The EC2 subnet IDs for the subnet group. Type: Array of strings Required: No ## Response Syntax ``` { "SubnetGroup": { "ARN": "string", "Description": "string", "Name": "string", "Subnets": [ { "AvailabilityZone": { "Name": "string" }, "Identifier": "string", "SupportedNetworkTypes": [ "string" ] } ], "SupportedNetworkTypes": [ "string" ], "VpcId": "string" } } ``` ## 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. ** [SubnetGroup](#API_UpdateSubnetGroup_ResponseSyntax) ** The updated subnet group Type: [SubnetGroup](API_SubnetGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidSubnet ** HTTP Status Code: 400 ** ServiceLinkedRoleNotFoundFault ** HTTP Status Code: 400 ** SubnetGroupNotFoundFault ** HTTP Status Code: 400 ** SubnetInUse ** HTTP Status Code: 400 ** SubnetNotAllowedFault ** HTTP Status Code: 400 ** SubnetQuotaExceededFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateSubnetGroup) # UpdateUser Changes user password(s) and/or access string. ## Request Syntax ``` { "AccessString": "string", "AuthenticationMode": { "Passwords": [ "string" ], "Type": "string" }, "UserName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AccessString](#API_UpdateUser_RequestSyntax) ** Access permissions string used for this user. Type: String Pattern: `.*\S.*` Required: No ** [AuthenticationMode](#API_UpdateUser_RequestSyntax) ** Denotes the user's authentication properties, such as whether it requires a password to authenticate. Type: [AuthenticationMode](API_AuthenticationMode.md) object Required: No ** [UserName](#API_UpdateUser_RequestSyntax) ** The name of the user Type: String Length Constraints: Minimum length of 1. Pattern: `[a-zA-Z][a-zA-Z0-9\-]*` Required: Yes ## Response Syntax ``` { "User": { "AccessString": "string", "ACLNames": [ "string" ], "ARN": "string", "Authentication": { "PasswordCount": number, "Type": "string" }, "MinimumEngineVersion": "string", "Name": "string", "Status": "string" } } ``` ## 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. ** [User](#API_UpdateUser_ResponseSyntax) ** The updated user Type: [User](API_User.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterCombinationException ** HTTP Status Code: 400 ** InvalidParameterValueException ** HTTP Status Code: 400 ** InvalidUserStateFault ** HTTP Status Code: 400 ** UserNotFoundFault ** HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/memorydb-2021-01-01/UpdateUser) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/memorydb-2021-01-01/UpdateUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/memorydb-2021-01-01/UpdateUser) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/memorydb-2021-01-01/UpdateUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/memorydb-2021-01-01/UpdateUser) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/memorydb-2021-01-01/UpdateUser) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/memorydb-2021-01-01/UpdateUser) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/memorydb-2021-01-01/UpdateUser) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/memorydb-2021-01-01/UpdateUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/memorydb-2021-01-01/UpdateUser)