Skip to content

CreateUserProfileRequest

Source code in docs_src/capo_sagemaker/types/create_user_profile_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateUserProfileRequest(TypedDict, closed=True):
    domain_id: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>The ID of the associated Domain.</p>"""
    user_profile_name: NotRequired[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ]
    """<p>A name for the UserProfile. This value is not case sensitive.</p>"""
    single_sign_on_user_identifier: NotRequired[
        "capo_sagemaker.types.single_sign_on_user_identifier.SingleSignOnUserIdentifier"
    ]
    """<p>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. </p>"""
    single_sign_on_user_value: NotRequired["capo_sagemaker.types.string256.String256"]
    """<p>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. </p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</p> <p>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</p>"""
    user_settings: NotRequired["capo_sagemaker.types.user_settings.UserSettings"]
    """<p>A collection of settings.</p>"""

domain_id instance-attribute 

domain_id: NotRequired[DomainId]

The ID of the associated Domain.

single_sign_on_user_identifier instance-attribute 

single_sign_on_user_identifier: NotRequired[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.

single_sign_on_user_value instance-attribute 

single_sign_on_user_value: NotRequired[String256]

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 instance-attribute 

tags: NotRequired[TagList]

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.

user_profile_name instance-attribute 

user_profile_name: NotRequired[UserProfileName]

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

user_settings instance-attribute 

user_settings: NotRequired[UserSettings]

A collection of settings.