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

UserProfileSummary

Information about a user's profile in AWS CodeStar.

Contents

displayName

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

Type: String

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

Pattern: ^\S(.*\S)?$

Required: No

emailAddress

The email address associated with the user.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 128.

Pattern: ^[\w-.+]+@[\w-.+]+$

Required: No

sshPublicKey

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

Type: String

Length Constraints: Maximum length of 16384.

Pattern: ^[\t\r\n\u0020-\u00FF]*$

Required: No

userArn

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

Type: String

Length Constraints: Minimum length of 32. Maximum length of 95.

Pattern: ^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$

Required: No

See Also

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

On this page: