CodeStar / Client / list_team_members

list_team_members#

CodeStar.Client.list_team_members(**kwargs)#

Lists all team members associated with a project.

See also: AWS API Documentation

Request Syntax

response = client.list_team_members(
    projectId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • projectId (string) –

    [REQUIRED]

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

  • nextToken (string) – The continuation token for the next set of results, if the results cannot be returned in one response.

  • maxResults (integer) – The maximum number of team members you want returned in a 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) –

      The continuation token to use when requesting the next set of results, if there are more results to be returned.

Exceptions

  • CodeStar.Client.exceptions.ProjectNotFoundException

  • CodeStar.Client.exceptions.InvalidNextTokenException

  • CodeStar.Client.exceptions.ValidationException