Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListReplicationBackfills

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.

Request Syntax


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

Type: Integer

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

Required: No

nextToken

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.

Type: String

Required: No

registryId

The AWS account ID associated with the registry for which to list replication backfills. If you do not specify a registry, the default registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

Response Syntax


{
   "backfills": [ 
      { 
         "destination": { 
            "region": "string",
            "registryId": "string"
         },
         "endedAt": number,
         "failureCode": "string",
         "progress": { 
            "completedReplicationCount": number,
            "failedReplicationCount": number,
            "failureCodes": [ "string" ],
            "totalReplicationCount": number
         },
         "replicationBackfillId": "string",
         "startedAt": number,
         "status": "string"
      }
   ],
   "nextToken": "string",
   "registryId": "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.

backfills

A list of the replication backfills for the registry.

Type: Array of ReplicationBackfillSummary objects

nextToken

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.

Type: String

registryId

The registry ID associated with the request.

Type: String

Pattern: [0-9]{12}

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

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