Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeReplicationBackfillResults

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.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string",
   "registryId": "string",
   "replicationBackfillId": "string",
   "resultStatusFilter": "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.

maxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

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.

Type: String

Required: No

registryId

The AWS 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.

Type: String

Pattern: [0-9]{12}

Required: No

replicationBackfillId

The ID of the replication backfill to describe.

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}

Required: Yes

resultStatusFilter

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.

Type: String

Valid Values: COMPLETE | FAILED

Required: No

Response Syntax


{
   "destination": { 
      "region": "string",
      "registryId": "string"
   },
   "endedAt": number,
   "failureCode": "string",
   "nextToken": "string",
   "progress": { 
      "completedReplicationCount": number,
      "failedReplicationCount": number,
      "failureCodes": [ "string" ],
      "totalReplicationCount": number
   },
   "registryId": "string",
   "replicationBackfillId": "string",
   "results": [ 
      { 
         "failureCode": "string",
         "imageId": { 
            "imageDigest": "string",
            "imageTag": "string"
         },
         "repositoryName": "string",
         "status": "string",
         "subImageFailureCodes": [ "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

endedAt

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.

Type: Timestamp

failureCode

The failure code for a replication backfill that has failed.

Type: String

nextToken

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.

Type: String

progress

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.

Type: ReplicationBackfillProgress object

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

replicationBackfillId

The ID of the replication 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}

results

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

Type: Array of ReplicationBackfillResult objects

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.

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

ReplicationBackfillNotFoundException

The specified replication backfill could not be found. Check the specified replication backfill ID and ensure that you are operating on the correct registry.

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