IAM / Paginator / ListMFADevices

ListMFADevices

class IAM.Paginator.ListMFADevices

paginator = client.get_paginator('list_mfa_devices')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• UserName (string) –

  The name of the user whose MFA devices you want to list.

  This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

• 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

{
    'MFADevices': [
        {
            'UserName': 'string',
            'SerialNumber': 'string',
            'EnableDate': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response to a successful ListMFADevices request.

  • MFADevices (list) –

    A list of MFA devices.

    • (dict) –

      Contains information about an MFA device.

      This data type is used as a response element in the ListMFADevices operation.

      • UserName (string) –

        The user with whom the MFA device is associated.

      • SerialNumber (string) –

        The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

      • EnableDate (datetime) –

        The date when the MFA device was enabled for the user.

  • 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.