Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartReplicationBackfill

Starts a replication backfill for a registry. A replication backfill replicates a registry's existing images that match its replication configuration to the specified destination. Use the DescribeReplicationBackfillResults operation to monitor the progress of a replication backfill, and to retrieve its per-image results after it reaches a terminal status.

Note

The destination must already be configured in the registry's replication configuration.

Note

Only one replication backfill can be in progress for a given destination Region at a time. Starting a replication backfill for a destination Region that already has one in progress fails with a ReplicationBackfillInProgressException. In addition, a registry can have at most 10 replication backfills in progress at once. Starting a replication backfill that would exceed this limit fails with a LimitExceededException.

Request Syntax


{
   "destination": { 
      "region": "string",
      "registryId": "string"
   },
   "registryId": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

destination

The destination Region and registry to which the images are replicated.

Type: ReplicationDestination object

Required: Yes

registryId

The AWS account ID associated with the registry from which to start the replication backfill. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

Response Syntax


{
   "destination": { 
      "region": "string",
      "registryId": "string"
   },
   "registryId": "string",
   "replicationBackfillId": "string",
   "startedAt": number,
   "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.

destination

The destination Region and registry to which the images are replicated.

Type: ReplicationDestination object

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

replicationBackfillId

The ID of the replication backfill that was started. Use this value to describe or stop the backfill.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

startedAt

The date and time, in JavaScript date format, when the replication backfill was started.

Type: Timestamp

status

The current status of the replication backfill. A newly started replication backfill is returned with a status of PREPARING.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

message: The error message associated with the exception.

HTTP Status Code: 400

LimitExceededException

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

message: The error message associated with the exception.

HTTP Status Code: 400

ReplicationBackfillInProgressException

A replication backfill is already in progress for the specified destination Region. This occurs because only one replication backfill can be in progress for a given destination Region at a time. Wait for the in progress backfill to reach a terminal status, or stop it with the StopReplicationBackfill operation, before starting another one.

message: The error message associated with the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server-side issue.

message: The error message associated with the exception.

HTTP Status Code: 500

ValidationException

There was an exception validating this request.

HTTP Status Code: 400