The following elements are returned by the service.
ProcessedUpdateActions.ProcessedUpdateAction.N Update actions that have been processed successfully Type: Array of ProcessedUpdateAction (p. 290) objects UnprocessedUpdateActions.UnprocessedUpdateAction.N
Update actions that haven't been processed successfully Type: Array of UnprocessedUpdateAction (p. 323) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 335).
See Also
InvalidParameterValue
The value for a parameter is invalid.
HTTP Status Code: 400 ServiceUpdateNotFoundFault
The service update doesn't exist HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
BatchStopUpdateAction
BatchStopUpdateAction
Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 333).
ServiceUpdateName
The unique ID of the service update Type: String
Required: Yes
CacheClusterIds.member.N The cache cluster IDs Type: Array of strings
Array Members: Maximum number of 20 items.
Required: No
ReplicationGroupIds.member.N The replication group IDs Type: Array of strings
Array Members: Maximum number of 20 items.
Required: No
Response Elements
The following elements are returned by the service.
ProcessedUpdateActions.ProcessedUpdateAction.N Update actions that have been processed successfully Type: Array of ProcessedUpdateAction (p. 290) objects UnprocessedUpdateActions.UnprocessedUpdateAction.N
Update actions that haven't been processed successfully Type: Array of UnprocessedUpdateAction (p. 323) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 335).
See Also
InvalidParameterValue
The value for a parameter is invalid.
HTTP Status Code: 400 ServiceUpdateNotFoundFault
The service update doesn't exist HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CompleteMigration
CompleteMigration
Complete the migration of data.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 333).
ReplicationGroupId
The ID of the replication group to which data is being migrated.
Type: String Required: Yes Force
Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
Type: Boolean Required: No
Response Elements
The following element is returned by the service.
ReplicationGroup
Contains all of the attributes of a specific Redis replication group.
Type: ReplicationGroup (p. 293) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 335).
InvalidReplicationGroupState
The requested replication group is not in the available state.
HTTP Status Code: 400 ReplicationGroupNotFoundFault
The specified replication group does not exist.
HTTP Status Code: 404
ReplicationGroupNotUnderMigrationFault
The designated replication group is not available for data migration.
HTTP Status Code: 400
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CopySnapshot
CopySnapshot
Makes a copy of an existing snapshot.
NoteThis operation is valid for Redis only.
Important
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
• Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
• Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 333).
Response Elements
SourceSnapshotName
The name of an existing snapshot from which to make a copy.
Type: String Required: Yes TargetSnapshotName
A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
Type: String Required: Yes KmsKeyId
The ID of the KMS key used to encrypt the target snapshot.
Type: String Required: No Tags.Tag.N
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
Type: Array of Tag (p. 321) objects Required: No
TargetBucket
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 Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
Type: String Required: No
Response Elements
The following element is returned by the service.
Snapshot
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Type: Snapshot (p. 313) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 335).
Examples
InvalidParameterCombination
Two or more incompatible parameters were specified.
HTTP Status Code: 400 InvalidParameterValue
The value for a parameter is invalid.
HTTP Status Code: 400 InvalidSnapshotState
The current state of the snapshot does not allow the requested operation to occur.
HTTP Status Code: 400 SnapshotAlreadyExistsFault
You already have a snapshot with the given name.
HTTP Status Code: 400 SnapshotNotFoundFault
The requested snapshot name does not refer to an existing snapshot.
HTTP Status Code: 404 SnapshotQuotaExceededFault
The request cannot be processed because it would exceed the maximum number of snapshots.
HTTP Status Code: 400 TagQuotaPerResourceExceeded
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
HTTP Status Code: 400