SignPayload
Signs a binary payload and returns a signature envelope.
Request Syntax
POST /signing-jobs/with-payload HTTP/1.1
Content-type: application/json
{
"payload": blob,
"payloadFormat": "string",
"profileName": "string",
"profileOwner": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- payload
-
Specifies the object digest (hash) to sign.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes
- payloadFormat
-
Payload content type. The single valid type is
application/vnd.cncf.notary.payload.v1+json.Type: String
Required: Yes
- profileName
-
The name of the signing profile.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_]{2,}Required: Yes
- profileOwner
-
The AWS account ID of the profile owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"jobId": "string",
"jobOwner": "string",
"metadata": {
"string" : "string"
},
"signature": blob
}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.
- jobId
-
Unique identifier of the signing job.
Type: String
- jobOwner
-
The AWS account ID of the job owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$ - metadata
-
Information including the signing profile ARN and the signing job ID.
Type: String to string map
- signature
-
A cryptographic signature.
Type: Base64-encoded binary data object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
