describe-replication-backfill-results¶

Description¶

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.

Synopsis¶

  describe-replication-backfill-results
[--registry-id <value>]
--replication-backfill-id <value>
[--result-status-filter <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--registry-id (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.

Constraints:

pattern: [0-9]{12}

--replication-backfill-id (string) [required]

The ID of the replication backfill to describe.

Constraints:

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}

--result-status-filter (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.

Possible values:

COMPLETE

FAILED

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 1000

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

registryId -> (string)

The registry ID associated with the request.

Constraints:

pattern: [0-9]{12}

replicationBackfillId -> (string)

The ID of the replication backfill.

Constraints:

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}

destination -> (structure)

The destination Region and registry to which the images are replicated.

region -> (string) [required]

The Region to replicate to.

Constraints:

min: 2

max: 25

pattern: [0-9a-z-]{2,25}

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.

Constraints:

pattern: [0-9]{12}

status -> (string)

The current status of the replication backfill.

Possible values:

PREPARING

IN_PROGRESS

COMPLETE

FAILED

STOPPING

STOPPED

failureCode -> (string)

The failure code for a replication backfill that has failed.

progress -> (structure)

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) [required]

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

Constraints:

min: 0

completedReplicationCount -> (integer) [required]

The number of replications that have completed successfully.

Constraints:

min: 0

failedReplicationCount -> (integer) [required]

The number of replications that have failed.

Constraints:

min: 0

failureCodes -> (list) [required]

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.

(structure)

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) [required]

The name of the repository that contains the image.

Constraints:

min: 2

max: 256

pattern: [a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*

imageId -> (structure) [required]

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.

Constraints:

min: 1

max: 300

status -> (string) [required]

The replication status of the image.

Possible values:

COMPLETE

FAILED

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 -> (timestamp)

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

endedAt -> (timestamp)

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.

Table of Contents

Feedback

User Guide