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

GetSigningProfile

Returns information on a specific signing profile.

Request Syntax


GET /signing-profiles/profileName?profileOwner=profileOwner HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

profileName

The name of the target signing profile.

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.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "overrides": { 
      "signingConfiguration": { 
         "encryptionAlgorithm": "string",
         "hashAlgorithm": "string"
      },
      "signingImageFormat": "string"
   },
   "platformDisplayName": "string",
   "platformId": "string",
   "profileName": "string",
   "profileVersion": "string",
   "profileVersionArn": "string",
   "revocationRecord": { 
      "revocationEffectiveFrom": number,
      "revokedAt": number,
      "revokedBy": "string"
   },
   "signatureValidityPeriod": { 
      "type": "string",
      "value": number
   },
   "signingMaterial": { 
      "certificateArn": "string"
   },
   "signingParameters": { 
      "string" : "string" 
   },
   "status": "string",
   "statusReason": "string",
   "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.

arn

The Amazon Resource Name (ARN) for the signing profile.

Type: String

overrides

A list of overrides applied by the target signing profile for signing operations.

Type: SigningPlatformOverrides object

platformDisplayName

A human-readable name for the signing platform associated with the signing profile.

Type: String

platformId

The ID of the platform that is used by the target signing profile.

Type: String

profileName

The name of the target signing profile.

Type: String

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

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

profileVersion

The current version of the signing profile.

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.

revocationRecord

Revocation information for a signing profile.

Type: SigningProfileRevocationRecord object

signatureValidityPeriod

The validity period for a signing job.

Type: SignatureValidityPeriod object

signingMaterial

The ARN of the certificate that the target profile uses for signing operations.

Type: SigningMaterial object

signingParameters

A map of key-value pairs for signing operations that is attached to the target signing profile.

Type: String to string map

status

The status of the target signing profile.

Type: String

Valid Values: Active | Canceled | Revoked

statusReason

Reason for the status of the target signing profile.

Type: String

tags

A list of tags associated with the signing profile.

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.

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