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

*****************************
describe_image_signing_status
*****************************



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

  

  Returns the signing status for a specified image. If the image matched signing rules that reference different signing profiles, a status is returned for each profile.

   

  For more information, see `Managed signing <https://docs.aws.amazon.com/AmazonECR/latest/userguide/managed-signing.html>`__ in the *Amazon Elastic Container Registry User Guide*.

  

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


  **Request Syntax**
  ::

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

    The name of the repository that contains the image.

    

  
  :type imageId: dict
  :param imageId: **[REQUIRED]** 

    An object containing identifying information for an image.

    

  
    - **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 that contains the repository. If you do not specify a registry, the default registry is assumed.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'repositoryName': 'string',
          'imageId': {
              'imageDigest': 'string',
              'imageTag': 'string'
          },
          'registryId': 'string',
          'signingStatuses': [
              {
                  'signingProfileArn': 'string',
                  'failureCode': 'string',
                  'failureReason': 'string',
                  'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **repositoryName** *(string) --* 

        The name of the repository.

        
      

      - **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.

          
    
      

      - **registryId** *(string) --* 

        The Amazon Web Services account ID associated with the registry.

        
      

      - **signingStatuses** *(list) --* 

        A list of signing statuses for the specified image. Each status corresponds to a signing profile.

        
        

        - *(dict) --* 

          The signing status for an image. Each status corresponds to a signing profile.

          
          

          - **signingProfileArn** *(string) --* 

            The ARN of the Amazon Web Services Signer signing profile used to sign the image.

            
          

          - **failureCode** *(string) --* 

            The failure code, which is only present if ``status`` is ``FAILED``.

            
          

          - **failureReason** *(string) --* 

            A description of why signing the image failed. This field is only present if ``status`` is ``FAILED``.

            
          

          - **status** *(string) --* 

            The image's signing status. Possible values are:

             

            
            * ``IN_PROGRESS`` - Signing is currently in progress.
             
            * ``COMPLETE`` - The signature was successfully generated.
             
            * ``FAILED`` - Signing failed. See ``failureCode`` and ``failureReason`` for details.
            

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ECR.Client.exceptions.ServerException`

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

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

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

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

  