IAM / Paginator / ListAccessKeys

ListAccessKeys

class IAM.Paginator.ListAccessKeys

paginator = client.get_paginator('list_access_keys')

paginate(**kwargs)

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

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.

  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

{
    'AccessKeyMetadata': [
        {
            'UserName': 'string',
            'AccessKeyId': 'string',
            'Status': 'Active'|'Inactive',
            'CreateDate': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response to a successful ListAccessKeys request.

  • AccessKeyMetadata (list) –

    A list of objects containing metadata about the access keys.

    • (dict) –

      Contains information about an Amazon Web Services access key, without its secret key.

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

      • UserName (string) –

        The name of the IAM user that the key is associated with.

      • AccessKeyId (string) –

        The ID for this access key.

      • Status (string) –

        The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

      • CreateDate (datetime) –

        The date when the access key was created.

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