signer / Client / list_signing_platforms

list_signing_platforms#

signer.Client.list_signing_platforms(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_signing_platforms(
    category='string',
    partner='string',
    target='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • category (string) – The category type of a signing platform.

  • partner (string) – Any partner entities connected to a signing platform.

  • target (string) – The validation template that is used by the target 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.

Return type:

dict

Returns:

Response Syntax

{
    'platforms': [
        {
            'platformId': 'string',
            'displayName': 'string',
            'partner': 'string',
            'target': 'string',
            'category': 'AWSIoT',
            'signingConfiguration': {
                'encryptionAlgorithmOptions': {
                    'allowedValues': [
                        'RSA'|'ECDSA',
                    ],
                    'defaultValue': 'RSA'|'ECDSA'
                },
                'hashAlgorithmOptions': {
                    'allowedValues': [
                        'SHA1'|'SHA256',
                    ],
                    'defaultValue': 'SHA1'|'SHA256'
                }
            },
            'signingImageFormat': {
                'supportedFormats': [
                    'JSON'|'JSONEmbedded'|'JSONDetached',
                ],
                'defaultFormat': 'JSON'|'JSONEmbedded'|'JSONDetached'
            },
            'maxSizeInMB': 123,
            'revocationSupported': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • platforms (list) –

      A list of all platforms that match the request parameters.

      • (dict) –

        Contains information about the signing configurations and parameters that are used to perform a code-signing job.

        • platformId (string) –

          The ID of a signing platform.

        • displayName (string) –

          The display name of a signing platform.

        • partner (string) –

          Any partner entities linked to a signing platform.

        • target (string) –

          The types of targets that can be signed by a signing platform.

        • category (string) –

          The category of a signing platform.

        • signingConfiguration (dict) –

          The configuration of a signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.

          • encryptionAlgorithmOptions (dict) –

            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 (dict) –

            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 (dict) –

          The image format of a AWS Signer platform or profile.

          • supportedFormats (list) –

            The supported formats of a signing image.

            • (string) –

          • defaultFormat (string) –

            The default format of a signing image.

        • maxSizeInMB (integer) –

          The maximum size (in MB) of code that can be signed by a signing platform.

        • revocationSupported (boolean) –

          Indicates whether revocation is supported for the platform.

    • nextToken (string) –

      Value for specifying the next set of paginated results to return.

Exceptions