user_profile

Gets an individual user_profile resource

Overview

Name	user_profile
Type	Resource
Description	user_profile
Id	awscc.sagemaker.user_profile

Fields

Name	Datatype	Description
user_profile_arn	string	The user profile Amazon Resource Name (ARN).
domain_id	string	The ID of the associated Domain.
single_sign_on_user_identifier	string	A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
single_sign_on_user_value	string	The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
user_profile_name	string	A name for the UserProfile.
user_settings	object	A collection of settings.
tags	array	A list of tags to apply to the user profile.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
user_profile_arn,
domain_id,
single_sign_on_user_identifier,
single_sign_on_user_value,
user_profile_name,
user_settings,
tags
FROM awscc.sagemaker.user_profile
WHERE data__Identifier = '<UserProfileName>|<DomainId>';

Permissions

To operate on the user_profile resource, the following permissions are required:

Read

sagemaker:DescribeUserProfile

Update

sagemaker:UpdateUserProfile,
sagemaker:DescribeUserProfile,
sagemaker:DescribeImage,
sagemaker:DescribeImageVersion,
iam:PassRole

Delete

sagemaker:DeleteUserProfile,
sagemaker:DescribeUserProfile