[ aws . codestar ]

list-team-members

Description

Lists all team members associated with a project.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-team-members is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: teamMembers

Synopsis

  list-team-members
--project-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--project-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view a list of team members

The following list-team-members example retrieves a list of users associated with the specified project.

aws codestar list-team-members \
    --project-id my-project

Output:

{
    "teamMembers": [
        {
            "userArn": "arn:aws:iam::123456789012:user/admin",
            "projectRole": "Owner",
            "remoteAccessAllowed": false
        },
        {
            "userArn": "arn:aws:iam::123456789012:user/intern",
            "projectRole": "Contributor",
            "remoteAccessAllowed": false
        }
    ]
}

Output

teamMembers -> (list)

A list of team member objects for the project.

(structure)

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.