:doc:`ECR <../../ecr>` / Client / describe_image_replication_status

*********************************
describe_image_replication_status
*********************************



.. py:method:: ECR.Client.describe_image_replication_status(**kwargs)

  

  Returns the replication status for a specified image.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImageReplicationStatus>`_  


  **Request Syntax**
  ::

    response = client.describe_image_replication_status(
        repositoryName='string',
        imageId={
            'imageDigest': 'string',
            'imageTag': 'string'
        },
        registryId='string'
    )
    
  :type repositoryName: string
  :param repositoryName: **[REQUIRED]** 

    The name of the repository that the image is in.

    

  
  :type imageId: dict
  :param imageId: **[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.

      

    
  
  :type registryId: string
  :param registryId: 

    The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.

    

  
  
  :rtype: 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**
  
  *   :py:class:`ECR.Client.exceptions.ServerException`

  
  *   :py:class:`ECR.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`ECR.Client.exceptions.ImageNotFoundException`

  
  *   :py:class:`ECR.Client.exceptions.RepositoryNotFoundException`

  
  *   :py:class:`ECR.Client.exceptions.ValidationException`

  