libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.CreateUserProfile

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 SSO, 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

Creating a Request

data CreateUserProfile Source #

See: newCreateUserProfile smart constructor.

Constructors

CreateUserProfile' 

Fields

  • userSettings :: Maybe UserSettings

    A collection of settings.

  • singleSignOnUserValue :: Maybe Text

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

  • 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 SSO, this field is required. If the Domain's AuthMode is not SSO, 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.

  • domainId :: Text

    The ID of the associated Domain.

  • userProfileName :: Text

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

Instances

Instances details
Eq CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Read CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Show CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Generic CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Associated Types

type Rep CreateUserProfile :: Type -> Type #

NFData CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Methods

rnf :: CreateUserProfile -> () #

Hashable CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

ToJSON CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

AWSRequest CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Associated Types

type AWSResponse CreateUserProfile #

ToHeaders CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

ToPath CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

ToQuery CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

type Rep CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

type Rep CreateUserProfile = D1 ('MetaData "CreateUserProfile" "Amazonka.SageMaker.CreateUserProfile" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateUserProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserSettings)) :*: (S1 ('MetaSel ('Just "singleSignOnUserValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "singleSignOnUserIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateUserProfile Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

newCreateUserProfile Source #

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:userSettings:CreateUserProfile', createUserProfile_userSettings - A collection of settings.

$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 SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.

$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 SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.

$sel:tags: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:domainId:CreateUserProfile', createUserProfile_domainId - The ID of the associated Domain.

$sel:userProfileName:CreateUserProfile', createUserProfile_userProfileName - A name for the UserProfile. This value is not case sensitive.

Request Lenses

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 SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.

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 SSO, this field is required. If the Domain's AuthMode is not SSO, 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_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

Instances

Instances details
Eq CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Read CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Show CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Generic CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

Associated Types

type Rep CreateUserProfileResponse :: Type -> Type #

NFData CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

type Rep CreateUserProfileResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateUserProfile

type Rep CreateUserProfileResponse = D1 ('MetaData "CreateUserProfileResponse" "Amazonka.SageMaker.CreateUserProfile" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" '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 #

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:userProfileArn:CreateUserProfileResponse', createUserProfileResponse_userProfileArn - The user profile Amazon Resource Name (ARN).

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

Response Lenses