describe_image_replication_status

ECR.Client.describe_image_replication_status(**kwargs)

Returns the replication status for a specified image.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_replication_status(
    repositoryName='string',
    imageId={
        'imageDigest': 'string',
        'imageTag': 'string'
    },
    registryId='string'
)

Parameters

• repositoryName (string) --

  [REQUIRED]

  The name of the repository that the image is in.

• imageId (dict) --

  [REQUIRED]

  An object with identifying information for an image in an Amazon ECR repository.

  • imageDigest (string) --

    The sha256 digest of the image manifest.

  • imageTag (string) --

    The tag used for the image.

• registryId (string) -- The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.

Return type

dict

Returns

Response Syntax

{
    'repositoryName': 'string',
    'imageId': {
        'imageDigest': 'string',
        'imageTag': 'string'
    },
    'replicationStatuses': [
        {
            'region': 'string',
            'registryId': 'string',
            'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
            'failureCode': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • repositoryName (string) --

    The repository name associated with the request.

  • imageId (dict) --

    An object with identifying information for an image in an Amazon ECR repository.

    • imageDigest (string) --

      The sha256 digest of the image manifest.

    • imageTag (string) --

      The tag used for the image.

  • replicationStatuses (list) --

    The replication status details for the images in the specified repository.

    • (dict) --

      The status of the replication process for an image.

      • region (string) --

        The destination Region for the image replication.

      • registryId (string) --

        The Amazon Web Services account ID associated with the registry to which the image belongs.

      • status (string) --

        The image replication status.

      • failureCode (string) --

        The failure code for a replication that has failed.

Exceptions

• ECR.Client.exceptions.ServerException
• ECR.Client.exceptions.InvalidParameterException
• ECR.Client.exceptions.ImageNotFoundException
• ECR.Client.exceptions.RepositoryNotFoundException
• ECR.Client.exceptions.ValidationException