ECR / Client / describe_image_signing_status

describe_image_signing_status¶

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 in the Amazon Elastic Container Registry User Guide.

Request Syntax

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

Parameters:

repositoryName (string) –
[REQUIRED]

The name of the repository that contains the image.
imageId (dict) –
[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.
registryId (string) – 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.

Return type:

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

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