CodeStar / Client / create_user_profile

create_user_profile#

CodeStar.Client.create_user_profile(**kwargs)#

Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user’s information appears to other users in AWS CodeStar.

See also: AWS API Documentation

Request Syntax

response = client.create_user_profile(
    userArn='string',
    displayName='string',
    emailAddress='string',
    sshPublicKey='string'
)
Parameters:

  • userArn (string) –

    [REQUIRED]

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

  • displayName (string) –

    [REQUIRED]

    The name that will be displayed as the friendly name for the user in AWS CodeStar.

  • emailAddress (string) –

    [REQUIRED]

    The email address that will be displayed as part of the user’s profile in AWS CodeStar.

  • sshPublicKey (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'userArn': 'string',
    'displayName': 'string',
    'emailAddress': 'string',
    'sshPublicKey': 'string',
    'createdTimestamp': datetime(2015, 1, 1),
    'lastModifiedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • userArn (string) –

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

    • displayName (string) –

      The name that is displayed as the friendly name for the user in AWS CodeStar.

    • emailAddress (string) –

      The email address that is displayed as part of the user’s profile in AWS CodeStar.

    • sshPublicKey (string) –

      The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.

    • createdTimestamp (datetime) –

      The date the user profile was created, in timestamp format.

    • lastModifiedTimestamp (datetime) –

      The date the user profile was last modified, in timestamp format.

Exceptions

  • CodeStar.Client.exceptions.UserProfileAlreadyExistsException

  • CodeStar.Client.exceptions.ValidationException