AWS Signer
API Reference (API Version 2017-08-25)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeSigningJob

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 requires the following URI parameters.

jobId

The ID of the signing job on input.

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", "overrides": { "signingConfiguration": { "encryptionAlgorithm": "string", "hashAlgorithm": "string" } }, "platformId": "string", "profileName": "string", "requestedBy": "string", "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.

completedAt

Date and time that the signing job was completed.

Type: Timestamp

createdAt

Date and time that the signing job was created.

Type: Timestamp

jobId

The ID of the signing job on output.

Type: String

overrides

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

Type: SigningPlatformOverrides object

platformId

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

Type: String

profileName

The name of the profile that initiated the signing operation.

Type: String

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

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

requestedBy

The IAM principal that requested the signing job.

Type: String

signedObject

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

Type: SignedObject object

signingMaterial

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

Type: SigningMaterial object

signingParameters

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

source

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

Type: Source object

status

Status of the signing job.

Type: String

Valid Values: InProgress | Failed | Succeeded

statusReason

String value that contains the status reason.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceErrorException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

A specified resource could not be found.

HTTP Status Code: 404

Example

Describe a signing job

Sample Request

GET /Prod/signing-jobs/9052caa6-1d8d-43b5-9ead-0cb8621c8c74 HTTP/1.1 Host: signer.us-east-1.amazonaws.com 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 ce270f4a88edde7438864bc44406e83a.cloudfront.net (CloudFront) X-Amz-Cf-Id: hAkstXf07ycoa3HgI2MebhYgvyZ39K7zn2Z9mpqxsRlPjPphgaHZUQ== Connection: Keep-alive { "jobId": "9052caa6-1d8d-43b5-9ead-0cb8621c8c74", "source": { "s3": { "bucketName": "signer-test-source", "key": "my-example-code.java", "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: