ECR / Client / describe_replication_backfill_results

describe_replication_backfill_results

ECR.Client.describe_replication_backfill_results(**kwargs)

Returns the status, progress, and per-image results for a replication backfill. The backfill to describe is identified by the replicationBackfillId returned by the StartReplicationBackfill operation.

Note

The per-image results are available only after the replication backfill reaches a terminal status.

See also: AWS API Documentation

Request Syntax

response = client.describe_replication_backfill_results(
    registryId='string',
    replicationBackfillId='string',
    resultStatusFilter='COMPLETE'|'FAILED',
    maxResults=123,
    nextToken='string'
)
Parameters:

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

  • replicationBackfillId (string) –

    [REQUIRED]

    The ID of the replication backfill to describe.

  • resultStatusFilter (string) – The status used to filter the returned results. Each result has a status of COMPLETE or FAILED. If you omit this parameter, results with both statuses are returned.

  • maxResults (integer) – The maximum number of replication backfill results returned by DescribeReplicationBackfillResults in paginated output. When this parameter is used, DescribeReplicationBackfillResults 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 DescribeReplicationBackfillResults request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeReplicationBackfillResults returns up to 100 results and a nextToken value, if applicable.

  • nextToken (string) –

    The nextToken value returned from a previous paginated DescribeReplicationBackfillResults 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',
    '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',
        ]
    },
    'results': [
        {
            'repositoryName': 'string',
            'imageId': {
                'imageDigest': 'string',
                'imageTag': 'string'
            },
            'status': 'COMPLETE'|'FAILED',
            'failureCode': 'string',
            'subImageFailureCodes': [
                '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.

    • 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) –

    • results (list) –

      The per-image results for the replication backfill. Results are available only after the replication backfill reaches a terminal status.

      • (dict) –

        An object representing the result of a single replication during a replication backfill. Each image and tag combination is replicated as a single replication.

        • repositoryName (string) –

          The name of the repository that contains the image.

        • imageId (dict) –

          An object with identifying information for the image.

          • imageDigest (string) –

            The sha256 digest of the image manifest.

          • imageTag (string) –

            The tag used for the image.

        • status (string) –

          The replication status of the image.

        • failureCode (string) –

          The failure code for a replication that has failed.

        • subImageFailureCodes (list) –

          The distinct failure codes for the images referenced by a manifest list that failed to replicate. Each failure code appears at most once, regardless of how many referenced images failed with that code. This field is present only when the image is a manifest list.

          • (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 DescribeReplicationBackfillResults request. When the results of a DescribeReplicationBackfillResults 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