user_profiles_list_only

Lists user_profiles in a region or regions, for all properties use user_profiles

Overview

Name	user_profiles_list_only
Type	Resource
Description	Resource Type definition for AWS::SageMaker::UserProfile
Id	aws.sagemaker.user_profiles_list_only

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

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all user_profiles in a region.

SELECT
region,
user_profile_name,
domain_id
FROM aws.sagemaker.user_profiles_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the user_profiles_list_only resource, see user_profiles