CodeStar / Paginator / ListTeamMembers

ListTeamMembers#

class CodeStar.Paginator.ListTeamMembers#
paginator = client.get_paginator('list_team_members')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the project for which you want to list team members.

  • 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

{
    'teamMembers': [
        {
            'userArn': 'string',
            'projectRole': 'string',
            'remoteAccessAllowed': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • teamMembers (list) –

      A list of team member objects for the project.

      • (dict) –

        Information about a team member in a project.

        • userArn (string) –

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

        • projectRole (string) –

          The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

        • remoteAccessAllowed (boolean) –

          Whether the user is allowed to remotely access project resources using an SSH public/private key pair.

    • NextToken (string) –

      A token to resume pagination.