ListTeamMembers - AWS CodeStar

On July 31, 2024, Amazon Web Services (AWS) will discontinue support for creating and viewing AWS CodeStar projects. After July 31, 2024, you will no longer be able to access the AWS CodeStar console or create new projects. However, the AWS resources created by AWS CodeStar, including your source repositories, pipelines, and builds, will be unaffected by this change and will continue to function. AWS CodeStar Connections will not be impacted by this discontinuation.

 

If you wish to track work, develop code, and build, test, and deploy your applications, Amazon CodeCatalyst provides a streamlined getting started process and additional functionality to manage your software projects. Learn more about functionality and pricing of Amazon CodeCatalyst.

ListTeamMembers

Lists all team members associated with a project.

Request Syntax

{ "maxResults": number, "nextToken": "string", "projectId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

The maximum number of team members you want returned in a response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

The continuation token for the next set of results, if the results cannot be returned in one response.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[\w/+=]+$

Required: No

projectId

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

Type: String

Length Constraints: Minimum length of 2. Maximum length of 15.

Pattern: ^[a-z][a-z0-9-]+$

Required: Yes

Response Syntax

{ "nextToken": "string", "teamMembers": [ { "projectRole": "string", "remoteAccessAllowed": boolean, "userArn": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[\w/+=]+$

teamMembers

A list of team member objects for the project.

Type: Array of TeamMember objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The next token is not valid.

HTTP Status Code: 400

ProjectNotFoundException

The specified AWS CodeStar project was not found.

HTTP Status Code: 400

ValidationException

The specified input is either not valid, or it could not be validated.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListTeamMembers.

Sample Request

POST / HTTP/1.1 Host codestar.us-east-1.amazonaws.com Accept-Encoding identity Content-Length 32 X-Amz-Target CodeStar_20170419.ListTeamMembers X-Amz-Date 20170405T221259Z User-Agent aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93 Content-Type application/x-amz-json-1.1 Authorization AWS4-HMAC-SHA256 Credential=AIDACKCEVSQ6C2EXAMPLE/20170405/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE { "projectId": "my-first-projec" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 0876d969-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 121 Date: Wed, 05 Apr 2017 22:13:01 GMT {"teamMembers":[ {"projectRole":"Owner","remoteAccessAllowed":true,"userArn":"arn:aws:iam::111111111111:user/Mary_Major"}, {"projectRole":"Contributor","remoteAccessAllowed":true,"userArn":"arn:aws:iam::111111111111:user/Jane_Doe"}, {"projectRole":"Contributor","remoteAccessAllowed":true,"userArn":"arn:aws:iam::111111111111:user/John_Doe"}, {"projectRole":"Viewer","remoteAccessAllowed":false,"userArn":"arn:aws:iam::111111111111:user/John_Stiles"} ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: