ECR / Client / list_replication_backfills

list_replication_backfills

ECR.Client.list_replication_backfills(**kwargs)

Lists the replication backfills for a registry, including their status and progress.

Note

Replication backfills that have reached a terminal status are retained for 90 days after they end, after which they are no longer returned.

See also: AWS API Documentation

Request Syntax

response = client.list_replication_backfills(
    registryId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID associated with the registry for which to list replication backfills. If you do not specify a registry, the default registry is assumed.

  • maxResults (integer) – The maximum number of replication backfill results returned by ListReplicationBackfills in paginated output. When this parameter is used, ListReplicationBackfills only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListReplicationBackfills request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then ListReplicationBackfills returns up to 25 results and a nextToken value, if applicable.

  • nextToken (string) –

    The nextToken value returned from a previous paginated ListReplicationBackfills request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    Note

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Return type:

dict

Returns:

Response Syntax

{
    'registryId': 'string',
    'backfills': [
        {
            'replicationBackfillId': 'string',
            'destination': {
                'region': 'string',
                'registryId': 'string'
            },
            'status': 'PREPARING'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPING'|'STOPPED',
            'failureCode': 'string',
            'progress': {
                'totalReplicationCount': 123,
                'completedReplicationCount': 123,
                'failedReplicationCount': 123,
                'failureCodes': [
                    'string',
                ]
            },
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • registryId (string) –

      The registry ID associated with the request.

    • backfills (list) –

      A list of the replication backfills for the registry.

      • (dict) –

        An object representing a summary of a replication backfill, including its status, destination, progress, and start and end times.

        • 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.

        • failureCode (string) –

          The failure code for a replication backfill that has failed.

        • progress (dict) –

          The progress of the replication backfill, including the total, completed, and failed replication counts. This value is null until the replication backfill finishes preparing the set of images to replicate. It is therefore null while the replication backfill is PREPARING, and remains null if the replication backfill is stopped before preparation completes.

          • totalReplicationCount (integer) –

            The total number of replications that the backfill will perform. Each image and tag combination is counted as a single replication.

          • completedReplicationCount (integer) –

            The number of replications that have completed successfully.

          • failedReplicationCount (integer) –

            The number of replications that have failed.

          • failureCodes (list) –

            The distinct failure codes for the replications that have failed. Each failure code appears at most once, regardless of how many replications failed with that code.

            • (string) –

        • startedAt (datetime) –

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

        • endedAt (datetime) –

          The date and time, in JavaScript date format, when the replication backfill ended. This value is null while the replication backfill is still in progress.

    • nextToken (string) –

      The nextToken value to include in a future ListReplicationBackfills request. When the results of a ListReplicationBackfills request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions