v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Describes a user profile. For more information, see <code>CreateUserProfile</code>.

post/#X-Amz-Target=SageMaker.DescribeUserProfile

Headers

X-Amz-Target'SageMaker.DescribeUserProfile' required

Request body

DomainIdstring required

The domain ID.

UserProfileNamestring required

The user profile name. This value is not case sensitive.

Response

Success

DomainIdstring

The ID of the domain that contains the profile.

UserProfileArnstring

The user profile Amazon Resource Name (ARN).

UserProfileNamestring

The user profile name.

HomeEfsFileSystemUidstring

The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

Status'Deleting' | 'Failed' | 'InService' | 'Pending' | 'Updating' | 'Update_Failed' | 'Delete_Failed'

The status.

LastModifiedTimestring date-time

The last modified time.

CreationTimestring date-time

The creation time.

FailureReasonstring

The failure reason.

SingleSignOnUserIdentifierstring

The IAM Identity Center user identifier.

SingleSignOnUserValuestring

The IAM Identity Center user value.