AccountAccessRuntime / Paginator / ListRoles

ListRoles

class AccountAccessRuntime.Paginator.ListRoles

paginator = client.get_paginator('list_roles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AccountAccessRuntime.Client.list_roles().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• tenantId (string) –

  [REQUIRED]

  The identifier of the tenant whose roles you want to list. A tenant ID begins with aa- and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.

• 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

{
    'roles': [
        {
            'accountId': 'string',
            'accountName': 'string',
            'roleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • roles (list) –

    The list of roles that you can access in the tenant. Each entry describes an Amazon Web Services account and a role.

    • (dict) –

      Describes a role that you can access, including the Amazon Web Services account that contains the role and the role’s ARN.

      • accountId (string) –

        The 12-digit identifier of the Amazon Web Services account that contains the role.

      • accountName (string) –

        The display name of the Amazon Web Services account, if available. This value can be absent when the account name can’t be resolved.

      • roleArn (string) –

        The Amazon Resource Name (ARN) of the role that you can access.

  • NextToken (string) –

    A token to resume pagination.