amazonka-codestar-2.0: Amazon CodeStar SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeStar.UpdateTeamMember

Description

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.

Synopsis

Creating a Request

data UpdateTeamMember Source #

See: newUpdateTeamMember smart constructor.

Constructors

UpdateTeamMember' 

Fields

  • projectRole :: Maybe Text

    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 :: Maybe Bool

    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.

  • projectId :: Text

    The ID of the project.

  • userArn :: Text

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

Instances

Instances details
ToJSON UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

ToHeaders UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

ToPath UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

ToQuery UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

AWSRequest UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Associated Types

type AWSResponse UpdateTeamMember #

Generic UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Associated Types

type Rep UpdateTeamMember :: Type -> Type #

Read UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Show UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

NFData UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Methods

rnf :: UpdateTeamMember -> () #

Eq UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Hashable UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

type AWSResponse UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

type Rep UpdateTeamMember Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

type Rep UpdateTeamMember = D1 ('MetaData "UpdateTeamMember" "Amazonka.CodeStar.UpdateTeamMember" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "UpdateTeamMember'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "remoteAccessAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateTeamMember Source #

Create a value of UpdateTeamMember with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateTeamMember, updateTeamMember_projectRole - 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.

UpdateTeamMember, updateTeamMember_remoteAccessAllowed - 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.

UpdateTeamMember, updateTeamMember_projectId - The ID of the project.

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

Request Lenses

updateTeamMember_projectRole :: Lens' UpdateTeamMember (Maybe Text) Source #

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.

updateTeamMember_remoteAccessAllowed :: Lens' UpdateTeamMember (Maybe Bool) Source #

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.

updateTeamMember_userArn :: Lens' UpdateTeamMember Text Source #

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

Destructuring the Response

data UpdateTeamMemberResponse Source #

See: newUpdateTeamMemberResponse smart constructor.

Constructors

UpdateTeamMemberResponse' 

Fields

Instances

Instances details
Generic UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Associated Types

type Rep UpdateTeamMemberResponse :: Type -> Type #

Read UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Show UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

NFData UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

Eq UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

type Rep UpdateTeamMemberResponse Source # 
Instance details

Defined in Amazonka.CodeStar.UpdateTeamMember

type Rep UpdateTeamMemberResponse = D1 ('MetaData "UpdateTeamMemberResponse" "Amazonka.CodeStar.UpdateTeamMember" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "UpdateTeamMemberResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "remoteAccessAllowed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateTeamMemberResponse Source #

Create a value of UpdateTeamMemberResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateTeamMember, updateTeamMemberResponse_projectRole - The project role granted to the user.

UpdateTeamMember, updateTeamMemberResponse_remoteAccessAllowed - Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.

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

$sel:httpStatus:UpdateTeamMemberResponse', updateTeamMemberResponse_httpStatus - The response's http status code.

Response Lenses

updateTeamMemberResponse_remoteAccessAllowed :: Lens' UpdateTeamMemberResponse (Maybe Bool) Source #

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

updateTeamMemberResponse_userArn :: Lens' UpdateTeamMemberResponse (Maybe Text) Source #

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