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.

GetSigningPlatform

Returns information on a specific signing platform.

Request Syntax

GET /signing-platforms/platformId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

platformId

The ID of the target signing platform.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "category": "string", "displayName": "string", "maxSizeInMB": number, "partner": "string", "platformId": "string", "signingConfiguration": { "encryptionAlgorithmOptions": { "allowedValues": [ "string" ], "defaultValue": "string" }, "hashAlgorithmOptions": { "allowedValues": [ "string" ], "defaultValue": "string" } }, "signingImageFormat": { "defaultFormat": "string", "supportedFormats": [ "string" ] }, "target": "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.

category

The category type of the target signing platform.

Type: String

Valid Values: AWSIoT

displayName

The display name of the target signing platform.

Type: String

maxSizeInMB

The maximum size (in MB) of the payload that can be signed by the target platform.

Type: Integer

partner

A list of partner entities that use the target signing platform.

Type: String

platformId

The ID of the target signing platform.

Type: String

signingConfiguration

A list of configurations applied to the target platform at signing.

Type: SigningConfiguration object

signingImageFormat

The format of the target platform's signing image.

Type: SigningImageFormat object

target

The validation template that is used by the target signing platform.

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

See Also

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