SSO / Paginator / ListAccounts

ListAccounts#

class SSO.Paginator.ListAccounts#
paginator = client.get_paginator('list_accounts')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SSO.Client.list_accounts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    accessToken='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • accessToken (string) –

    [REQUIRED]

    The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

  • 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

{
    'accountList': [
        {
            'accountId': 'string',
            'accountName': 'string',
            'emailAddress': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • accountList (list) –

      A paginated response with the list of account information and the next token if more results are available.

      • (dict) –

        Provides information about your AWS account.

        • accountId (string) –

          The identifier of the AWS account that is assigned to the user.

        • accountName (string) –

          The display name of the AWS account that is assigned to the user.

        • emailAddress (string) –

          The email address of the AWS account that is assigned to the user.

    • NextToken (string) –

      A token to resume pagination.