DescribeUserProfile - Amazon SageMaker Service

DescribeUserProfile

Describes the user profile.

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.

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

Required: Yes

UserProfileName

The user profile name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

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": { "ExecutionRole": "string", "JupyterServerAppSettings": { "DefaultResourceSpec": { "EnvironmentArn": "string", "InstanceType": "string" } }, "KernelGatewayAppSettings": { "DefaultResourceSpec": { "EnvironmentArn": "string", "InstanceType": "string" } }, "SecurityGroups": [ "string" ], "SharingSettings": { "NotebookOutputOption": "string", "S3KmsKeyId": "string", "S3OutputPath": "string" }, "TensorBoardAppSettings": { "DefaultResourceSpec": { "EnvironmentArn": "string", "InstanceType": "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.

CreationTime

The creation time.

Type: Timestamp

DomainId

The domain ID.

Type: String

Length Constraints: Maximum length of 63.

FailureReason

The failure reason.

Type: String

Length Constraints: Maximum length of 1024.

HomeEfsFileSystemUid

The homa Amazon Elastic File System (EFS) Uid.

Type: String

Length Constraints: Maximum length of 10.

Pattern: \d+

LastModifiedTime

The last modified time.

Type: Timestamp

SingleSignOnUserIdentifier

The SSO user identifier.

Type: String

Pattern: UserName

SingleSignOnUserValue

The SSO user value.

Type: String

Length Constraints: Maximum length of 256.

Status

The status.

Type: String

Valid Values: Deleting | Failed | InService | Pending

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/.*

UserProfileName

The user profile name.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

UserSettings

A collection of settings.

Type: UserSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

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: