DescribeUserProfile - Amazon SageMaker (original) (raw)
Describes a user profile. For more information, see CreateUserProfile.
Request Syntax
{
"DomainId": "string",
"UserProfileName": "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.
The domain ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: d-(-*[a-z0-9]){1,61}
Required: Yes
The user profile name. This value is not case sensitive.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
Required: Yes
Response Syntax
{
"CreationTime": number,
"DomainId": "string",
"FailureReason": "string",
"HomeEfsFileSystemUid": "string",
"LastModifiedTime": number,
"SingleSignOnUserIdentifier": "string",
"SingleSignOnUserValue": "string",
"Status": "string",
"UserProfileArn": "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",
"TrainingPlanArn": "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",
"TrainingPlanArn": "string"
},
"EmrSettings": {
"AssumableRoleArns": [ "string" ],
"ExecutionRoleArns": [ "string" ]
},
"LifecycleConfigArns": [ "string" ]
},
"JupyterServerAppSettings": {
"CodeRepositories": [
{
"RepositoryUrl": "string"
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string",
"TrainingPlanArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"KernelGatewayAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string",
"TrainingPlanArn": "string"
},
"LifecycleConfigArns": [ "string" ]
},
"RSessionAppSettings": {
"CustomImages": [
{
"AppImageConfigName": "string",
"ImageName": "string",
"ImageVersionNumber": number
}
],
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string",
"TrainingPlanArn": "string"
}
},
"RStudioServerProAppSettings": {
"AccessStatus": "string",
"UserGroup": "string"
},
"SecurityGroups": [ "string" ],
"SharingSettings": {
"NotebookOutputOption": "string",
"S3KmsKeyId": "string",
"S3OutputPath": "string"
},
"SpaceStorageSettings": {
"DefaultEbsStorageSettings": {
"DefaultEbsVolumeSizeInGb": number,
"MaximumEbsVolumeSizeInGb": number
}
},
"StudioWebPortal": "string",
"StudioWebPortalSettings": {
"ExecutionRoleSessionNameMode": "string",
"HiddenAppTypes": [ "string" ],
"HiddenInstanceTypes": [ "string" ],
"HiddenMlTools": [ "string" ],
"HiddenSageMakerImageVersionAliases": [
{
"SageMakerImageName": "string",
"VersionAliases": [ "string" ]
}
]
},
"TensorBoardAppSettings": {
"DefaultResourceSpec": {
"InstanceType": "string",
"LifecycleConfigArn": "string",
"SageMakerImageArn": "string",
"SageMakerImageVersionAlias": "string",
"SageMakerImageVersionArn": "string",
"TrainingPlanArn": "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.
The creation time.
Type: Timestamp
The ID of the domain that contains the profile.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: d-(-*[a-z0-9]){1,61}
The failure reason.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
The ID of the user's profile in the Amazon Elastic File System volume.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: \d+
The last modified time.
Type: Timestamp
The IAM Identity Center user identifier.
Type: String
Pattern: UserName
The IAM Identity Center user value.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
The status.
Type: String
Valid Values: Deleting | Failed | InService | Pending | Updating | Update_Failed | Delete_Failed
The user profile Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:user-profile/.*
The user profile name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
A collection of settings.
Type: UserSettings object
Errors
For information about the errors that are common to all actions, see Common Error Types.
ResourceLimitExceeded
You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400
ResourceNotFound
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: