signing_platforms
Creates, updates, deletes, gets or lists a signing_platforms resource.
Overview
| Name | signing_platforms |
| Type | Resource |
| Id | aws.signer.signing_platforms |
Fields
The following fields are returned by SELECT queries:
- get_signing_platform
- list_signing_platforms
| Name | Datatype | Description |
|---|---|---|
category | string | The category type of the target signing platform. (AWSIoT) |
display_name | string | The display name of the target signing platform. |
max_size_in_mb | integer | The maximum size (in MB) of the payload that can be signed by the target platform. |
partner | string | A list of partner entities that use the target signing platform. |
platform_id | string | The ID of the target signing platform. |
revocation_supported | boolean | A flag indicating whether signatures generated for the signing platform can be revoked. |
signing_configuration | object | A list of configurations applied to the target platform at signing. |
signing_image_format | object | The format of the target platform's signing image. |
target | string | The validation template that is used by the target signing platform. |
| Name | Datatype | Description |
|---|---|---|
category | string | The category of a signing platform. (AWSIoT) |
display_name | string | The display name of a signing platform. |
max_size_in_mb | integer | The maximum size (in MB) of code that can be signed by a signing platform. |
partner | string | Any partner entities linked to a signing platform. |
platform_id | string | The ID of a signing platform. |
revocation_supported | boolean | Indicates whether revocation is supported for the platform. |
signing_configuration | object | The configuration of a signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform. |
signing_image_format | object | The image format of a AWS Signer platform or profile. |
target | string | The types of targets that can be signed by a signing platform. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_signing_platform | select | platform_id, region | Returns information on a specific signing platform. | |
list_signing_platforms | select | region | category, partner, target, maxResults, nextToken | Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
platform_id | string | The ID of the target signing platform. |
region | string | AWS region (default: us-east-1) |
category | string | The category type of a signing platform. |
maxResults | integer | The maximum number of results to be returned by this operation. |
nextToken | string | Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received. |
partner | string | Any partner entities connected to a signing platform. |
target | string | The validation template that is used by the target signing platform. |
SELECT examples
- get_signing_platform
- list_signing_platforms
Returns information on a specific signing platform.
SELECT
category,
display_name,
max_size_in_mb,
partner,
platform_id,
revocation_supported,
signing_configuration,
signing_image_format,
target
FROM aws.signer.signing_platforms
WHERE platform_id = '{{ platform_id }}' -- required
AND region = '{{ region }}' -- required
;
Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.
SELECT
category,
display_name,
max_size_in_mb,
partner,
platform_id,
revocation_supported,
signing_configuration,
signing_image_format,
target
FROM aws.signer.signing_platforms
WHERE region = '{{ region }}' -- required
AND category = '{{ category }}'
AND partner = '{{ partner }}'
AND target = '{{ target }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;