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

RevokeSigningProfile

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid.

Request Syntax


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

{
   "effectiveTime": number,
   "profileVersion": "string",
   "reason": "string"
}

URI Request Parameters

The request uses the following URI parameters.

profileName

The name of the signing profile to be revoked.

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.

effectiveTime

A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.

Type: Timestamp

Required: Yes

profileVersion

The version of the signing profile to be revoked.

Type: String

Length Constraints: Fixed length of 10.

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

Required: Yes

reason

The reason for revoking a signing profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

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

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