Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutSigningProfile

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

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" 
   },
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

profileName

The name of the signing profile 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

A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

Type: SigningPlatformOverrides object

Required: No

platformId

The ID of the signing platform to be created.

Type: String

Required: Yes

signatureValidityPeriod

The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.

Type: SignatureValidityPeriod object

Required: No

signingMaterial

The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

Type: SigningMaterial object

Required: No

signingParameters

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

Tags to be associated with the signing profile 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

The Amazon Resource Name (ARN) of the signing profile created.

Type: String

profileVersion

The version of the signing profile being created.

Type: String

Length Constraints: Fixed length of 10.

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

profileVersionArn

The signing profile ARN, including the profile 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.

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

TooManyRequestsException

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

This error supersedes the error ThrottlingException.

HTTP Status Code: 429

ValidationException

You signing certificate could not be validated.

HTTP Status Code: 400