SageMaker / Client / describe_user_profile
describe_user_profile#
- SageMaker.Client.describe_user_profile(**kwargs)#
Describes a user profile. For more information, see
CreateUserProfile
.See also: AWS API Documentation
Request Syntax
response = client.describe_user_profile( DomainId='string', UserProfileName='string' )
- Parameters:
DomainId (string) –
[REQUIRED]
The domain ID.
UserProfileName (string) –
[REQUIRED]
The user profile name. This value is not case sensitive.
- Return type:
dict
- Returns:
Response Syntax
{ 'DomainId': 'string', 'UserProfileArn': 'string', 'UserProfileName': 'string', 'HomeEfsFileSystemUid': 'string', 'Status': 'Deleting'|'Failed'|'InService'|'Pending'|'Updating'|'Update_Failed'|'Delete_Failed', 'LastModifiedTime': datetime(2015, 1, 1), 'CreationTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'SingleSignOnUserIdentifier': 'string', 'SingleSignOnUserValue': 'string', 'UserSettings': { 'ExecutionRole': 'string', 'SecurityGroups': [ 'string', ], 'SharingSettings': { 'NotebookOutputOption': 'Allowed'|'Disabled', 'S3OutputPath': 'string', 'S3KmsKeyId': 'string' }, 'JupyterServerAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge', 'LifecycleConfigArn': 'string' }, 'LifecycleConfigArns': [ 'string', ], 'CodeRepositories': [ { 'RepositoryUrl': 'string' }, ] }, 'KernelGatewayAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ], 'LifecycleConfigArns': [ 'string', ] }, 'TensorBoardAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge', 'LifecycleConfigArn': 'string' } }, 'RStudioServerProAppSettings': { 'AccessStatus': 'ENABLED'|'DISABLED', 'UserGroup': 'R_STUDIO_ADMIN'|'R_STUDIO_USER' }, 'RSessionAppSettings': { 'DefaultResourceSpec': { 'SageMakerImageArn': 'string', 'SageMakerImageVersionArn': 'string', 'InstanceType': 'system'|'ml.t3.micro'|'ml.t3.small'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.8xlarge'|'ml.m5d.12xlarge'|'ml.m5d.16xlarge'|'ml.m5d.24xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.p3dn.24xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.8xlarge'|'ml.r5.12xlarge'|'ml.r5.16xlarge'|'ml.r5.24xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.16xlarge'|'ml.g5.12xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.geospatial.interactive'|'ml.p4d.24xlarge'|'ml.p4de.24xlarge', 'LifecycleConfigArn': 'string' }, 'CustomImages': [ { 'ImageName': 'string', 'ImageVersionNumber': 123, 'AppImageConfigName': 'string' }, ] }, 'CanvasAppSettings': { 'TimeSeriesForecastingSettings': { 'Status': 'ENABLED'|'DISABLED', 'AmazonForecastRoleArn': 'string' }, 'ModelRegisterSettings': { 'Status': 'ENABLED'|'DISABLED', 'CrossAccountModelRegisterRoleArn': 'string' }, 'WorkspaceSettings': { 'S3ArtifactPath': 'string', 'S3KmsKeyId': 'string' } } } }
Response Structure
(dict) –
DomainId (string) –
The ID of the domain that contains the profile.
UserProfileArn (string) –
The user profile Amazon Resource Name (ARN).
UserProfileName (string) –
The user profile name.
HomeEfsFileSystemUid (string) –
The ID of the user’s profile in the Amazon Elastic File System (EFS) volume.
Status (string) –
The status.
LastModifiedTime (datetime) –
The last modified time.
CreationTime (datetime) –
The creation time.
FailureReason (string) –
The failure reason.
SingleSignOnUserIdentifier (string) –
The IAM Identity Center user identifier.
SingleSignOnUserValue (string) –
The IAM Identity Center user value.
UserSettings (dict) –
A collection of settings.
ExecutionRole (string) –
The execution role for the user.
SecurityGroups (list) –
The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.
Optional when the
CreateDomain.AppNetworkAccessType
parameter is set toPublicInternetOnly
.Required when the
CreateDomain.AppNetworkAccessType
parameter is set toVpcOnly
, unless specified as part of theDefaultUserSettings
for the domain.Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
(string) –
SharingSettings (dict) –
Specifies options for sharing SageMaker Studio notebooks.
NotebookOutputOption (string) –
Whether to include the notebook cell output when sharing the notebook. The default is
Disabled
.S3OutputPath (string) –
When
NotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots.S3KmsKeyId (string) –
When
NotebookOutputOption
isAllowed
, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
JupyterServerAppSettings (dict) –
The Jupyter server’s app settings.
DefaultResourceSpec (dict) –
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the
LifecycleConfigArns
parameter, then this parameter is also required.SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
system
value.For KernelGateway apps, the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
LifecycleConfigArns (list) –
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the
DefaultResourceSpec
parameter is also required.Note
To remove a Lifecycle Config, you must set
LifecycleConfigArns
to an empty list.(string) –
CodeRepositories (list) –
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.
(dict) –
A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
RepositoryUrl (string) –
The URL of the Git repository.
KernelGatewayAppSettings (dict) –
The kernel gateway app settings.
DefaultResourceSpec (dict) –
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
Note
The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
system
value.For KernelGateway apps, the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
CustomImages (list) –
A list of custom SageMaker images that are configured to run as a KernelGateway app.
(dict) –
A custom SageMaker image. For more information, see Bring your own SageMaker image.
ImageName (string) –
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) –
The version number of the CustomImage.
AppImageConfigName (string) –
The name of the AppImageConfig.
LifecycleConfigArns (list) –
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
Note
To remove a Lifecycle Config, you must set
LifecycleConfigArns
to an empty list.(string) –
TensorBoardAppSettings (dict) –
The TensorBoard app settings.
DefaultResourceSpec (dict) –
The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
system
value.For KernelGateway apps, the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
RStudioServerProAppSettings (dict) –
A collection of settings that configure user interaction with the
RStudioServerPro
app.AccessStatus (string) –
Indicates whether the current user has access to the
RStudioServerPro
app.UserGroup (string) –
The level of permissions that the user has within the
RStudioServerPro
app. This value defaults to User. The Admin value allows the user access to the RStudio Administrative Dashboard.
RSessionAppSettings (dict) –
A collection of settings that configure the
RSessionGateway
app.DefaultResourceSpec (dict) –
Specifies the ARN’s of a SageMaker image and SageMaker image version, and the instance type that the version runs on.
SageMakerImageArn (string) –
The ARN of the SageMaker image that the image version belongs to.
SageMakerImageVersionArn (string) –
The ARN of the image version created on the instance.
InstanceType (string) –
The instance type that the image version runs on.
Note
JupyterServer apps only support the
system
value.For KernelGateway apps, the
system
value is translated toml.t3.medium
. KernelGateway apps also support all other values for available instance types.LifecycleConfigArn (string) –
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
CustomImages (list) –
A list of custom SageMaker images that are configured to run as a RSession app.
(dict) –
A custom SageMaker image. For more information, see Bring your own SageMaker image.
ImageName (string) –
The name of the CustomImage. Must be unique to your account.
ImageVersionNumber (integer) –
The version number of the CustomImage.
AppImageConfigName (string) –
The name of the AppImageConfig.
CanvasAppSettings (dict) –
The Canvas app settings.
TimeSeriesForecastingSettings (dict) –
Time series forecast settings for the Canvas application.
Status (string) –
Describes whether time series forecasting is enabled or disabled in the Canvas application.
AmazonForecastRoleArn (string) –
The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the
UserProfile
that launches the Canvas application. If an execution role is not specified in theUserProfile
, Canvas uses the execution role specified in the Domain that owns theUserProfile
. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached andforecast.amazonaws.com
added in the trust relationship as a service principal.
ModelRegisterSettings (dict) –
The model registry settings for the SageMaker Canvas application.
Status (string) –
Describes whether the integration to the model registry is enabled or disabled in the Canvas application.
CrossAccountModelRegisterRoleArn (string) –
The Amazon Resource Name (ARN) of the SageMaker model registry account. Required only to register model versions created by a different SageMaker Canvas Amazon Web Services account than the Amazon Web Services account in which SageMaker model registry is set up.
WorkspaceSettings (dict) –
The workspace settings for the SageMaker Canvas application.
S3ArtifactPath (string) –
The Amazon S3 bucket used to store artifacts generated by Canvas. Updating the Amazon S3 location impacts existing configuration settings, and Canvas users no longer have access to their artifacts. Canvas users must log out and log back in to apply the new location.
S3KmsKeyId (string) –
The Amazon Web Services Key Management Service (KMS) encryption key ID that is used to encrypt artifacts generated by Canvas in the Amazon S3 bucket.
Exceptions
SageMaker.Client.exceptions.ResourceNotFound