ListSigningJobsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SignerClient, ListSigningJobsCommand } from "@aws-sdk/client-signer"; // ES Modules import
// const { SignerClient, ListSigningJobsCommand } = require("@aws-sdk/client-signer"); // CommonJS import
const client = new SignerClient(config);
const input = { // ListSigningJobsRequest
  status: "InProgress" || "Failed" || "Succeeded",
  platformId: "STRING_VALUE",
  requestedBy: "STRING_VALUE",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  isRevoked: true || false,
  signatureExpiresBefore: new Date("TIMESTAMP"),
  signatureExpiresAfter: new Date("TIMESTAMP"),
  jobInvoker: "STRING_VALUE",
};
const command = new ListSigningJobsCommand(input);
const response = await client.send(command);
// { // ListSigningJobsResponse
//   jobs: [ // SigningJobs
//     { // SigningJob
//       jobId: "STRING_VALUE",
//       source: { // Source
//         s3: { // S3Source
//           bucketName: "STRING_VALUE", // required
//           key: "STRING_VALUE", // required
//           version: "STRING_VALUE", // required
//         },
//       },
//       signedObject: { // SignedObject
//         s3: { // S3SignedObject
//           bucketName: "STRING_VALUE",
//           key: "STRING_VALUE",
//         },
//       },
//       signingMaterial: { // SigningMaterial
//         certificateArn: "STRING_VALUE", // required
//       },
//       createdAt: new Date("TIMESTAMP"),
//       status: "InProgress" || "Failed" || "Succeeded",
//       isRevoked: true || false,
//       profileName: "STRING_VALUE",
//       profileVersion: "STRING_VALUE",
//       platformId: "STRING_VALUE",
//       platformDisplayName: "STRING_VALUE",
//       signatureExpiresAt: new Date("TIMESTAMP"),
//       jobOwner: "STRING_VALUE",
//       jobInvoker: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListSigningJobsCommand Input

See ListSigningJobsCommandInput for more details

Parameter
Type
Description
isRevoked
boolean | undefined

Filters results to return only signing jobs with revoked signatures.

jobInvoker
string | undefined

Filters results to return only signing jobs initiated by a specified IAM entity.

maxResults
number | undefined

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 | undefined

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 | undefined

The ID of microcontroller platform that you specified for the distribution of your code image.

requestedBy
string | undefined

The IAM principal that requested the signing job.

signatureExpiresAfter
Date | undefined

Filters results to return only signing jobs with signatures expiring after a specified timestamp.

signatureExpiresBefore
Date | undefined

Filters results to return only signing jobs with signatures expiring before a specified timestamp.

status
SigningStatus | undefined

A status value with which to filter your results.

ListSigningJobsCommand Output

See ListSigningJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
jobs
SigningJob[] | undefined

A list of your signing jobs.

nextToken
string | undefined

String for specifying the next set of paginated results.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServiceErrorException
server

An internal error occurred.

TooManyRequestsException
client

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

This error supersedes the error ThrottlingException.

ValidationException
client

You signing certificate could not be validated.

SignerServiceException
Base exception class for all service exceptions from Signer service.