signer / Paginator / ListSigningPlatforms

ListSigningPlatforms#

class signer.Paginator.ListSigningPlatforms#
paginator = client.get_paginator('list_signing_platforms')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from signer.Client.list_signing_platforms().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    category='string',
    partner='string',
    target='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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

      A token to resume pagination.