CodeStar / Paginator / ListUserProfiles

ListUserProfiles

class CodeStar.Paginator.ListUserProfiles

paginator = client.get_paginator('list_user_profiles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeStar.Client.list_user_profiles().

See also: AWS API Documentation

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

{
    'userProfiles': [
        {
            'userArn': 'string',
            'displayName': 'string',
            'emailAddress': 'string',
            'sshPublicKey': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • userProfiles (list) –

    All the user profiles configured in AWS CodeStar for an AWS account.

    • (dict) –

      Information about a user’s profile in AWS CodeStar.

      • userArn (string) –

        The Amazon Resource Name (ARN) of the user in IAM.

      • displayName (string) –

        The display name of a user in AWS CodeStar. For example, this could be set to both first and last name (“Mary Major”) or a single name (“Mary”). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example “Mary Jane Major”) would generate an initial icon using the first character and the first character after the space (“MJ”, not “MM”).

      • emailAddress (string) –

        The email address associated with the user.

      • sshPublicKey (string) –

        The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user’s private key for SSH access.

  • NextToken (string) –

    A token to resume pagination.