DescribeSigningJob - AWS Signer


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

Request Syntax

GET /signing-jobs/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The ID of the signing job on input.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "completedAt": number, "createdAt": number, "jobId": "string", "jobInvoker": "string", "jobOwner": "string", "overrides": { "signingConfiguration": { "encryptionAlgorithm": "string", "hashAlgorithm": "string" }, "signingImageFormat": "string" }, "platformDisplayName": "string", "platformId": "string", "profileName": "string", "profileVersion": "string", "requestedBy": "string", "revocationRecord": { "reason": "string", "revokedAt": number, "revokedBy": "string" }, "signatureExpiresAt": number, "signedObject": { "s3": { "bucketName": "string", "key": "string" } }, "signingMaterial": { "certificateArn": "string" }, "signingParameters": { "string" : "string" }, "source": { "s3": { "bucketName": "string", "key": "string", "version": "string" } }, "status": "string", "statusReason": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Date and time that the signing job was completed.

Type: Timestamp


Date and time that the signing job was created.

Type: Timestamp


The ID of the signing job on output.

Type: String


The IAM entity that initiated the signing job.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$


The AWS account ID of the job owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$


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

Type: SigningPlatformOverrides object


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

Type: String


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

Type: String


The name of the profile that initiated the signing operation.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_]{2,}


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

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[a-zA-Z0-9]{10}$


The IAM principal that requested the signing job.

Type: String


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.

Type: SigningJobRevocationRecord object


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

Type: Timestamp


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

Type: SignedObject object


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

Type: SigningMaterial object


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

Type: String to string map


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

Type: Source object


Status of the signing job.

Type: String

Valid Values: InProgress | Failed | Succeeded


String value that contains the status reason.

Type: String


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


An internal error occurred.

HTTP Status Code: 500


A specified resource could not be found.

HTTP Status Code: 404


The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

HTTP Status Code: 429


Describe a signing job

This example illustrates one usage of DescribeSigningJob.

Sample Request

GET /Prod/signing-jobs/9052caa6-1d8d-43b5-9ead-0cb8621c8c74 HTTP/1.1 Host: Accept-Encoding: identity Authorization: AWS4-HMAC-SHA256 Credential=access_key/us-east-1/signer/aws4_request, SignedHeaders=host;x-amz-date, Signature=93e24ab743082913abfb466a13b2f65a7f3eec9893aa2dcbdc91d160b3d7ff67 X-Amz-Date: 20171115T165923Z User-Agent: aws-cli/1.11.132 Python/2.7.9 Windows/8 botocore/1.5.95

Sample Response

HTTP/1.1 200 OK Content-Type: application/json Content-Length: 631 Date: Wed, 15 Nov 2017 16:59:31 GMT x-amzn-RequestId: 5946a79a-ca26-11e7-ae27-cda958f39b26 X-Amzn-Trace-Id: sampled=0;root=1-5a0c7273-fd33420b90425c1dc4b94bcc X-Cache: Miss from cloudfront Via: 1.1 (CloudFront) X-Amz-Cf-Id: hAkstXf07ycoa3HgI2MebhYgvyZ39K7zn2Z9mpqxsRlPjPphgaHZUQ== Connection: Keep-alive { "jobId": "9052caa6-1d8d-43b5-9ead-0cb8621c8c74", "source": { "s3": { "bucketName": "signer-test-source", "key": "", "version": "W.OIrIFmjIFeuNXOaBJzPee66.wRg4GR" } }, "signingMaterial": { "certificateArn": "arn:aws:acm:region:123456789012:certificate/9ec626ca-0bbb-4be5-83a2-ee563f8386ca" }, "platform": "TexasInstruments", "signingParameters": null, "createdAt": 1510695622, "completedAt": 1510695623, "requestedBy": "arn:aws:iam::123456789012:root", "status": "Succeeded", "statusReason": "Signing success", "signedObject": { "s3": { "bucketName": "signer-test-dest", "key": "9052caa6-1d8d-43b5-9ead-0cb8621c8c74" } } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: