[ aws . signer ]

get-signing-platform

Description

Returns information on a specific signing platform.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-signing-platform
--platform-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--platform-id (string)

The ID of the target signing platform.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To display details about a signing platform

The following get-signing-platform example displays details about the specified signing platform.

aws signer get-signing-platform \
    --platform-id AmazonFreeRTOS-TI-CC3220SF

Output:

{
    "category": "AWS",
    "displayName": "Amazon FreeRTOS SHA1-RSA CC3220SF-Format",
    "target": "SHA1-RSA-TISHA1",
    "platformId": "AmazonFreeRTOS-TI-CC3220SF",
    "signingConfiguration": {
        "encryptionAlgorithmOptions": {
            "defaultValue": "RSA",
            "allowedValues": [
                "RSA"
            ]
        },
        "hashAlgorithmOptions": {
            "defaultValue": "SHA1",
            "allowedValues": [
                "SHA1"
            ]
        }
    },
    "maxSizeInMB": 16,
    "partner": "AmazonFreeRTOS",
    "signingImageFormat": {
        "defaultFormat": "JSONEmbedded",
        "supportedFormats": [
            "JSONEmbedded"
        ]
    }
}

Output

platformId -> (string)

The ID of the target signing platform.

displayName -> (string)

The display name of the target signing platform.

partner -> (string)

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

target -> (string)

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

category -> (string)

The category type of the target signing platform.

signingConfiguration -> (structure)

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

encryptionAlgorithmOptions -> (structure)

The encryption algorithm options that are available for a code signing job.

allowedValues -> (list)

The set of accepted encryption algorithms that are allowed in a code signing job.

(string)

defaultValue -> (string)

The default encryption algorithm that is used by a code signing job.

hashAlgorithmOptions -> (structure)

The hash algorithm options that are available for a code signing job.

allowedValues -> (list)

The set of accepted hash algorithms allowed in a code signing job.

(string)

defaultValue -> (string)

The default hash algorithm that is used in a code signing job.

signingImageFormat -> (structure)

The format of the target platform’s signing image.

supportedFormats -> (list)

The supported formats of a code signing image.

(string)

defaultFormat -> (string)

The default format of a code signing image.

maxSizeInMB -> (integer)

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

revocationSupported -> (boolean)

A flag indicating whether signatures generated for the signing platform can be revoked.