CodeStar / Client / associate_team_member

associate_team_member#

CodeStar.Client.associate_team_member(**kwargs)#

Adds an IAM user to the team for an AWS CodeStar project.

See also: AWS API Documentation

Request Syntax

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

  • projectId (string) –

    [REQUIRED]

    The ID of the project to which you will add the IAM user.

  • clientRequestToken (string) – A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.

  • userArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.

  • projectRole (string) –

    [REQUIRED]

    The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.

  • remoteAccessAllowed (boolean) – Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.

Return type:

dict

Returns:

Response Syntax

{
    'clientRequestToken': 'string'
}

Response Structure

  • (dict) –

    • clientRequestToken (string) –

      The user- or system-generated token from the initial request that can be used to repeat the request.

Exceptions

  • CodeStar.Client.exceptions.LimitExceededException

  • CodeStar.Client.exceptions.ProjectNotFoundException

  • CodeStar.Client.exceptions.TeamMemberAlreadyAssociatedException

  • CodeStar.Client.exceptions.ValidationException

  • CodeStar.Client.exceptions.InvalidServiceRoleException

  • CodeStar.Client.exceptions.ProjectConfigurationException

  • CodeStar.Client.exceptions.ConcurrentModificationException