sagemaker_create_user_profile: Creates a user profile

View source: R/sagemaker_operations.R

sagemaker_create_user_profileR Documentation

Creates a user profile

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.

See https://www.paws-r-sdk.com/docs/sagemaker_create_user_profile/ for full documentation.

Usage

sagemaker_create_user_profile(
  DomainId,
  UserProfileName,
  SingleSignOnUserIdentifier = NULL,
  SingleSignOnUserValue = NULL,
  Tags = NULL,
  UserSettings = NULL
)

Arguments

DomainId

[required] The ID of the associated Domain.

UserProfileName

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

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.

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.

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.

UserSettings

A collection of settings.


paws.machine.learning documentation built on Sept. 12, 2023, 1:14 a.m.