signer / Paginator / ListSigningProfiles

ListSigningProfiles

class signer.Paginator.ListSigningProfiles

paginator = client.get_paginator('list_signing_profiles')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    includeCanceled=True|False,
    platformId='string',
    statuses=[
        'Active'|'Canceled'|'Revoked',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• includeCanceled (boolean) – Designates whether to include profiles with the status of CANCELED.

• platformId (string) – Filters results to return only signing jobs initiated for a specified signing platform.

• statuses (list) –

  Filters results to return only signing jobs with statuses in the specified list.

  • (string) –

• 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

{
    'profiles': [
        {
            'profileName': 'string',
            'profileVersion': 'string',
            'profileVersionArn': 'string',
            'signingMaterial': {
                'certificateArn': 'string'
            },
            'signatureValidityPeriod': {
                'value': 123,
                'type': 'DAYS'|'MONTHS'|'YEARS'
            },
            'platformId': 'string',
            'platformDisplayName': 'string',
            'signingParameters': {
                'string': 'string'
            },
            'status': 'Active'|'Canceled'|'Revoked',
            'arn': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • profiles (list) –

    A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

    • (dict) –

      Contains information about the ACM certificates and signing configuration parameters that can be used by a given code signing user.

      • profileName (string) –

        The name of the signing profile.

      • profileVersion (string) –

        The version of a signing profile.

      • profileVersionArn (string) –

        The ARN of a signing profile, including the profile version.

      • signingMaterial (dict) –

        The ACM certificate that is available for use by a signing profile.

        • certificateArn (string) –

          The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

      • signatureValidityPeriod (dict) –

        The validity period for a signing job created using this signing profile.

        • value (integer) –

          The numerical value of the time unit for signature validity.

        • type (string) –

          The time unit for signature validity.

      • platformId (string) –

        The ID of a platform that is available for use by a signing profile.

      • platformDisplayName (string) –

        The name of the signing platform.

      • signingParameters (dict) –

        The parameters that are available for use by a Signer user.

        • (string) –

          • (string) –

      • status (string) –

        The status of a signing profile.

      • arn (string) –

        The Amazon Resource Name (ARN) for the signing profile.

      • tags (dict) –

        A list of tags associated with the signing profile.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.