2026/10/26 - Amazon Elastic Container Registry - 4 new api methods
Changes Add support for ECR replication backfill
Lists the replication backfills for a registry, including their status and progress.
See also: AWS API Documentation
Request Syntax
client.list_replication_backfills(
registryId='string',
maxResults=123,
nextToken='string'
)
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.
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.
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.
dict
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.
Starts a replication backfill for a registry. A replication backfill replicates a registry's existing images that match its replication configuration to the specified destination. Use the DescribeReplicationBackfillResults operation to monitor the progress of a replication backfill, and to retrieve its per-image results after it reaches a terminal status.
See also: AWS API Documentation
Request Syntax
client.start_replication_backfill(
registryId='string',
destination={
'region': 'string',
'registryId': 'string'
}
)
string
The Amazon Web Services account ID associated with the registry from which to start the replication backfill. If you do not specify a registry, the default registry is assumed.
dict
[REQUIRED]
The destination Region and registry to which the images are replicated.
region (string) -- [REQUIRED]
The Region to replicate to.
registryId (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'replicationBackfillId': 'string',
'registryId': 'string',
'destination': {
'region': 'string',
'registryId': 'string'
},
'status': 'PREPARING'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPING'|'STOPPED',
'startedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
replicationBackfillId (string) --
The ID of the replication backfill that was started. Use this value to describe or stop the backfill.
registryId (string) --
The registry ID associated with the request.
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. A newly started replication backfill is returned with a status of PREPARING.
startedAt (datetime) --
The date and time, in JavaScript date format, when the replication backfill was started.
Stops an in progress replication backfill for a registry. The backfill to stop is identified by the replicationBackfillId returned by the StartReplicationBackfill operation.
See also: AWS API Documentation
Request Syntax
client.stop_replication_backfill(
registryId='string',
replicationBackfillId='string'
)
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.
string
[REQUIRED]
The ID of the replication backfill to stop.
dict
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.
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.
See also: AWS API Documentation
Request Syntax
client.describe_replication_backfill_results(
registryId='string',
replicationBackfillId='string',
resultStatusFilter='COMPLETE'|'FAILED',
maxResults=123,
nextToken='string'
)
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.
string
[REQUIRED]
The ID of the replication backfill to describe.
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.
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.
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.
dict
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.