signing_jobs

Creates, updates, deletes, gets or lists a signing_jobs resource.

Overview

Name	signing_jobs
Type	Resource
Id	aws.signer.signing_jobs

Fields

The following fields are returned by SELECT queries:

describe_signing_job

Name	Datatype	Description
completed_at	string (date-time)	Date and time that the signing job was completed.
created_at	string (date-time)	Date and time that the signing job was created.
job_id	string	The ID of the signing job on output.
job_invoker	string	The IAM entity that initiated the signing job. (pattern: <code>^[0-9]{12}$</code>)
job_owner	string	The AWS account ID of the job owner. (pattern: <code>^[0-9]{12}$</code>)
overrides	object	Any overrides that are applied to the signing configuration of a signing platform.
platform_display_name	string	A human-readable name for the signing platform associated with the signing job.
platform_id	string	The microcontroller platform to which your signed code image will be distributed.
profile_name	string	The name of the profile that initiated the signing operation. (pattern: <code>^[a-zA-Z0-9_]{2,}</code>)
profile_version	string	The version of the signing profile used to initiate the signing job. (pattern: <code>^[a-zA-Z0-9]{10}$</code>)
requested_by	string	The IAM principal that requested the signing job.
revocation_record	object	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.
signature_expires_at	string (date-time)	Thr expiration timestamp for the signature generated by the signing job.
signed_object	object	Name of the S3 bucket where the signed code image is saved by AWS Signer.
signing_material	object	The ACM certificate that is used to sign your code.
signing_parameters	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.
source	object	The object that contains the name of your S3 bucket or your raw code.
status	string	Status of the signing job. (InProgress, Failed, Succeeded)
status_reason	string	String value that contains the status reason.

list_signing_jobs

Name	Datatype	Description
created_at	string (date-time)	The date and time that the signing job was created.
is_revoked	boolean	Indicates whether the signing job is revoked.
job_id	string	The ID of the signing job.
job_invoker	string	The AWS account ID of the job invoker. (pattern: <code>^[0-9]{12}$</code>)
job_owner	string	The AWS account ID of the job owner. (pattern: <code>^[0-9]{12}$</code>)
platform_display_name	string	The name of a signing platform.
platform_id	string	The unique identifier for a signing platform.
profile_name	string	The name of the signing profile that created a signing job. (pattern: <code>^[a-zA-Z0-9_]{2,}</code>)
profile_version	string	The version of the signing profile that created a signing job. (pattern: <code>^[a-zA-Z0-9]{10}$</code>)
signature_expires_at	string (date-time)	The time when the signature of a signing job expires.
signed_object	object	A SignedObject structure that contains information about a signing job's signed code image.
signing_material	object	The ACM certificate that is used to sign your code.
source	object	A Source that contains information about a signing job's code image source.
status	string	The status of the signing job. (InProgress, Failed, Succeeded)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_signing_job	select	job_id, region		Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
list_signing_jobs	select	region	status, platformId, requestedBy, maxResults, nextToken, isRevoked, signatureExpiresBefore, signatureExpiresAfter, jobInvoker	Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
job_id	string	The ID of the signing job on input.
region	string	AWS region (default: us-east-1)
isRevoked	boolean	Filters results to return only signing jobs with revoked signatures.
jobInvoker	string	Filters results to return only signing jobs initiated by a specified IAM entity.
maxResults	integer	Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.
nextToken	string	String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.
platformId	string	The ID of microcontroller platform that you specified for the distribution of your code image.
requestedBy	string	The IAM principal that requested the signing job.
signatureExpiresAfter	string (date-time)	Filters results to return only signing jobs with signatures expiring after a specified timestamp.
signatureExpiresBefore	string (date-time)	Filters results to return only signing jobs with signatures expiring before a specified timestamp.
status	string	A status value with which to filter your results.

SELECT examples

describe_signing_job

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

SELECT
completed_at,
created_at,
job_id,
job_invoker,
job_owner,
overrides,
platform_display_name,
platform_id,
profile_name,
profile_version,
requested_by,
revocation_record,
signature_expires_at,
signed_object,
signing_material,
signing_parameters,
source,
status,
status_reason
FROM aws.signer.signing_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_signing_jobs

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

SELECT
created_at,
is_revoked,
job_id,
job_invoker,
job_owner,
platform_display_name,
platform_id,
profile_name,
profile_version,
signature_expires_at,
signed_object,
signing_material,
source,
status
FROM aws.signer.signing_jobs
WHERE region = '{{ region }}' -- required
AND status = '{{ status }}'
AND platformId = '{{ platformId }}'
AND requestedBy = '{{ requestedBy }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND isRevoked = '{{ isRevoked }}'
AND signatureExpiresBefore = '{{ signatureExpiresBefore }}'
AND signatureExpiresAfter = '{{ signatureExpiresAfter }}'
AND jobInvoker = '{{ jobInvoker }}'
;