IAM / Paginator / ListAccountAliases

ListAccountAliases¶

class IAM.Paginator.ListAccountAliases ¶

paginator = client.get_paginator('list_account_aliases')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from IAM.Client.list_account_aliases().

Request Syntax

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

Parameters:

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

{
    'AccountAliases': [
        'string',
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

(dict) –

Contains the response to a successful ListAccountAliases request.
- AccountAliases (list) –
  
  A list of aliases associated with the account. Amazon Web Services supports only one alias per account.
  - (string) –
- IsTruncated (boolean) –
  
  A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.
- NextToken (string) –
  
  A token to resume pagination.