ACMPCA / Paginator / ListPermissions

ListPermissions

class ACMPCA.Paginator.ListPermissions

paginator = client.get_paginator('list_permissions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ACMPCA.Client.list_permissions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CertificateAuthorityArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CertificateAuthorityArn (string) –

  [REQUIRED]

  The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA’s ARN by running the ListCertificateAuthorities action.

• 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

{
    'Permissions': [
        {
            'CertificateAuthorityArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Principal': 'string',
            'SourceAccount': 'string',
            'Actions': [
                'IssueCertificate'|'GetCertificate'|'ListPermissions',
            ],
            'Policy': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Permissions (list) –

    Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

    • (dict) –

      Permissions designate which private CA actions can be performed by an Amazon Web Services service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions ( IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

      • CertificateAuthorityArn (string) –

        The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

      • CreatedAt (datetime) –

        The time at which the permission was created.

      • Principal (string) –

        The Amazon Web Services service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

      • SourceAccount (string) –

        The ID of the account that assigned the permission.

      • Actions (list) –

        The private CA actions that can be performed by the designated Amazon Web Services service.

        • (string) –

      • Policy (string) –

        The name of the policy that is associated with the permission.