CompleteMigration
Completes the migration of data.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Force
-
Specifies whether to skip the pre-cutover health check and the cluster-wide convergence check for a serverless cache migration. Each shard still runs the full cutover process and tries to cut over with consistent data. Use this option to abandon a migration or to end a migration that has reported an error. To abandon a migration, first move your application traffic back to your source, and then use this option. Do not use it to finish a healthy migration that is still syncing. The serverless cache can be left with incomplete or inconsistent data if it was not in sync with the source. There is no automated rollback. If you use this option before the data sync starts, the serverless cache has no data. This option is required when the migration is
ready-to-syncor when an automatic cutover is pending. For a replication group migration, this option stops the migration without ensuring that data is in sync.Type: Boolean
Required: No
- ReplicationGroupId
-
The ID of the replication group to which data is being migrated.
Type: String
Required: No
- ServerlessCacheName
-
The name of the serverless cache to which data is being migrated.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- ReplicationGroup
-
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
Type: ReplicationGroup object
- ServerlessCache
-
Provides the details of the serverless cache for which the migration completed.
Type: ServerlessCache object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidCacheClusterState
-
The requested cluster is not in the
availablestate.HTTP Status Code: 400
- InvalidParameterCombination
-
Two or more incompatible parameters were specified.
- message
-
Two or more parameters that must not be used together were used together.
HTTP Status Code: 400
- InvalidParameterValue
-
The value for a parameter is invalid.
- message
-
A parameter value is invalid.
HTTP Status Code: 400
- InvalidReplicationGroupState
-
The requested replication group is not in the
availablestate.HTTP Status Code: 400
- InvalidServerlessCacheStateFault
-
The serverless cache or the migration is not in a state that allows the operation.
HTTP Status Code: 400
- MigrationHealthFault
-
The migration is not healthy. Check the events for this serverless cache for more details. For
CompleteMigration, setForceto true to bypass this check.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
- ServerlessCacheNotFoundFault
-
The serverless cache was not found or does not exist.
HTTP Status Code: 404
- ServerlessCacheNotUnderMigrationFault
-
The serverless cache is not currently under migration.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: