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.

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. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

Request Syntax

PUT /signing-profiles/profileName HTTP/1.1 Content-type: application/json { "overrides": { "signingConfiguration": { "encryptionAlgorithm": "string", "hashAlgorithm": "string" } }, "platformId": "string", "signingMaterial": { "certificateArn": "string" }, "signingParameters": { "string" : "string" } }

URI Request Parameters

The request requires the following URI parameters.

profileName

The name of the signing profile to be created.

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

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

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 profile to be created.

Type: String

Required: Yes

signingMaterial

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

Type: SigningMaterial object

Required: Yes

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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "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

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

ThrottlingException

The signing job has been throttled.

HTTP Status Code: 429

ValidationException

You signing certificate could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: