Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeStar.CreateUserProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateUserProfile = CreateUserProfile' {
- sshPublicKey :: Maybe Text
- userArn :: Text
- displayName :: Sensitive Text
- emailAddress :: Sensitive Text
}
newCreateUserProfile :: Text -> Text -> Text -> CreateUserProfile
createUserProfile_sshPublicKey :: Lens' CreateUserProfile (Maybe Text)
createUserProfile_userArn :: Lens' CreateUserProfile Text
createUserProfile_displayName :: Lens' CreateUserProfile Text
createUserProfile_emailAddress :: Lens' CreateUserProfile Text
data CreateUserProfileResponse = CreateUserProfileResponse' {
- lastModifiedTimestamp :: Maybe POSIX
- sshPublicKey :: Maybe Text
- emailAddress :: Maybe (Sensitive Text)
- displayName :: Maybe (Sensitive Text)
- createdTimestamp :: Maybe POSIX
- httpStatus :: Int
- userArn :: Text
}
newCreateUserProfileResponse :: Int -> Text -> CreateUserProfileResponse
createUserProfileResponse_lastModifiedTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime)
createUserProfileResponse_sshPublicKey :: Lens' CreateUserProfileResponse (Maybe Text)
createUserProfileResponse_emailAddress :: Lens' CreateUserProfileResponse (Maybe Text)
createUserProfileResponse_displayName :: Lens' CreateUserProfileResponse (Maybe Text)
createUserProfileResponse_createdTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime)
createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int
createUserProfileResponse_userArn :: Lens' CreateUserProfileResponse Text

Creating a Request

data CreateUserProfile Source #

See: newCreateUserProfile smart constructor.

Constructors

CreateUserProfile'

Fields

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

Instances

Instances details

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

newCreateUserProfile Source #

Arguments

:: Text	`$sel:userArn:CreateUserProfile'`
-> Text	`$sel:displayName:CreateUserProfile'`
-> Text	`$sel:emailAddress:CreateUserProfile'`
-> CreateUserProfile

Create a value of CreateUserProfile 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:sshPublicKey:CreateUserProfile', createUserProfile_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.

$sel:userArn:CreateUserProfile', createUserProfile_userArn - The Amazon Resource Name (ARN) of the user in IAM.

$sel:displayName:CreateUserProfile', createUserProfile_displayName - The name that will be displayed as the friendly name for the user in AWS CodeStar.

$sel:emailAddress:CreateUserProfile', createUserProfile_emailAddress - The email address that will be displayed as part of the user's profile in AWS CodeStar.

Request Lenses

createUserProfile_sshPublicKey :: Lens' CreateUserProfile (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.

createUserProfile_userArn :: Lens' CreateUserProfile Text Source #

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

createUserProfile_displayName :: Lens' CreateUserProfile Text Source #

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

createUserProfile_emailAddress :: Lens' CreateUserProfile Text Source #

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

Destructuring the Response

data CreateUserProfileResponse Source #

See: newCreateUserProfileResponse smart constructor.

Constructors

CreateUserProfileResponse'

Fields

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

Instances

Instances details

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

newCreateUserProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserProfileResponse'`
-> Text	`$sel:userArn:CreateUserProfile'`
-> CreateUserProfileResponse

Create a value of CreateUserProfileResponse 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:lastModifiedTimestamp:CreateUserProfileResponse', createUserProfileResponse_lastModifiedTimestamp - The date the user profile was last modified, in timestamp format.

$sel:sshPublicKey:CreateUserProfile', createUserProfileResponse_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:emailAddress:CreateUserProfile', createUserProfileResponse_emailAddress - The email address that is displayed as part of the user's profile in AWS CodeStar.

$sel:displayName:CreateUserProfile', createUserProfileResponse_displayName - The name that is displayed as the friendly name for the user in AWS CodeStar.

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

$sel:httpStatus:CreateUserProfileResponse', createUserProfileResponse_httpStatus - The response's http status code.

$sel:userArn:CreateUserProfile', createUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user in IAM.

Response Lenses

createUserProfileResponse_lastModifiedTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime) Source #

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

createUserProfileResponse_sshPublicKey :: Lens' CreateUserProfileResponse (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.

createUserProfileResponse_emailAddress :: Lens' CreateUserProfileResponse (Maybe Text) Source #

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

createUserProfileResponse_displayName :: Lens' CreateUserProfileResponse (Maybe Text) Source #

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

createUserProfileResponse_createdTimestamp :: Lens' CreateUserProfileResponse (Maybe UTCTime) Source #

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

createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int Source #

The response's http status code.

createUserProfileResponse_userArn :: Lens' CreateUserProfileResponse Text Source #

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