ListSigningProﬁles

Lists all available signing proﬁles in your AWS account. Returns only proﬁles with an ACTIVE status unless the includeCanceled request ﬁeld is set to true. If additional jobs remain to be listed, code signing 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 code signing returns in the nextToken parameter until all of your signing jobs have been returned.

Request Syntax

GET /signing-profiles?

includeCanceled=includeCanceled&maxResults=maxResults&nextToken=nextToken&platformId=platformId&statuses=statuses HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

includeCanceled (p. 32)

Designates whether to include proﬁles with the status of CANCELED.

maxResults (p. 32)

The maximum number of proﬁles to be returned.

Valid Range: Minimum value of 1. Maximum value of 25.

nextToken (p. 32)

Value 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 (p. 32)

Filters results to return only signing jobs initiated for a speciﬁed signing platform.

statuses (p. 32)

Filters results to return only signing jobs with statuses in the speciﬁed list.

Valid Values: Active | Canceled | Revoked

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "nextToken": "string", "profiles": [

{

Response Elements

"arn": "string",

"platformDisplayName": "string", "platformId": "string",

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

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

nextToken (p. 32)

Value for specifying the next set of paginated results to return.

Type: String proﬁles (p. 32)

A list of proﬁles that are available in the AWS account. This includes proﬁles with the status of CANCELED if the includeCanceled parameter is set to true.

Type: Array of SigningProﬁle (p. 78) objects

Errors

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

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServiceErrorException

An internal error occurred.

HTTP Status Code: 500 TooManyRequestsException

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

Request Syntax

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 35)

The Amazon Resource Name (ARN) for the signing proﬁle.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "tags": {

"string" : "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.

tags (p. 35)

A list of tags associated with the signing proﬁle.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Errors

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

BadRequestException

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing proﬁle.

HTTP Status Code: 400 InternalServiceErrorException

An internal error occurred.

HTTP Status Code: 500 NotFoundException

The signing proﬁle was not found.

HTTP Status Code: 404 TooManyRequestsException

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

This error supersedes the error ThrottlingException.

HTTP Status Code: 429

Request Syntax

PUT /signing-profiles/profileName HTTP/1.1 Content-type: application/json

{ "overrides": {

"signingConfiguration": {

"encryptionAlgorithm": "string", "hashAlgorithm": "string"

"signingImageFormat": "string"

"platformId": "string", "signatureValidityPeriod": { "type": "string",

"value": number },

"signingMaterial": {

"certificateArn": "string"

"signingParameters": { "string" : "string"

URI Request Parameters

The request uses the following URI parameters.

proﬁleName (p. 37)

The name of the signing proﬁle to be created.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

overrides (p. 37)

A subﬁeld of platform. This speciﬁes any diﬀerent conﬁguration options that you want to apply to the chosen platform (such as a diﬀerent hash-algorithm or signing-algorithm).

Type: SigningPlatformOverrides (p. 77) object

Response Syntax

Required: No platformId (p. 37)

The ID of the signing platform to be created.

Type: String Required: Yes

signatureValidityPeriod (p. 37)

The default validity period override for any signature generated using this signing proﬁle. If unspeciﬁed, the default is 135 months.

Type: SignatureValidityPeriod (p. 65) object Required: No

signingMaterial (p. 37)

The AWS Certiﬁcate Manager certiﬁcate that will be used to sign code with the new signing proﬁle.

Type: SigningMaterial (p. 74) object Required: No

signingParameters (p. 37)

Map of key-value pairs for signing. These can include any information that you want to use during signing.

Type: String to string map Required: No

tags (p. 37)

Tags to be associated with the signing proﬁle that is being created.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "arn": "string",

"profileVersion": "string", "profileVersionArn": "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.

arn (p. 38)

The Amazon Resource Name (ARN) of the signing proﬁle created.

Type: String proﬁleVersion (p. 38)

The version of the signing proﬁle being created.

Type: String

Length Constraints: Fixed length of 10.

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

proﬁleVersionArn (p. 38)

The signing proﬁle ARN, including the proﬁle version.

Type: String

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

Errors

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

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServiceErrorException

An internal error occurred.

HTTP Status Code: 500 ResourceNotFoundException

A speciﬁed resource could not be found.

HTTP Status Code: 404 TooManyRequestsException

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

This error supersedes the error ThrottlingException.

HTTP Status Code: 429 ValidationException

You signing certiﬁcate could not be validated.

ListSigningProﬁles