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.DescribeUserProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a user in AWS CodeStar and the user attributes across all projects.

Synopsis

data DescribeUserProfile = DescribeUserProfile' {
- userArn :: Text
}
newDescribeUserProfile :: Text -> DescribeUserProfile
describeUserProfile_userArn :: Lens' DescribeUserProfile Text
data DescribeUserProfileResponse = DescribeUserProfileResponse' {
- sshPublicKey :: Maybe Text
- emailAddress :: Maybe (Sensitive Text)
- displayName :: Maybe (Sensitive Text)
- httpStatus :: Int
- userArn :: Text
- createdTimestamp :: POSIX
- lastModifiedTimestamp :: POSIX
}
newDescribeUserProfileResponse :: Int -> Text -> UTCTime -> UTCTime -> DescribeUserProfileResponse
describeUserProfileResponse_sshPublicKey :: Lens' DescribeUserProfileResponse (Maybe Text)
describeUserProfileResponse_emailAddress :: Lens' DescribeUserProfileResponse (Maybe Text)
describeUserProfileResponse_displayName :: Lens' DescribeUserProfileResponse (Maybe Text)
describeUserProfileResponse_httpStatus :: Lens' DescribeUserProfileResponse Int
describeUserProfileResponse_userArn :: Lens' DescribeUserProfileResponse Text
describeUserProfileResponse_createdTimestamp :: Lens' DescribeUserProfileResponse UTCTime
describeUserProfileResponse_lastModifiedTimestamp :: Lens' DescribeUserProfileResponse UTCTime

Creating a Request

data DescribeUserProfile Source #

See: newDescribeUserProfile smart constructor.

Constructors

DescribeUserProfile'
Fields userArn :: Text The Amazon Resource Name (ARN) of the user.

Instances

Instances details

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

newDescribeUserProfile Source #

Arguments

:: Text	`$sel:userArn:DescribeUserProfile'`
-> DescribeUserProfile

Create a value of DescribeUserProfile 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:userArn:DescribeUserProfile', describeUserProfile_userArn - The Amazon Resource Name (ARN) of the user.

Request Lenses

describeUserProfile_userArn :: Lens' DescribeUserProfile Text Source #

The Amazon Resource Name (ARN) of the user.

Destructuring the Response

data DescribeUserProfileResponse Source #

See: newDescribeUserProfileResponse smart constructor.

Constructors

DescribeUserProfileResponse'

Fields

sshPublicKey :: Maybe Text
The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.
emailAddress :: Maybe (Sensitive Text)
The email address for the user. Optional.
displayName :: Maybe (Sensitive Text)
The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").
httpStatus :: Int
The response's http status code.
userArn :: Text
The Amazon Resource Name (ARN) of the user.
createdTimestamp :: POSIX
The date and time when the user profile was created in AWS CodeStar, in timestamp format.
lastModifiedTimestamp :: POSIX
The date and time when the user profile was last modified, in timestamp format.

Instances

Instances details

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

newDescribeUserProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserProfileResponse'`
-> Text	`$sel:userArn:DescribeUserProfile'`
-> UTCTime	`$sel:createdTimestamp:DescribeUserProfileResponse'`
-> UTCTime	`$sel:lastModifiedTimestamp:DescribeUserProfileResponse'`
-> DescribeUserProfileResponse

Create a value of DescribeUserProfileResponse 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:DescribeUserProfileResponse', describeUserProfileResponse_sshPublicKey - The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.

$sel:emailAddress:DescribeUserProfileResponse', describeUserProfileResponse_emailAddress - The email address for the user. Optional.

$sel:displayName:DescribeUserProfileResponse', describeUserProfileResponse_displayName - The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

$sel:httpStatus:DescribeUserProfileResponse', describeUserProfileResponse_httpStatus - The response's http status code.

$sel:userArn:DescribeUserProfile', describeUserProfileResponse_userArn - The Amazon Resource Name (ARN) of the user.

$sel:createdTimestamp:DescribeUserProfileResponse', describeUserProfileResponse_createdTimestamp - The date and time when the user profile was created in AWS CodeStar, in timestamp format.

$sel:lastModifiedTimestamp:DescribeUserProfileResponse', describeUserProfileResponse_lastModifiedTimestamp - The date and time when the user profile was last modified, in timestamp format.

Response Lenses

describeUserProfileResponse_sshPublicKey :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.

describeUserProfileResponse_emailAddress :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The email address for the user. Optional.

describeUserProfileResponse_displayName :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

describeUserProfileResponse_httpStatus :: Lens' DescribeUserProfileResponse Int Source #

The response's http status code.

describeUserProfileResponse_userArn :: Lens' DescribeUserProfileResponse Text Source #

The Amazon Resource Name (ARN) of the user.

describeUserProfileResponse_createdTimestamp :: Lens' DescribeUserProfileResponse UTCTime Source #

The date and time when the user profile was created in AWS CodeStar, in timestamp format.

describeUserProfileResponse_lastModifiedTimestamp :: Lens' DescribeUserProfileResponse UTCTime Source #

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