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.SageMaker.CreateUserProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

Synopsis

data CreateUserProfile = CreateUserProfile' {
- singleSignOnUserIdentifier :: Maybe Text
- singleSignOnUserValue :: Maybe Text
- tags :: Maybe [Tag]
- userSettings :: Maybe UserSettings
- domainId :: Text
- userProfileName :: Text
}
newCreateUserProfile :: Text -> Text -> CreateUserProfile
createUserProfile_singleSignOnUserIdentifier :: Lens' CreateUserProfile (Maybe Text)
createUserProfile_singleSignOnUserValue :: Lens' CreateUserProfile (Maybe Text)
createUserProfile_tags :: Lens' CreateUserProfile (Maybe [Tag])
createUserProfile_userSettings :: Lens' CreateUserProfile (Maybe UserSettings)
createUserProfile_domainId :: Lens' CreateUserProfile Text
createUserProfile_userProfileName :: Lens' CreateUserProfile Text
data CreateUserProfileResponse = CreateUserProfileResponse' {
- userProfileArn :: Maybe Text
- httpStatus :: Int
}
newCreateUserProfileResponse :: Int -> CreateUserProfileResponse
createUserProfileResponse_userProfileArn :: Lens' CreateUserProfileResponse (Maybe Text)
createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int

Creating a Request

data CreateUserProfile Source #

See: newCreateUserProfile smart constructor.

Constructors

CreateUserProfile'

Fields

singleSignOnUserIdentifier :: Maybe Text
A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
singleSignOnUserValue :: Maybe Text
The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
tags :: Maybe [Tag]
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.
userSettings :: Maybe UserSettings
A collection of settings.
domainId :: Text
The ID of the associated Domain.
userProfileName :: Text
A name for the UserProfile. This value is not case sensitive.

Instances

Instances details

ToJSON CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods toJSON :: CreateUserProfile -> Value # toEncoding :: CreateUserProfile -> Encoding # toJSONList :: [CreateUserProfile] -> Value # toEncodingList :: [CreateUserProfile] -> Encoding #
ToHeaders CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods toHeaders :: CreateUserProfile -> [Header] #
ToPath CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods toPath :: CreateUserProfile -> ByteString #
ToQuery CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods toQuery :: CreateUserProfile -> QueryString #
AWSRequest CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Associated Types type AWSResponse CreateUserProfile # Methods request :: (Service -> Service) -> CreateUserProfile -> Request CreateUserProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUserProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUserProfile))) #
Generic CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Associated Types type Rep CreateUserProfile :: Type -> Type # Methods from :: CreateUserProfile -> Rep CreateUserProfile x # to :: Rep CreateUserProfile x -> CreateUserProfile #
Read CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods readsPrec :: Int -> ReadS CreateUserProfile # readList :: ReadS [CreateUserProfile] # readPrec :: ReadPrec CreateUserProfile # readListPrec :: ReadPrec [CreateUserProfile] #
Show CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods showsPrec :: Int -> CreateUserProfile -> ShowS # show :: CreateUserProfile -> String # showList :: [CreateUserProfile] -> ShowS #
NFData CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods rnf :: CreateUserProfile -> () #
Eq CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods (==) :: CreateUserProfile -> CreateUserProfile -> Bool # (/=) :: CreateUserProfile -> CreateUserProfile -> Bool #
Hashable CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods hashWithSalt :: Int -> CreateUserProfile -> Int # hash :: CreateUserProfile -> Int #
type AWSResponse CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile type AWSResponse CreateUserProfile = CreateUserProfileResponse
type Rep CreateUserProfile Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile type Rep CreateUserProfile = D1 ('MetaData "CreateUserProfile" "Amazonka.SageMaker.CreateUserProfile" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateUserProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "singleSignOnUserIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "singleSignOnUserValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (S1 ('MetaSel ('Just "userSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSettings)) :: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateUserProfile Source #

Arguments

:: Text	`CreateUserProfile`
-> Text	`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:singleSignOnUserIdentifier:CreateUserProfile', createUserProfile_singleSignOnUserIdentifier - A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

$sel:singleSignOnUserValue:CreateUserProfile', createUserProfile_singleSignOnUserValue - The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

CreateUserProfile, createUserProfile_tags - Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

$sel:userSettings:CreateUserProfile', createUserProfile_userSettings - A collection of settings.

CreateUserProfile, createUserProfile_domainId - The ID of the associated Domain.

CreateUserProfile, createUserProfile_userProfileName - A name for the UserProfile. This value is not case sensitive.

Request Lenses

createUserProfile_singleSignOnUserIdentifier :: Lens' CreateUserProfile (Maybe Text) Source #

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

createUserProfile_singleSignOnUserValue :: Lens' CreateUserProfile (Maybe Text) Source #

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

createUserProfile_tags :: Lens' CreateUserProfile (Maybe [Tag]) Source #

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

createUserProfile_userSettings :: Lens' CreateUserProfile (Maybe UserSettings) Source #

A collection of settings.

createUserProfile_domainId :: Lens' CreateUserProfile Text Source #

The ID of the associated Domain.

createUserProfile_userProfileName :: Lens' CreateUserProfile Text Source #

A name for the UserProfile. This value is not case sensitive.

Destructuring the Response

data CreateUserProfileResponse Source #

See: newCreateUserProfileResponse smart constructor.

Constructors

CreateUserProfileResponse'
Fields userProfileArn :: Maybe Text The user profile Amazon Resource Name (ARN). httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Associated Types type Rep CreateUserProfileResponse :: Type -> Type # Methods from :: CreateUserProfileResponse -> Rep CreateUserProfileResponse x # to :: Rep CreateUserProfileResponse x -> CreateUserProfileResponse #
Read CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods readsPrec :: Int -> ReadS CreateUserProfileResponse # readList :: ReadS [CreateUserProfileResponse] # readPrec :: ReadPrec CreateUserProfileResponse # readListPrec :: ReadPrec [CreateUserProfileResponse] #
Show CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods showsPrec :: Int -> CreateUserProfileResponse -> ShowS # show :: CreateUserProfileResponse -> String # showList :: [CreateUserProfileResponse] -> ShowS #
NFData CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods rnf :: CreateUserProfileResponse -> () #
Eq CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile Methods (==) :: CreateUserProfileResponse -> CreateUserProfileResponse -> Bool # (/=) :: CreateUserProfileResponse -> CreateUserProfileResponse -> Bool #
type Rep CreateUserProfileResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateUserProfile type Rep CreateUserProfileResponse = D1 ('MetaData "CreateUserProfileResponse" "Amazonka.SageMaker.CreateUserProfile" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateUserProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserProfileResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserProfileResponse'`
-> 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:

CreateUserProfileResponse, createUserProfileResponse_userProfileArn - The user profile Amazon Resource Name (ARN).

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

Response Lenses

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

The user profile Amazon Resource Name (ARN).

createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int Source #

The response's http status code.