AWS CodeStar
API Reference (API Version 2017-04-19)


Lists all the user profiles configured for your AWS account in AWS CodeStar.

Request Syntax

{ "maxResults": number, "nextToken": "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.


The maximum number of results to return in a response.

Type: Integer

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

Required: No


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 512.

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

Required: No

Response Syntax

{ "nextToken": "string", "userProfiles": [ { "displayName": "string", "emailAddress": "string", "sshPublicKey": "string", "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.


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 512.

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


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

Type: Array of UserProfileSummary objects


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


The next token is not valid.

HTTP Status Code: 400


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

HTTP Status Code: 400


Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 2 X-Amz-Target: CodeStar_20170419.ListUserProfiles X-Amz-Date: 20170406T011822Z 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/20170406/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE {}

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: ee7b652d-EXAMPLE Content-Type: application/x-amz-json-1.1 Content-Length: 1473 Date: Thu, 06 Apr 2017 01:18:24 GMT { "userProfiles":[ { "displayName":"Jane Doe", "emailAddress":"", "sshPublicKey":"EXAMPLE1", "userArn":"arn:aws:iam::111111111111:user/Jane_Doe" }, { "displayName":"John Doe", "emailAddress":"", "sshPublicKey":"EXAMPLE2", "userArn":"arn:aws:iam::111111111111:user/John_Doe" }, { "displayName":"Mary Major", "emailAddress":"", "sshPublicKey":"EXAMPLE=", "userArn":"arn:aws:iam::111111111111:user/Mary_Major" }, { "displayName":"John Stiles", "emailAddress":"", "sshPublicKey":"", "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: