ECR / Client / stop_replication_backfill

stop_replication_backfill

ECR.Client.stop_replication_backfill(**kwargs)

Stops an in progress replication backfill for a registry. The backfill to stop is identified by the replicationBackfillId returned by the StartReplicationBackfill operation.

Note

Images that have already been replicated are not affected, and replications that are already in progress continue to completion.

See also: AWS API Documentation

Request Syntax

response = client.stop_replication_backfill(
    registryId='string',
    replicationBackfillId='string'
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID associated with the registry that contains the replication backfill to stop. If you do not specify a registry, the default registry is assumed.

  • replicationBackfillId (string) –

    [REQUIRED]

    The ID of the replication backfill to stop.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • registryId (string) –

      The registry ID associated with the request.

    • replicationBackfillId (string) –

      The ID of the replication backfill.

    • 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. When you stop a replication backfill, its status is STOPPED if the backfill is stopped immediately, or STOPPING if there are replications still in progress that must complete before the backfill stops.

    • startedAt (datetime) –

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

Exceptions