Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

describe-user-profile

Description

Describes the user profile.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-user-profile
--domain-id <value>
--user-profile-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-id (string)

The domain ID.

--user-profile-name (string)

The user profile name.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DomainId -> (string)

The domain ID.

UserProfileArn -> (string)

The user profile Amazon Resource Name (ARN).

UserProfileName -> (string)

The user profile name.

HomeEfsFileSystemUid -> (string)

The home Amazon Elastic File System (EFS) Uid.

Status -> (string)

The status.

LastModifiedTime -> (timestamp)

The last modified time.

CreationTime -> (timestamp)

The creation time.

FailureReason -> (string)

The failure reason.

SingleSignOnUserIdentifier -> (string)

The SSO user identifier.

SingleSignOnUserValue -> (string)

The SSO user value.

UserSettings -> (structure)

A collection of settings.

ExecutionRole -> (string)

The execution role for the user.

SecurityGroups -> (list)

The security groups.

(string)

SharingSettings -> (structure)

The sharing settings.

NotebookOutputOption -> (string)

The notebook output option.

S3OutputPath -> (string)

The Amazon S3 output path.

S3KmsKeyId -> (string)

The AWS Key Management Service encryption key ID.

JupyterServerAppSettings -> (structure)

The Jupyter server's app settings.

DefaultResourceSpec -> (structure)

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

SageMakerImageArn -> (string)

The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

InstanceType -> (string)

The instance type.

KernelGatewayAppSettings -> (structure)

The kernel gateway app settings.

DefaultResourceSpec -> (structure)

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

SageMakerImageArn -> (string)

The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

InstanceType -> (string)

The instance type.

TensorBoardAppSettings -> (structure)

The TensorBoard app settings.

DefaultResourceSpec -> (structure)

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

SageMakerImageArn -> (string)

The Amazon Resource Name (ARN) of the SageMaker image created on the instance.

InstanceType -> (string)

The instance type.