signer / Client / describe_signing_job

describe_signing_job

signer.Client.describe_signing_job(**kwargs)

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_signing_job(
    jobId='string'
)

Parameters:

jobId (string) –

[REQUIRED]

The ID of the signing job on input.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'source': {
        's3': {
            'bucketName': 'string',
            'key': 'string',
            'version': 'string'
        }
    },
    'signingMaterial': {
        'certificateArn': 'string'
    },
    'platformId': 'string',
    'platformDisplayName': 'string',
    'profileName': 'string',
    'profileVersion': 'string',
    'overrides': {
        'signingConfiguration': {
            'encryptionAlgorithm': 'RSA'|'ECDSA',
            'hashAlgorithm': 'SHA1'|'SHA256'
        },
        'signingImageFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
    },
    'signingParameters': {
        'string': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1),
    'signatureExpiresAt': datetime(2015, 1, 1),
    'requestedBy': 'string',
    'status': 'InProgress'|'Failed'|'Succeeded',
    'statusReason': 'string',
    'revocationRecord': {
        'reason': 'string',
        'revokedAt': datetime(2015, 1, 1),
        'revokedBy': 'string'
    },
    'signedObject': {
        's3': {
            'bucketName': 'string',
            'key': 'string'
        }
    },
    'jobOwner': 'string',
    'jobInvoker': 'string'
}

Response Structure

• (dict) –

  • jobId (string) –

    The ID of the signing job on output.

  • source (dict) –

    The object that contains the name of your S3 bucket or your raw code.

    • s3 (dict) –

      The S3Source object.

      • bucketName (string) –

        Name of the S3 bucket.

      • key (string) –

        Key name of the bucket object that contains your unsigned code.

      • version (string) –

        Version of your source image in your version enabled S3 bucket.

  • signingMaterial (dict) –

    The Amazon Resource Name (ARN) of your code signing certificate.

    • certificateArn (string) –

      The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

  • platformId (string) –

    The microcontroller platform to which your signed code image will be distributed.

  • platformDisplayName (string) –

    A human-readable name for the signing platform associated with the signing job.

  • profileName (string) –

    The name of the profile that initiated the signing operation.

  • profileVersion (string) –

    The version of the signing profile used to initiate the signing job.

  • overrides (dict) –

    A list of any overrides that were applied to the signing operation.

    • signingConfiguration (dict) –

      A signing configuration that overrides the default encryption or hash algorithm of a signing job.

      • encryptionAlgorithm (string) –

        A specified override of the default encryption algorithm that is used in a code signing job.

      • hashAlgorithm (string) –

        A specified override of the default hash algorithm that is used in a code signing job.

    • signingImageFormat (string) –

      A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached. (A third format value, JSON, is reserved for future use.) With JSONEmbedded, the signing image has the payload embedded in it. With JSONDetached, the payload is not be embedded in the signing image.

  • signingParameters (dict) –

    Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

    • (string) –

      • (string) –

  • createdAt (datetime) –

    Date and time that the signing job was created.

  • completedAt (datetime) –

    Date and time that the signing job was completed.

  • signatureExpiresAt (datetime) –

    Thr expiration timestamp for the signature generated by the signing job.

  • requestedBy (string) –

    The IAM principal that requested the signing job.

  • status (string) –

    Status of the signing job.

  • statusReason (string) –

    String value that contains the status reason.

  • revocationRecord (dict) –

    A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.

    • reason (string) –

      A caller-supplied reason for revocation.

    • revokedAt (datetime) –

      The time of revocation.

    • revokedBy (string) –

      The identity of the revoker.

  • signedObject (dict) –

    Name of the S3 bucket where the signed code image is saved by code signing.

    • s3 (dict) –

      The S3SignedObject.

      • bucketName (string) –

        Name of the S3 bucket.

      • key (string) –

        Key name that uniquely identifies a signed code image in your bucket.

  • jobOwner (string) –

    The AWS account ID of the job owner.

  • jobInvoker (string) –

    The IAM entity that initiated the signing job.

Exceptions

• signer.Client.exceptions.ResourceNotFoundException

• signer.Client.exceptions.AccessDeniedException

• signer.Client.exceptions.TooManyRequestsException

• signer.Client.exceptions.InternalServiceErrorException