CodeStar / Client / update_team_member

update_team_member#

CodeStar.Client.update_team_member(**kwargs)#

Updates a team member’s attributes in an AWS CodeStar project. For example, you can change a team member’s role in the project, or change whether they have remote access to project resources.

See also: AWS API Documentation

Request Syntax

response = client.update_team_member(
    projectId='string',
    userArn='string',
    projectRole='string',
    remoteAccessAllowed=True|False
)
Parameters:

  • projectId (string) –

    [REQUIRED]

    The ID of the project.

  • userArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.

  • 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 a team member is allowed to remotely access project resources using the SSH public key associated with the user’s profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.

Return type:

dict

Returns:

Response Syntax

{
    'userArn': 'string',
    'projectRole': 'string',
    'remoteAccessAllowed': True|False
}

Response Structure

  • (dict) –

    • userArn (string) –

      The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.

    • projectRole (string) –

      The project role granted to the user.

    • remoteAccessAllowed (boolean) –

      Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user’s profile.

Exceptions

  • CodeStar.Client.exceptions.LimitExceededException

  • CodeStar.Client.exceptions.ProjectNotFoundException

  • CodeStar.Client.exceptions.ValidationException

  • CodeStar.Client.exceptions.InvalidServiceRoleException

  • CodeStar.Client.exceptions.ProjectConfigurationException

  • CodeStar.Client.exceptions.ConcurrentModificationException

  • CodeStar.Client.exceptions.TeamMemberNotFoundException