ECR / Client / start_replication_backfill

start_replication_backfill

ECR.Client.start_replication_backfill(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.start_replication_backfill(
    registryId='string',
    destination={
        'region': 'string',
        'registryId': 'string'
    }
)
Parameters:

  • registryId (string) – The Amazon Web Services 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.

  • destination (dict) –

    [REQUIRED]

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

    • region (string) – [REQUIRED]

      The Region to replicate to.

    • registryId (string) – [REQUIRED]

      The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

Return type:

dict

Returns:

Response Syntax

{
    'replicationBackfillId': 'string',
    'registryId': 'string',
    'destination': {
        'region': 'string',
        'registryId': 'string'
    },
    'status': 'PREPARING'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPING'|'STOPPED',
    'startedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • replicationBackfillId (string) –

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

    • registryId (string) –

      The registry ID associated with the request.

    • destination (dict) –

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

      • region (string) –

        The Region to replicate to.

      • registryId (string) –

        The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

    • status (string) –

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

    • startedAt (datetime) –

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

Exceptions