Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeStar.UpdateUserProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a user's profile 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.

Synopsis

data UpdateUserProfile = UpdateUserProfile' {
- displayName :: Maybe (Sensitive Text)
- emailAddress :: Maybe (Sensitive Text)
- sshPublicKey :: Maybe Text
- userArn :: Text
}
newUpdateUserProfile :: Text -> UpdateUserProfile
updateUserProfile_displayName :: Lens' UpdateUserProfile (Maybe Text)
updateUserProfile_emailAddress :: Lens' UpdateUserProfile (Maybe Text)
updateUserProfile_sshPublicKey :: Lens' UpdateUserProfile (Maybe Text)
updateUserProfile_userArn :: Lens' UpdateUserProfile Text
data UpdateUserProfileResponse = UpdateUserProfileResponse' {
- createdTimestamp :: Maybe POSIX
- displayName :: Maybe (Sensitive Text)
- emailAddress :: Maybe (Sensitive Text)
- lastModifiedTimestamp :: Maybe POSIX
- sshPublicKey :: Maybe Text
- httpStatus :: Int
- userArn :: Text
}
newUpdateUserProfileResponse :: Int -> Text -> UpdateUserProfileResponse
updateUserProfileResponse_createdTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime)
updateUserProfileResponse_displayName :: Lens' UpdateUserProfileResponse (Maybe Text)
updateUserProfileResponse_emailAddress :: Lens' UpdateUserProfileResponse (Maybe Text)
updateUserProfileResponse_lastModifiedTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime)
updateUserProfileResponse_sshPublicKey :: Lens' UpdateUserProfileResponse (Maybe Text)
updateUserProfileResponse_httpStatus :: Lens' UpdateUserProfileResponse Int
updateUserProfileResponse_userArn :: Lens' UpdateUserProfileResponse Text

Creating a Request

data UpdateUserProfile Source #

See: newUpdateUserProfile smart constructor.

Constructors

UpdateUserProfile'

Fields

displayName :: Maybe (Sensitive Text)
The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress :: Maybe (Sensitive Text)
The email address that is displayed as part of the user's profile in AWS CodeStar.
sshPublicKey :: Maybe Text
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.
userArn :: Text
The name that will be displayed as the friendly name for the user in AWS CodeStar.

Instances

Instances details

ToJSON UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods toJSON :: UpdateUserProfile -> Value # toEncoding :: UpdateUserProfile -> Encoding # toJSONList :: [UpdateUserProfile] -> Value # toEncodingList :: [UpdateUserProfile] -> Encoding #
ToHeaders UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods toHeaders :: UpdateUserProfile -> [Header] #
ToPath UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods toPath :: UpdateUserProfile -> ByteString #
ToQuery UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods toQuery :: UpdateUserProfile -> QueryString #
AWSRequest UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Associated Types type AWSResponse UpdateUserProfile # Methods request :: (Service -> Service) -> UpdateUserProfile -> Request UpdateUserProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUserProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUserProfile))) #
Generic UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Associated Types type Rep UpdateUserProfile :: Type -> Type # Methods from :: UpdateUserProfile -> Rep UpdateUserProfile x # to :: Rep UpdateUserProfile x -> UpdateUserProfile #
Show UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods showsPrec :: Int -> UpdateUserProfile -> ShowS # show :: UpdateUserProfile -> String # showList :: [UpdateUserProfile] -> ShowS #
NFData UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods rnf :: UpdateUserProfile -> () #
Eq UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods (==) :: UpdateUserProfile -> UpdateUserProfile -> Bool # (/=) :: UpdateUserProfile -> UpdateUserProfile -> Bool #
Hashable UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods hashWithSalt :: Int -> UpdateUserProfile -> Int # hash :: UpdateUserProfile -> Int #
type AWSResponse UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile type AWSResponse UpdateUserProfile = UpdateUserProfileResponse
type Rep UpdateUserProfile Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile type Rep UpdateUserProfile = D1 ('MetaData "UpdateUserProfile" "Amazonka.CodeStar.UpdateUserProfile" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "UpdateUserProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateUserProfile Source #

Arguments

:: Text	`UpdateUserProfile`
-> UpdateUserProfile

Create a value of UpdateUserProfile 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:

UpdateUserProfile, updateUserProfile_displayName - The name that is displayed as the friendly name for the user in AWS CodeStar.

UpdateUserProfile, updateUserProfile_emailAddress - The email address that is displayed as part of the user's profile in AWS CodeStar.

UpdateUserProfile, updateUserProfile_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.

UpdateUserProfile, updateUserProfile_userArn - The name that will be displayed as the friendly name for the user in AWS CodeStar.

Request Lenses

updateUserProfile_displayName :: Lens' UpdateUserProfile (Maybe Text) Source #

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

updateUserProfile_emailAddress :: Lens' UpdateUserProfile (Maybe Text) Source #

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

updateUserProfile_sshPublicKey :: Lens' UpdateUserProfile (Maybe Text) Source #

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.

updateUserProfile_userArn :: Lens' UpdateUserProfile Text Source #

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

Destructuring the Response

data UpdateUserProfileResponse Source #

See: newUpdateUserProfileResponse smart constructor.

Constructors

UpdateUserProfileResponse'

Fields

createdTimestamp :: Maybe POSIX
The date the user profile was created, in timestamp format.
displayName :: Maybe (Sensitive Text)
The name that is displayed as the friendly name for the user in AWS CodeStar.
emailAddress :: Maybe (Sensitive Text)
The email address that is displayed as part of the user's profile in AWS CodeStar.
lastModifiedTimestamp :: Maybe POSIX
The date the user profile was last modified, in timestamp format.
sshPublicKey :: Maybe Text
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.
httpStatus :: Int
The response's http status code.
userArn :: Text
The Amazon Resource Name (ARN) of the user in IAM.

Instances

Instances details

Generic UpdateUserProfileResponse Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Associated Types type Rep UpdateUserProfileResponse :: Type -> Type # Methods from :: UpdateUserProfileResponse -> Rep UpdateUserProfileResponse x # to :: Rep UpdateUserProfileResponse x -> UpdateUserProfileResponse #
Show UpdateUserProfileResponse Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods showsPrec :: Int -> UpdateUserProfileResponse -> ShowS # show :: UpdateUserProfileResponse -> String # showList :: [UpdateUserProfileResponse] -> ShowS #
NFData UpdateUserProfileResponse Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods rnf :: UpdateUserProfileResponse -> () #
Eq UpdateUserProfileResponse Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile Methods (==) :: UpdateUserProfileResponse -> UpdateUserProfileResponse -> Bool # (/=) :: UpdateUserProfileResponse -> UpdateUserProfileResponse -> Bool #
type Rep UpdateUserProfileResponse Source #
Instance details Defined in Amazonka.CodeStar.UpdateUserProfile type Rep UpdateUserProfileResponse = D1 ('MetaData "UpdateUserProfileResponse" "Amazonka.CodeStar.UpdateUserProfile" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "UpdateUserProfileResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "lastModifiedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sshPublicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateUserProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateUserProfileResponse'`
-> Text	`UpdateUserProfile`
-> UpdateUserProfileResponse

Create a value of UpdateUserProfileResponse 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:

$sel:createdTimestamp:UpdateUserProfileResponse', updateUserProfileResponse_createdTimestamp - The date the user profile was created, in timestamp format.

UpdateUserProfile, updateUserProfileResponse_displayName - The name that is displayed as the friendly name for the user in AWS CodeStar.

UpdateUserProfile, updateUserProfileResponse_emailAddress - The email address that is displayed as part of the user's profile in AWS CodeStar.

$sel:lastModifiedTimestamp:UpdateUserProfileResponse', updateUserProfileResponse_lastModifiedTimestamp - The date the user profile was last modified, in timestamp format.

UpdateUserProfile, updateUserProfileResponse_sshPublicKey - 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.

$sel:httpStatus:UpdateUserProfileResponse', updateUserProfileResponse_httpStatus - The response's http status code.

UpdateUserProfile, updateUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user in IAM.

Response Lenses

updateUserProfileResponse_createdTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime) Source #

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

updateUserProfileResponse_displayName :: Lens' UpdateUserProfileResponse (Maybe Text) Source #

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

updateUserProfileResponse_emailAddress :: Lens' UpdateUserProfileResponse (Maybe Text) Source #

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

updateUserProfileResponse_lastModifiedTimestamp :: Lens' UpdateUserProfileResponse (Maybe UTCTime) Source #

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

updateUserProfileResponse_sshPublicKey :: Lens' UpdateUserProfileResponse (Maybe Text) Source #

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.

updateUserProfileResponse_httpStatus :: Lens' UpdateUserProfileResponse Int Source #

The response's http status code.

updateUserProfileResponse_userArn :: Lens' UpdateUserProfileResponse Text Source #

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