describe-user-profile
Описание
Описывает профиль пользователя. Дополнительная информация доступна по ссылке CreateUserProfile.
См. также: Документация API AWS
Синтаксис
describe-user-profile
--domain-id <value>
--user-profile-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--domain-id (строка)
--user-profile-name (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, указанные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос к API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. При указании значения output, проверяет входные данные команды и возвращает пример JSON-вывода для данной команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI и не гарантирует обратной совместимости в сгенерированном JSON-скелете.
Общие параметры
--debug (логическое значение)
Включить отладку логов.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию - 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию - 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
DomainId -> (строка)
UserProfileArn -> (строка)
UserProfileName -> (строка)
HomeEfsFileSystemUid -> (строка)
Status -> (строка)
LastModifiedTime -> (отметка времени)
CreationTime -> (отметка времени)
FailureReason -> (строка)
SingleSignOnUserIdentifier -> (строка)
SingleSignOnUserValue -> (строка)
UserSettings -> (структура)
Набор настроек.
ExecutionRole -> (строка)
Роль выполнения для пользователя.
SageMaker применяет эту настройку только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эту настройку к общим пространствам.
SecurityGroups -> (список)
Наборы правил безопасности для виртуальной частной сети Amazon (VPC), которую домен использует для связи.
Необязательно, когда параметр CreateDomain.AppNetworkAccessType установлен в значение PublicInternetOnly.
Требуется, когда параметр CreateDomain.AppNetworkAccessType установлен в значение VpcOnly, если не указан в рамках DefaultUserSettings для домена.
Amazon SageMaker AI добавляет правило безопасности для разрешения трафика NFS из Amazon SageMaker AI Studio. Поэтому количество наборов правил безопасности, которые вы можете указать, на единицу меньше максимального количества, показанного.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.
(строка)
SharingSettings -> (структура)
Определяет параметры для совместного использования блокнотов Amazon SageMaker AI Studio.
NotebookOutputOption -> (строка)
Disabled.S3OutputPath -> (строка)
NotebookOutputOption равно Allowed, используется Amazon S3-ведро для хранения снимков блокнотов, доступных для совместного использования.S3KmsKeyId -> (строка)
NotebookOutputOption равно Allowed, используется идентификатор ключа шифрования Amazon Web Services Key Management Service (KMS) для шифрования выходных данных ячеек блокнота в Amazon S3-ведре.JupyterServerAppSettings -> (структура)
Настройки приложения Jupyter Server.
DefaultResourceSpec -> (структура)
Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа SageMaker AI по умолчанию, используемого приложением JupyterServer. Если используется параметр LifecycleConfigArns, то этот параметр также необходим.
SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, используйте значение None.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором работает версия образа.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
LifecycleConfigArns -> (список)
Amazon Resource Name (ARN) конфигураций жизненного цикла, присоединённых к JupyterServerApp. Если вы используете этот параметр, то также необходим параметр DefaultResourceSpec.
Примечание
Для удаления конфигурации жизненного цикла необходимо установитьLifecycleConfigArns в пустой список.(строка)
CodeRepositories -> (список)
Список Git-репозиториев, которые SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.
(структура)
Git-репозиторий, который SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.
RepositoryUrl -> (строка)
KernelGatewayAppSettings -> (структура)
Настройки приложения Kernel Gateway.
DefaultResourceSpec -> (структура)
Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа SageMaker AI по умолчанию, используемого приложением KernelGateway.
Примечание
Интерфейс пользователя Amazon SageMaker AI Studio не использует значение типа экземпляра по умолчанию, заданное здесь. Тип экземпляра по умолчанию, заданный здесь, используется при создании приложений с помощью командной строки или CloudFormation, если значение параметра типа экземпляра не передано.SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, используйте значение None.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором работает версия образа.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
CustomImages -> (список)
Список пользовательских образов SageMaker AI, настроенных для запуска в качестве приложения KernelGateway.
Максимальное количество пользовательских образов:
- На уровне домена: 200
- На уровне пространства: 5
- На уровне профиля пользователя: 5
(структура)
Пользовательский образ SageMaker AI. Дополнительная информация в разделе Применение собственного образа SageMaker AI.
ImageName -> (строка)
ImageVersionNumber -> (целое число)
AppImageConfigName -> (строка)
LifecycleConfigArns -> (список)
Amazon Resource Name (ARN) конфигураций жизненного цикла, присоединённых к профилю пользователя или домену.
Примечание
Для удаления конфигурации жизненного цикла необходимо установитьLifecycleConfigArns в пустой список.(строка)
TensorBoardAppSettings -> (структура)
Настройки приложения TensorBoard.
DefaultResourceSpec -> (структура)
Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа SageMaker AI, созданного на экземпляре.
SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, используйте значение None.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором работает версия образа.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
RStudioServerProAppSettings -> (структура)
Набор настроек для конфигурации взаимодействия пользователей с приложением RStudioServerPro.
AccessStatus -> (строка)
RStudioServerPro.UserGroup -> (строка)
RStudioServerPro. По умолчанию это значение User. Значение Admin предоставляет пользователю доступ к панели управления администратором RStudio.RSessionAppSettings -> (структура)
Набор настроек для конфигурации приложения RSessionGateway.
DefaultResourceSpec -> (структура)
Указывает ARN образа SageMaker AI и версии образа SageMaker AI, а также тип экземпляра, на котором работает версия.
Примечание
Если переданы оба значенияSageMakerImageVersionArn и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, так как SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить заданное значение для SageMakerImageVersionArn, используйте значение None.SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, используйте значение None.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором работает версия образа.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
CustomImages -> (список)
Список пользовательских образов SageMaker AI, настроенных для запуска в качестве приложения RSession.
(структура)
Пользовательский образ SageMaker AI. Дополнительная информация в разделе Применение собственного образа SageMaker AI.
ImageName -> (строка)
ImageVersionNumber -> (целое число)
AppImageConfigName -> (строка)
CanvasAppSettings -> (структура)
Настройки приложения Canvas.
SageMaker применяет эти настройки только к частным пространствам, которые SageMaker создает для приложения Canvas.
TimeSeriesForecastingSettings -> (структура)
Настройки прогнозирования временных рядов для приложения SageMaker Canvas.
Status -> (строка)
AmazonForecastRoleArn -> (строка)
UserProfile, которая запускает приложение Canvas. Если роль выполнения не указана в UserProfile, Canvas использует роль выполнения, указанную в домене, который владеет UserProfile. Для разрешения прогнозирования временных рядов этой роли IAM необходимо добавить политику AmazonSageMakerCanvasForecastAccess и forecast.amazonaws.com в отношения доверия в качестве принципала-сервиса.ModelRegisterSettings -> (структура)
Настройки реестра моделей для приложения SageMaker Canvas.
Status -> (строка)
CrossAccountModelRegisterRoleArn -> (строка)
WorkspaceSettings -> (структура)
Настройки рабочего пространства для приложения SageMaker Canvas.
S3ArtifactPath -> (строка)
S3KmsKeyId -> (строка)
IdentityProviderOAuthSettings -> (список)
Настройки подключения к внешнему источнику данных с помощью OAuth.
(структура)
Настройка приложения Amazon SageMaker Canvas, где настраивается OAuth для подключения к внешнему источнику данных, такому как Snowflake.
DataSourceName -> (строка)
Status -> (строка)
SecretArn -> (строка)
DirectDeploySettings -> (структура)
Настройки развертывания моделей для приложения SageMaker Canvas.
Status -> (строка)
KendraSettings -> (структура)
Настройки для запросов документов.
Status -> (строка)
GenerativeAiSettings -> (структура)
Настройки генеративного ИИ для приложения SageMaker Canvas.
AmazonBedrockRoleArn -> (строка)
bedrock.amazonaws.com в качестве принципала-сервиса.EmrServerlessSettings -> (структура)
Настройки для запуска задач обработки данных Amazon EMR Serverless в SageMaker Canvas.
ExecutionRoleArn -> (строка)
Status -> (строка)
CodeEditorAppSettings -> (структура)
Настройки приложения Code Editor.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создает в домене. SageMaker не применяет эти настройки к общим пространствам.
DefaultResourceSpec -> (структура)
Указывает ARN изображений SageMaker AI и версий изображений SageMaker AI, а также тип экземпляра, на котором выполняется версия.
Примечание
Когда обаSageMakerImageVersionArn и SageMakerImageArn переданы, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, поскольку SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, передайте None в качестве значения.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором выполняется версия изображения.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
CustomImages -> (список)
Список пользовательских изображений SageMaker, настроенных для выполнения в качестве приложения Code Editor.
(структура)
Пользовательское изображение SageMaker AI. Дополнительные сведения см. в статье Применение собственного изображения SageMaker AI.
ImageName -> (строка)
ImageVersionNumber -> (целое число)
AppImageConfigName -> (строка)
LifecycleConfigArns -> (список)
Идентификатор ресурса Amazon Resource Name (ARN) конфигурации жизненного цикла приложения Code Editor.
(строка)
AppLifecycleManagement -> (структура)
Настройки, используемые для настройки и управления жизненным циклом приложений CodeEditor.
IdleSettings -> (структура)
Настройки, связанные с бездействием при выключении приложений Studio.
LifecycleManagement -> (строка)
IdleTimeoutInMinutes -> (целое число)
MinIdleTimeoutInMinutes -> (целое число)
MaxIdleTimeoutInMinutes -> (целое число)
BuiltInLifecycleConfigArn -> (строка)
JupyterLabAppSettings -> (структура)
Настройки приложения JupyterLab.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.
DefaultResourceSpec -> (структура)
Указывает ARN образа SageMaker AI и версии образа SageMaker AI, а также тип экземпляра, на котором работает версия.
Примечание
Когда передаются иSageMakerImageVersionArn, и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, поскольку SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.SageMakerImageArn -> (строка)
SageMakerImageVersionArn -> (строка)
SageMakerImageVersionArn, передайте None в качестве значения.SageMakerImageVersionAlias -> (строка)
InstanceType -> (строка)
Тип экземпляра, на котором работает версия образа.
Примечание
system.Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все остальные значения для доступных типов экземпляров.
LifecycleConfigArn -> (строка)
CustomImages -> (список)
Список пользовательских образов SageMaker, настроенных для работы в качестве приложения JupyterLab.
(структура)
Пользовательский образ SageMaker AI. Дополнительную информацию см. в разделе Bring your own SageMaker AI image.
ImageName -> (строка)
ImageVersionNumber -> (целое число)
AppImageConfigName -> (строка)
LifecycleConfigArns -> (список)
Amazon Resource Name (ARN) конфигураций жизненного цикла, присоединённых к профилю пользователя или домену. Чтобы удалить конфигурацию жизненного цикла, необходимо установить LifecycleConfigArns в пустой список.
(строка)
CodeRepositories -> (список)
Список Git-репозиториев, которые SageMaker автоматически отображает пользователям для клонирования в приложении JupyterLab.
(структура)
Git-репозиторий, который SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.
RepositoryUrl -> (строка)
AppLifecycleManagement -> (структура)
Указывает, активирован ли режим автоматической остановки для приложений JupyterLab.
IdleSettings -> (структура)
Настройки, связанные с автоматической остановкой приложений Studio.
LifecycleManagement -> (строка)
IdleTimeoutInMinutes -> (целое число)
MinIdleTimeoutInMinutes -> (целое число)
MaxIdleTimeoutInMinutes -> (целое число)
EmrSettings -> (структура)
Параметры конфигурации, которые указывают роли IAM, принимаемые ролью выполнения SageMaker (принимающие роли), и экземпляры кластеров или среды выполнения задач (роли выполнения или роли среды выполнения) для управления и доступа к ресурсам, необходимым для запуска кластеров Amazon EMR или приложений Amazon EMR Serverless.
AssumableRoleArns -> (список)
Массив Amazon Resource Names (ARN) ролей IAM, которые роль выполнения SageMaker может принять для выполнения операций или задач, связанных с кластерами Amazon EMR или приложениями Amazon EMR Serverless. Эти роли определяют разрешения и политики доступа, необходимые при выполнении операций, связанных с Amazon EMR, таких как перечисление, подключение или завершение кластеров Amazon EMR или приложений Amazon EMR Serverless. Как правило, они используются в сценариях доступа между учётными записями, когда ресурсы Amazon EMR (кластеры или приложения serverless) находятся в другой учётной записи Amazon Web Services, отличной от домена SageMaker.
(строка)
ExecutionRoleArns -> (список)
Массив Amazon Resource Names (ARN) ролей IAM, используемых экземплярами кластера Amazon EMR или средами выполнения задач для доступа к другим службам и ресурсам Amazon Web Services, необходимым во время выполнения ваших рабочих нагрузок Amazon EMR или Amazon EMR Serverless, таких как Amazon S3 для доступа к данным, Amazon CloudWatch для ведения журнала или другие службы Amazon Web Services, в зависимости от конкретных требований рабочей нагрузки.
(строка)
BuiltInLifecycleConfigArn -> (строка)
SpaceStorageSettings -> (структура)
Настройки хранения для пространства.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.
DefaultEbsStorageSettings -> (структура)
Настройки хранилища EBS по умолчанию для пространства.
DefaultEbsVolumeSizeInGb -> (целое число)
MaximumEbsVolumeSizeInGb -> (целое число)
DefaultLandingUri -> (строка)
Стандартный интерфейс, на который перенаправляется пользователь при доступе к домену. Поддерживаемые значения:
-
studio::: Указывает, что Studio является стандартным интерфейсом. Это значение может быть передано только в том случае, еслиStudioWebPortalустановлено наENABLED. -
app:JupyterServer:: Указывает, что Studio Classic является стандартным интерфейсом.
StudioWebPortal -> (строка)
DISABLED, пользователь не может получить доступ к Studio, даже если это стандартный интерфейс для домена.CustomPosixUserConfig -> (структура)
Подробная информация об идентификаторе POSIX, используемом для операций с файловой системой.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.
Uid -> (длинное целое число)
Gid -> (длинное целое число)
CustomFileSystemConfigs -> (список)
Настройки назначения пользовательской файловой системы профилю пользователя. Разрешённые пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.
SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.
(структура объединения тегов)
Настройки назначения пользовательской файловой системы профилю пользователя или пространству для Amazon SageMaker AI Domain. Разрешённые пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.
Примечание
Это структура объединения тегов. Может быть установлено только одно из следующих верхнеуровневых ключей:EFSFileSystemConfig, FSxLustreFileSystemConfig.EFSFileSystemConfig -> (структура)
Настройки пользовательской файловой системы Amazon EFS.
FileSystemId -> (строка)
FileSystemPath -> (строка)
FSxLustreFileSystemConfig -> (структура)
Настройки пользовательской файловой системы Amazon FSx for Lustre.
FileSystemId -> (строка)
FileSystemPath -> (строка)
StudioWebPortalSettings -> (структура)
Настройки Studio. Если эти настройки применяются на уровне пользователя, они имеют приоритет над настройками, применёнными на уровне домена.
HiddenMlTools -> (список)
Инструменты машинного обучения, скрытые из левой панели навигации Studio.
(строка)
HiddenAppTypes -> (список)
Поддерживаемые приложения в Studio, скрытые из левой панели навигации Studio.
(строка)
HiddenInstanceTypes -> (список)
Типы экземпляров, скрытые из пользовательского интерфейса Studio.
(строка)
HiddenSageMakerImageVersionAliases -> (список)
Алиасы версий, скрытые из пользовательского интерфейса Studio.
(структура)
Образы SageMaker, скрытые из пользовательского интерфейса Studio. Необходимо указать имя и алиасы версий образа SageMaker.
SageMakerImageName -> (строка)
VersionAliases -> (список)
Алиасы версий, скрытые из пользовательского интерфейса Studio.
(строка)
AutoMountHomeEFS -> (строка)
Указывает, поддерживается ли автоматическое подключение объёма EFS для профиля пользователя. Значение DefaultAsDomain поддерживается только для профилей пользователей. Не используйте значение DefaultAsDomain при настройке этого параметра для домена.
SageMaker применяет эту настройку только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эту настройку к общим пространствам.
© Copyright 2025, Amazon Web Services. Created using Sphinx.