View a markdown version of this page

StartMigration - Amazon ElastiCache

StartMigration

Starts the migration of data.

Request Parameters

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

AutoCutover

Specifies whether ElastiCache automatically attempts to complete the migration after data sync is established.

Type: Boolean

Required: No

ClearTargetCacheData

Specifies whether ElastiCache deletes existing data in the serverless cache before migration begins. After StopMigration, StartMigration requires this option to restart the data sync.

Type: Boolean

Required: No

CustomerNodeEndpointList.member.N

The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. For serverless cache migrations, ElastiCache uses the endpoint that you provided in PrepareMigration.

Type: Array of CustomerNodeEndpoint objects

Required: No

ReplicationGroupId

The ID of the replication group to which data should be 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 to which ElastiCache is migrating data.

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 available state.

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 available state.

HTTP Status Code: 400

InvalidServerlessCacheStateFault

The account for these credentials is not currently active.

HTTP Status Code: 400

MigrationHealthFault

The migration is not healthy. Check the events for this serverless cache for more details. For CompleteMigration, set Force to true to bypass this check.

HTTP Status Code: 400

ReplicationGroupAlreadyUnderMigrationFault

The targeted replication group is not available.

HTTP Status Code: 400

ReplicationGroupNotFoundFault

The specified replication group does not exist.

HTTP Status Code: 404

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: