CreateUserProfile
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 a domain. 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 home directory.
Request Syntax
{
"DomainId": "string",
"SingleSignOnUserIdentifier": "string",
"SingleSignOnUserValue": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserProfileName": "string",
"UserSettings": {
"AutoMountHomeEFS": "string",
"CanvasAppSettings": {
"DirectDeploySettings": {
"Status": "string"
},
"EmrServerlessSettings": {
"ExecutionRoleArn": "string",
"Status": "string"
},
"GenerativeAiSettings": {
"AmazonBedrockRoleArn": "string"
},
"IdentityProviderOAuthSettings": [
{
"DataSourceName": "string",
"SecretArn": "string",
"Status": "string"
}
],
"KendraSettings": {
"Status": "string"
},
"ModelRegisterSettings": {
"CrossAccountModelRegisterRoleArn": "string",
"Status": "string"
},
"TimeSeriesForecastingSettings": {
"AmazonForecastRoleArn": "string",
"Status": "string"
},
"WorkspaceSettings": {
"S3ArtifactPath": "string",
"S3KmsKeyId": "string"
}
},
"CodeEditorAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number,
"LifecycleManagement": "string",
"MaxIdleTimeoutInMinutes": number,
"MinIdleTimeoutInMinutes": number
}
},
"BuiltInLifecycleConfigArn": "string",
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"CustomFileSystemConfigs": [
{ ... }
],
"CustomPosixUserConfig": {
"Gid": number,
"Uid": number
},
"DefaultLandingUri": "string",
"ExecutionRole": "string",
"JupyterLabAppSettings": {
"AppLifecycleManagement": {
"IdleSettings": {
"IdleTimeoutInMinutes": number,
"LifecycleManagement": "string",
"MaxIdleTimeoutInMinutes": number,
"MinIdleTimeoutInMinutes": number
}
},
"BuiltInLifecycleConfigArn": "string",
"CodeRepositories": [
{
"RepositoryUrl": "string"
}
],
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"EmrSettings": {
"AssumableRoleArns": [ "string" ],
"ExecutionRoleArns": [ "string" ]
},
"LifecycleConfigArns": [ "string" ]
},
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string"
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"RSessionAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
}
},
"RStudioServerProAppSettings": {
"AccessStatus": "string",
"UserGroup": "string"
},
"SecurityGroups": [ "string" ],
"SharingSettings": {
"NotebookOutputOption": "string",
"S3KmsKeyId": "string",
"S3OutputPath": "string"
},
"SpaceStorageSettings": {
"DefaultEbsStorageSettings": {
"DefaultEbsVolumeSizeInGb": number,
"MaximumEbsVolumeSizeInGb": number
}
},
"StudioWebPortal": "string",
"StudioWebPortalSettings": {
"HiddenAppTypes": [ "string" ],
"HiddenInstanceTypes": [ "string" ],
"HiddenMlTools": [ "string" ],
"HiddenSageMakerImageVersionAliases": [
{
"SageMakerImageName": "string",
"VersionAliases": [ "string" ]
}
]
},
"TensorBoardAppSettings": {
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string"
}
}
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- DomainId
-
The ID of the associated Domain.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^d-(-*[a-z0-9]){1,61}Required: Yes
- 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.
Type: String
Pattern:
UserNameRequired: No
- SingleSignOnUserValue
-
The username of the associated AWS 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.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- 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.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- UserProfileName
-
A name for the UserProfile. This value is not case sensitive.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- UserSettings
-
A collection of settings.
Type: UserSettings object
Required: No
Response Syntax
{
"UserProfileArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserProfileArn
-
The user profile Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:user-profile/.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceLimitExceeded
-
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
