IAM / Paginator / ListSSHPublicKeys

ListSSHPublicKeys

class IAM.Paginator.ListSSHPublicKeys

paginator = client.get_paginator('list_ssh_public_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IAM.Client.list_ssh_public_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 IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the Amazon Web Services access key used to sign the request.

  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

{
    'SSHPublicKeys': [
        {
            'UserName': 'string',
            'SSHPublicKeyId': 'string',
            'Status': 'Active'|'Inactive',
            'UploadDate': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response to a successful ListSSHPublicKeys request.

  • SSHPublicKeys (list) –

    A list of the SSH public keys assigned to IAM user.

    • (dict) –

      Contains information about an SSH public key, without the key’s body or fingerprint.

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

      • UserName (string) –

        The name of the IAM user associated with the SSH public key.

      • SSHPublicKeyId (string) –

        The unique identifier for the SSH public key.

      • Status (string) –

        The status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.

      • UploadDate (datetime) –

        The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

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