describe-domain

Описание

Описание домена.

См. также: Документация API AWS

Синтаксис

  describe-domain
--domain-id <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 (строка)

Идентификатор домена.

--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
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

вкл
выкл
авто

--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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Вывод

DomainArn -> (строка)

Amazon Resource Name (ARN) домена.

DomainId -> (строка)

Идентификатор домена.

DomainName -> (строка)

Имя домена.

HomeEfsFileSystemId -> (строка)

Идентификатор управляемого Amazon Elastic File System в этом домене.

SingleSignOnManagedApplicationInstanceId -> (строка)

Идентификатор экземпляра управляемого приложения IAM Identity Center.

SingleSignOnApplicationArn -> (строка)

ARN приложения, управляемого SageMaker AI в IAM Identity Center. Это значение возвращается только для доменов, созданных после 1 октября 2023 года.

Status -> (строка)

Статус.

CreationTime -> (метка времени)

Время создания.

LastModifiedTime -> (метка времени)

Время последнего изменения.

FailureReason -> (строка)

Причина сбоя.

SecurityGroupIdForDomainBoundary -> (строка)

Идентификатор группы безопасности, разрешающей трафик между приложениями RSessionGateway и приложением RStudioServerPro.

AuthMode -> (строка)

Режим аутентификации домена.

DefaultUserSettings -> (структура)

Настройки, применяемые к профилям пользователей в этом домене, если настройки не указаны явно в конкретном профиле пользователя.

ExecutionRole -> (строка)

Роль выполнения для пользователя.

SageMaker применяет эту настройку только к частным пространствам, создаваемым пользователем в домене. SageMaker не применяет эту настройку к общим пространствам.

SecurityGroups -> (список)

Группы безопасности для Amazon Virtual Private Cloud (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 -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, установленное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа для запуска. Это значение в формате версии SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

Для приложений KernelGateway значение system переводится в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикрепленной к ресурсу.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, прикрепленных к JupyterServerApp. Если вы используете этот параметр, также требуется параметр DefaultResourceSpec.

Примечание

Чтобы удалить конфигурацию жизненного цикла, необходимо установить LifecycleConfigArns в пустой список.

(строка)

CodeRepositories -> (список)

Список Git-репозиториев, которые SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.

(структура)

Git-репозиторий, который SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.

RepositoryUrl -> (строка)

URL Git-репозитория.

KernelGatewayAppSettings -> (структура)

Настройки приложения шлюза ядра.

DefaultResourceSpec -> (структура)

Тип экземпляра по умолчанию и Amazon Resource Name (ARN) стандартного образа SageMaker AI, используемого приложением KernelGateway.

Примечание

Интерфейс Amazon SageMaker AI Studio не использует значение типа экземпляра по умолчанию, заданное здесь. Тип экземпляра по умолчанию, заданный здесь, используется при создании приложений с помощью CLI или CloudFormation, и параметр типа экземпляра не передан.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, установленное для SageMakerImageVersionArn , передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа, который нужно запустить. Это значение соответствует формату версионирования SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения для доступных типов экземпляров.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикрепленной к ресурсу.

CustomImages -> (список)

Список пользовательских образов SageMaker AI, настроенных для запуска в качестве приложения KernelGateway.

Максимальное количество пользовательских образов:

На уровне домена: 200
На уровне пространства: 5
На уровне профиля пользователя: 5

(структура)

Пользовательский образ SageMaker AI. Дополнительную информацию см. в разделе Применение собственного образа SageMaker AI.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учетной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, прикрепленных к профилю пользователя или домену.

Примечание

Чтобы удалить конфигурацию жизненного цикла, необходимо установить LifecycleConfigArns в пустой список.

(строка)

TensorBoardAppSettings -> (структура)

Настройки приложения TensorBoard.

DefaultResourceSpec -> (структура)

Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа SageMaker AI, созданного на экземпляре.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, установленное для SageMakerImageVersionArn , передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа, который нужно запустить. Это значение соответствует формату версионирования SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикрепленной к ресурсу.

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 -> (строка)

ARN SageMaker AI образа, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Для удаления значения, установленного для SageMakerImageVersionArn, передайте значение None.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа для запуска. Это значение имеет формат версионирования SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, присоединённой к ресурсу.

CustomImages -> (список)

Список пользовательских SageMaker AI образов, настроенных для работы в качестве приложения RSession.

(структура)

Пользовательский SageMaker AI образ. Дополнительные сведения см. в разделе Привлечение собственного SageMaker AI образа.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учетной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

CanvasAppSettings -> (структура)

Настройки приложения Canvas.

SageMaker применяет эти настройки только к закрытым пространствам, которые SageMaker создает для приложения Canvas.

TimeSeriesForecastingSettings -> (структура)

Настройки прогнозирования временных рядов для приложения SageMaker Canvas.

Status -> (строка)

Описывает, включено или выключено прогнозирование временных рядов в приложении Canvas.

AmazonForecastRoleArn -> (строка)

Роль IAM, которую Canvas передает Amazon Forecast для прогнозирования временных рядов. По умолчанию Canvas использует роль выполнения, указанную в UserProfile, которая запускает приложение Canvas. Если роль выполнения не указана в UserProfile, Canvas использует роль выполнения, указанную в домене, который владеет UserProfile. Для разрешения прогнозирования временных рядов этой роли IAM необходимо прикрепить политику AmazonSageMakerCanvasForecastAccess и forecast.amazonaws.com добавить в отношение доверия в качестве сервисного принципала.

ModelRegisterSettings -> (структура)

Настройки реестра моделей для приложения SageMaker Canvas.

Status -> (строка)

Описывает, включена или выключена интеграция с реестром моделей в приложении Canvas.

CrossAccountModelRegisterRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) учетной записи реестра моделей SageMaker. Требуется только для регистрации версий моделей, созданных другой учетной записью Amazon Web Services SageMaker Canvas, отличной от учетной записи Amazon Web Services, в которой настроен реестр моделей SageMaker.

WorkspaceSettings -> (структура)

Настройки рабочего пространства для приложения SageMaker Canvas.

S3ArtifactPath -> (строка)

Ведро Amazon S3, используемое для хранения артефактов, сгенерированных Canvas. Обновление расположения Amazon S3 влияет на существующие настройки конфигурации, и пользователи Canvas больше не имеют доступа к своим артефактам. Пользователи Canvas должны выйти и войти заново, чтобы применить новое расположение.

S3KmsKeyId -> (строка)

Идентификатор ключа шифрования Amazon Web Services Key Management Service (KMS), используемый для шифрования артефактов, сгенерированных Canvas, в ведре Amazon S3.

IdentityProviderOAuthSettings -> (список)

Настройки подключения к внешнему источнику данных с помощью OAuth.

(структура)

Настройка приложения Amazon SageMaker Canvas, где настраивается OAuth для подключения к внешнему источнику данных, например, Snowflake.

DataSourceName -> (строка)

Имя источника данных, к которому вы подключаетесь. Canvas в настоящее время поддерживает OAuth для Snowflake и Salesforce Data Cloud.

Status -> (строка)

Описывает, включен или выключен OAuth для источника данных в приложении Canvas.

SecretArn -> (строка)

ARN секрета Amazon Web Services Secrets Manager, который хранит учетные данные от вашего поставщика удостоверений, такие как идентификатор клиента и секрет, URL-адрес авторизации и URL-адрес получения токена.

DirectDeploySettings -> (структура)

Настройки развертывания модели для приложения SageMaker Canvas.

Status -> (строка)

Описывает, включены или выключены разрешения на развертывание модели в приложении Canvas.

KendraSettings -> (структура)

Настройки для запросов к документам.

Status -> (строка)

Описывает, включена или выключена функция запросов к документам в приложении Canvas.

GenerativeAiSettings -> (структура)

Настройки генеративного ИИ для приложения SageMaker Canvas.

AmazonBedrockRoleArn -> (строка)

ARN роли Amazon Web Services IAM, которая позволяет усовершенствовать большие языковые модели (LLM) в Amazon Bedrock. Роль IAM должна иметь права чтения и записи Amazon S3, а также отношение доверия, которое устанавливает bedrock.amazonaws.com как сервисного принципала.

EmrServerlessSettings -> (структура)

Настройки для запуска задач обработки данных Amazon EMR Serverless в SageMaker Canvas.

ExecutionRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли Amazon Web Services IAM, которая используется для запуска задач Amazon EMR Serverless в SageMaker Canvas. Эта роль должна иметь необходимые разрешения для чтения и записи прикрепленных данных и иметь отношение доверия с EMR Serverless.

Status -> (строка)

Описывает, включены или выключены возможности задач Amazon EMR Serverless в приложении SageMaker Canvas.

CodeEditorAppSettings -> (структура)

Настройки приложения Code Editor.

SageMaker применяет эти настройки только к частным пространствам, которые пользователь создаёт в домене. SageMaker не применяет эти настройки к общим пространствам.

DefaultResourceSpec -> (структура)

Указывает ARN образа SageMaker AI и версии образа SageMaker AI, а также тип экземпляра, на котором запущена версия.

Примечание

Когда переданы как SageMakerImageVersionArn, так и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, потому что SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа, который необходимо запустить. Это значение находится в формате версионирования SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором запущена версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикреплённой к ресурсу.

CustomImages -> (список)

Список пользовательских образов SageMaker, настроенных для работы в качестве приложения Code Editor.

(структура)

Пользовательский образ SageMaker AI. Для получения дополнительной информации см. Применение собственного образа SageMaker AI.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учётной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигурации жизненного цикла приложения Code Editor.

(строка)

AppLifecycleManagement -> (структура)

Настройки, используемые для настройки и управления жизненным циклом приложений CodeEditor.

IdleSettings -> (структура)

Настройки, связанные с выключением приложений Studio при бездействии.

LifecycleManagement -> (строка)

Указывает, включено ли отключение при бездействии для типа приложения.

IdleTimeoutInMinutes -> (целое число)

Время, которое SageMaker ожидает после того, как приложение станет бездействующим, прежде чем выключить его.

MinIdleTimeoutInMinutes -> (целое число)

Минимальное значение в минутах, которое пользователь может установить для пользовательского отключения при бездействии.

MaxIdleTimeoutInMinutes -> (целое число)

Максимальное значение в минутах, которое пользователь может установить для пользовательского отключения при бездействии.

BuiltInLifecycleConfigArn -> (строка)

Конфигурация жизненного цикла, которая запускается перед стандартной конфигурацией жизненного цикла. Она может переопределять изменения, внесённые в стандартную конфигурацию жизненного цикла.

JupyterLabAppSettings -> (структура)

Настройки приложения JupyterLab.

DefaultResourceSpec -> (структура)

Указывает ARN образа SageMaker AI и версии образа SageMaker AI, а также тип экземпляра, на котором запущена версия.

Примечание

Когда передаются как SageMakerImageVersionArn, так и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, так как SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа, который нужно запустить. Это значение имеет формат версии SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором запущена версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

Для приложений KernelGateway значение system преобразуется в ml.t3.medium. Приложения KernelGateway также поддерживают все другие значения доступных типов экземпляров.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикреплённой к ресурсу.

CustomImages -> (список)

Список пользовательских образов SageMaker, настроенных для работы в качестве приложения JupyterLab.

(структура)

Пользовательский образ SageMaker AI. Дополнительную информацию см. в разделе Импорт собственного образа SageMaker AI.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учётной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, прикреплённых к профилю пользователя или домену. Чтобы удалить конфигурацию жизненного цикла, необходимо установить LifecycleConfigArns в пустой список.

(строка)

CodeRepositories -> (список)

Список Git-репозиториев, которые SageMaker автоматически отображает пользователям для клонирования в приложении JupyterLab.

(структура)

RepositoryUrl -> (строка)

URL Git-репозитория.

AppLifecycleManagement -> (структура)

Указывает, активирована ли функция отключения приложений JupyterLab при бездействии.

IdleSettings -> (структура)

Настройки, связанные с отключением приложений Studio при бездействии.

LifecycleManagement -> (строка)

Указывает, активирована ли функция отключения приложений при бездействии для данного типа приложения.

IdleTimeoutInMinutes -> (целое число)

Время, которое SageMaker ожидает, прежде чем отключить приложение после того, как оно станет неактивным.

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-ресурсы (кластеры или серверless-приложения) находятся в другой учётной записи 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 -> (целое число)

Размер по умолчанию EBS тома для пространства.

MaximumEbsVolumeSizeInGb -> (целое число)

Максимальный размер EBS тома для пространства.

DefaultLandingUri -> (строка)

По умолчанию, пользователь перенаправляется на интерфейс при доступе к домену. Поддерживаемые значения:

studio:: : Указывает, что Studio является интерфейсом по умолчанию. Это значение может быть передано только если StudioWebPortal установлено в ENABLED .
app:JupyterServer: : Указывает, что Studio Classic является интерфейсом по умолчанию.

StudioWebPortal -> (строка)

Доступ пользователя к Studio. Если значение установлено в DISABLED, пользователи не смогут получить доступ к Studio, даже если это интерфейс по умолчанию для домена.

CustomPosixUserConfig -> (структура)

Подробная информация о POSIX идентификаторе, используемом для операций с файловой системой.

Uid -> (длинное целое число)

Идентификатор пользователя POSIX.

Gid -> (длинное целое число)

Идентификатор группы POSIX.

CustomFileSystemConfigs -> (список)

Настройки для назначения пользовательской файловой системы профилю пользователя. Разрешенные пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.

(структура помеченных союзов)

Настройки для назначения пользовательской файловой системы профилю пользователя или пространству для Amazon SageMaker AI Домена. Разрешенные пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.

Примечание

Это структура помеченных союзов. Только один из следующих ключей верхнего уровня может быть установлен: EFSFileSystemConfig, FSxLustreFileSystemConfig.

EFSFileSystemConfig -> (структура)

Настройки пользовательской файловой системы Amazon EFS.

FileSystemId -> (строка)

Идентификатор вашей файловой системы Amazon EFS.

FileSystemPath -> (строка)

Путь к каталогу файловой системы, доступной в Amazon SageMaker AI Studio. Разрешенные пользователи могут получить доступ только к этому каталогу и ниже.

FSxLustreFileSystemConfig -> (структура)

Настройки пользовательской файловой системы Amazon FSx для Lustre.

FileSystemId -> (строка)

Уникальный 17-значный идентификатор файловой системы, присвоенный Amazon FSx для Lustre.

FileSystemPath -> (строка)

Путь к каталогу файловой системы, доступной в Amazon SageMaker Studio. Разрешенные пользователи могут получить доступ только к этому каталогу и ниже.

StudioWebPortalSettings -> (структура)

Настройки Studio. Если эти настройки применены на уровне пользователя, они имеют приоритет над настройками, примененными на уровне домена.

HiddenMlTools -> (список)

Инструменты машинного обучения, скрытые из левой панели навигации Studio.

(строка)

HiddenAppTypes -> (список)

Приложения, поддерживаемые в Studio, скрытые из левой панели навигации Studio.

(строка)

HiddenInstanceTypes -> (список)

Типы экземпляров, которые вы скрываете из пользовательского интерфейса Studio.

(строка)

HiddenSageMakerImageVersionAliases -> (список)

Псевдонимы версий, которые вы скрываете из пользовательского интерфейса Studio.

(структура)

Изображения SageMaker, скрытые из пользовательского интерфейса Studio. Вы должны указать имя изображения SageMaker и псевдонимы версий.

SageMakerImageName -> (строка)

Имя изображения SageMaker, которое вы скрываете из пользовательского интерфейса Studio.

VersionAliases -> (список)

Псевдонимы версий, которые вы скрываете из пользовательского интерфейса Studio.

(строка)

AutoMountHomeEFS -> (строка)

Указывает, поддерживается ли автоматическое подключение EFS тома для пользовательского профиля. Значение DefaultAsDomain поддерживается только для пользовательских профилей. Не используйте значение DefaultAsDomain при настройке этого параметра для домена.

SageMaker применяет эту настройку только к частным пространствам, которые пользователь создает в домене. SageMaker не применяет эту настройку к общим пространствам.

DomainSettings -> (структура)

Коллекция параметров.

SecurityGroupIds -> (список)

Безопасные группы для виртуального частного облака Amazon, которые используется Domain для связи между приложениями уровня домена и приложениями пользователей.

(строка)

RStudioServerProDomainSettings -> (структура)

Коллекция настроек, которые конфигурируют приложение уровня домена RStudioServerPro.

DomainExecutionRoleArn -> (строка)

Идентификатор ARN роли выполнения для приложения уровня домена RStudioServerPro.

RStudioConnectUrl -> (строка)

URL, указывающий на сервер RStudio Connect.

RStudioPackageManagerUrl -> (строка)

URL, указывающий на сервер RStudio Package Manager.

DefaultResourceSpec -> (структура)

Определяет ARN изображения SageMaker AI и версии изображения SageMaker AI, а также тип экземпляра, на котором работает версия.

Примечание

Если переданы и SageMakerImageVersionArn, и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не будут применены, если SageMakerImageVersionArn уже существует в ResourceSpec, так как SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, установленное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageArn -> (строка)

ARN изображения SageMaker AI, к которому принадлежит версия изображения.

SageMakerImageVersionArn -> (строка)

ARN версии изображения, созданной на экземпляре. Чтобы очистить значение, установленное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias изображения для запуска. Это значение имеет формат версии SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия изображения.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, присоединенной к ресурсу.

ExecutionRoleIdentityConfig -> (строка)

Настройка для присоединения имени профиля пользователя SageMaker AI к роли выполнения в качестве ключа sts:SourceIdentity.

DockerSettings -> (структура)

Коллекция настроек, которые конфигурируют взаимодействие домена с Docker.

EnableDockerAccess -> (строка)

Указывает, может ли домен получить доступ к Docker.

VpcOnlyTrustedAccounts -> (список)

Список учетных записей Amazon Web Services, которым доверяют, когда домен создается в режиме VPC-only.

(строка)

AmazonQSettings -> (структура)

Коллекция настроек, которые конфигурируют опыт Amazon Q в рамках домена. AuthMode, который используется для создания домена, должен быть SSO.

Status -> (строка)

Включен ли Amazon Q в домене.

QProfileArn -> (строка)

ARN профиля Amazon Q, используемого в рамках домена.

UnifiedStudioSettings -> (структура)

Настройки, которые применяются к домену SageMaker AI, когда вы используете его в Amazon SageMaker Unified Studio.

StudioWebPortalAccess -> (строка)

Устанавливает, можете ли вы получить доступ к домену в Amazon SageMaker Studio:

ENABLED

Вы можете получить доступ к домену в Amazon SageMaker Studio. Если вы перенесете домен в Amazon SageMaker Unified Studio, вы сможете получить доступ к нему в обоих интерфейсах студии.

DISABLED

Вы не можете получить доступ к домену в Amazon SageMaker Studio. Если вы перенесете домен в Amazon SageMaker Unified Studio, вы сможете получить доступ к нему только в этом интерфейсе студии.

Чтобы перенести домен в Amazon SageMaker Unified Studio, укажите тип данных UnifiedStudioSettings, когда используете действие UpdateDomain.

DomainAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, у которой есть домен Amazon SageMaker Unified Studio. По умолчанию, если вы не укажете ID, будет использован ID учетной записи, у которой есть домен Amazon SageMaker AI.

DomainRegion -> (строка)

Регион Amazon Web Services, в котором расположен домен в Amazon SageMaker Unified Studio. По умолчанию, если вы не укажете регион, будет использован регион, в котором находится домен Amazon SageMaker AI.

DomainId -> (строка)

Идентификатор домена Amazon SageMaker Unified Studio, связанного с данным доменом.

ProjectId -> (строка)

Идентификатор проекта Amazon SageMaker Unified Studio, соответствующего домену.

EnvironmentId -> (строка)

Идентификатор среды, которую Amazon SageMaker Unified Studio связывает с доменом.

ProjectS3Path -> (строка)

Местоположение, где Amazon S3 хранит временные данные выполнения и другие артефакты для проекта, соответствующего домену.

AppNetworkAccessType -> (строка)

Указывает VPC, используемый для трафика, не связанного с EFS. Значение по умолчанию — PublicInternetOnly.

PublicInternetOnly — Трафик, не связанный с EFS, проходит через VPC, управляемый Amazon SageMaker AI, что позволяет прямой доступ к интернету
VpcOnly — Весь трафик проходит через указанный VPC и подсети

HomeEfsFileSystemKmsKeyId -> (string)

Используйте KmsKeyId.

SubnetIds -> (list)

Подсети VPC, которые используются доменом для связи.

(string)

Url -> (string)

URL домена.

VpcId -> (string)

Идентификатор Amazon Virtual Private Cloud (VPC), который используется доменом для связи.

KmsKeyId -> (string)

Клиентский управляемый ключ Amazon Web Services KMS, используемый для шифрования тома EFS, подключенного к домену.

AppSecurityGroupManagement -> (string)

Сущность, создающая и управляющая необходимыми группами безопасности для межприложений в режиме VPCOnly. Требуется, когда CreateDomain.AppNetworkAccessType равно VPCOnly и предоставлен DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn.

TagPropagation -> (string)

Указывает, поддерживается ли распространение пользовательских тегов для домена.

DefaultSpaceSettings -> (structure)

Значения по умолчанию для общих пространств, которые пользователи создают в домене.

ExecutionRole -> (строка)

ARN роли выполнения для пространства.

SecurityGroups -> (список)

Идентификаторы групп безопасности для Amazon VPC, которые пространство использует для связи.

(строка)

JupyterServerAppSettings -> (структура)

Настройки приложения JupyterServer.

DefaultResourceSpec -> (структура)

Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа по умолчанию SageMaker AI, используемого приложением JupyterServer. Если вы используете параметр LifecycleConfigArns, то этот параметр также обязателен.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, заданное для SageMakerImageVersionArn , передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа для запуска. Это значение находится в формате версии SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, присоединенной к ресурсу.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, присоединенных к JupyterServerApp. Если вы используете этот параметр, параметр DefaultResourceSpec также обязателен.

Примечание

Для удаления конфигурации жизненного цикла необходимо установить LifecycleConfigArns в пустой список.

(строка)

CodeRepositories -> (список)

Список репозиториев Git, которые SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.

(структура)

Репозиторий Git, который SageMaker AI автоматически отображает пользователям для клонирования в приложении JupyterServer.

RepositoryUrl -> (строка)

URL репозитория Git.

KernelGatewayAppSettings -> (структура)

Настройки приложения KernelGateway.

DefaultResourceSpec -> (структура)

Тип экземпляра по умолчанию и Amazon Resource Name (ARN) образа по умолчанию SageMaker AI, используемого приложением KernelGateway.

Примечание

Интерфейс Amazon SageMaker AI Studio не использует значение типа экземпляра по умолчанию, заданное здесь. Тип экземпляра по умолчанию, заданный здесь, используется при создании приложений с помощью командной строки или CloudFormation, и значение параметра типа экземпляра не передается.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому принадлежит версия образа.

SageMakerImageVersionArn -> (строка)

ARN версии образа, созданной на экземпляре. Чтобы очистить значение, заданное для SageMakerImageVersionArn , передайте None в качестве значения.

SageMakerImageVersionAlias -> (строка)

SageMakerImageVersionAlias образа для запуска. Это значение находится в формате версии SemVer 2.0.0.

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, присоединенной к ресурсу.

CustomImages -> (список)

Список пользовательских образов SageMaker AI, настроенных для работы в качестве приложения KernelGateway.

Максимальное количество пользовательских образов:

На уровне домена: 200
На уровне пространства: 5
На уровне профиля пользователя: 5

(структура)

Пользовательский образ SageMaker AI. Дополнительные сведения см. в разделе Применение собственного образа SageMaker AI.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учетной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, присоединенных к профилю пользователя или домену.

Примечание

Для удаления конфигурации жизненного цикла необходимо установить LifecycleConfigArns в пустой список.

(строка)

JupyterLabAppSettings -> (структура)

Настройки приложения JupyterLab.

DefaultResourceSpec -> (структура)

Указывает ARN образа SageMaker AI и версии образа SageMaker AI, а также тип экземпляра, на котором работает версия.

Примечание

Когда передаются как SageMakerImageVersionArn, так и SageMakerImageArn, используется SageMakerImageVersionArn. Любые обновления SageMakerImageArn не вступят в силу, если SageMakerImageVersionArn уже существует в ResourceSpec, потому что SageMakerImageVersionArn всегда имеет приоритет. Чтобы очистить значение, заданное для SageMakerImageVersionArn, передайте None в качестве значения.

SageMakerImageArn -> (строка)

ARN образа SageMaker AI, к которому относится версия образа.

SageMakerImageVersionArn -> (строка)

SageMakerImageVersionAlias -> (строка)

InstanceType -> (строка)

Тип экземпляра, на котором работает версия образа.

Примечание

Приложения JupyterServer поддерживают только значение system.

LifecycleConfigArn -> (строка)

Amazon Resource Name (ARN) конфигурации жизненного цикла, прикрепленной к ресурсу.

CustomImages -> (список)

Список пользовательских образов SageMaker, настроенных для работы в качестве приложения JupyterLab.

(структура)

Пользовательский образ SageMaker AI. Дополнительная информация доступна в разделе Применение собственного образа SageMaker AI.

ImageName -> (строка)

Имя CustomImage. Должно быть уникальным для вашей учетной записи.

ImageVersionNumber -> (целое число)

Номер версии CustomImage.

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

Amazon Resource Name (ARN) конфигураций жизненного цикла, прикрепленных к профилю пользователя или домену. Чтобы удалить конфигурацию жизненного цикла, необходимо установить LifecycleConfigArns в пустой список.

(строка)

CodeRepositories -> (список)

(структура)

RepositoryUrl -> (строка)

URL Git-репозитория.

AppLifecycleManagement -> (структура)

Указывает, активирован ли режим автоматического завершения работы приложений JupyterLab при бездействии.

IdleSettings -> (структура)

Настройки, связанные с автоматическим завершением работы приложений Studio при бездействии.

LifecycleManagement -> (строка)

Указывает, активирован ли режим автоматического завершения работы приложений данного типа при бездействии.

IdleTimeoutInMinutes -> (целое число)

Время, которое SageMaker ожидает после того, как приложение становится бездействующим, перед его завершением.

MinIdleTimeoutInMinutes -> (целое число)

Минимальное значение в минутах, которое пользователь может установить для пользовательского таймаута при бездействии.

MaxIdleTimeoutInMinutes -> (целое число)

Максимальное значение в минутах, которое пользователь может установить для пользовательского таймаута при бездействии.

EmrSettings -> (структура)

Параметры конфигурации, определяющие IAM-роли, принимаемые ролью выполнения SageMaker (роли с возможностью принятия), и экземпляры кластеров или среды выполнения задач (роли выполнения или роли среды выполнения) для управления и доступа к ресурсам, необходимым для запуска кластеров Amazon EMR или серверных приложений Amazon EMR.

AssumableRoleArns -> (список)

Массив Amazon Resource Names (ARN) IAM-ролей, которые может принять роль выполнения SageMaker для выполнения операций или задач, связанных с кластерами Amazon EMR или серверными приложениями Amazon EMR. Эти роли определяют разрешения и политики доступа, необходимые при выполнении операций, связанных с Amazon EMR, таких как перечисление, подключение или завершение работы кластеров или серверных приложений Amazon EMR. Обычно они используются в сценариях доступа между учетными записями, где ресурсы Amazon EMR (кластеры или серверные приложения) находятся в другой учетной записи 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 -> (структура)

Настройки хранения по умолчанию для пространства.

DefaultEbsStorageSettings -> (структура)

Настройки хранения EBS по умолчанию для пространства.

DefaultEbsVolumeSizeInGb -> (целое число)

Размер тома EBS по умолчанию для пространства.

MaximumEbsVolumeSizeInGb -> (целое число)

Максимальный размер тома EBS для пространства.

CustomPosixUserConfig -> (структура)

Сведения об идентификаторе POSIX, используемом для операций с файловой системой.

Uid -> (длинное целое число)

Идентификатор пользователя POSIX.

Gid -> (длинное целое число)

Идентификатор группы POSIX.

CustomFileSystemConfigs -> (список)

Настройки назначения пользовательской файловой системы для домена. Разрешённые пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.

(структура помеченного объединения)

Настройки назначения пользовательской файловой системы для профиля пользователя или пространства домена Amazon SageMaker AI. Разрешённые пользователи могут получить доступ к этой файловой системе в Amazon SageMaker AI Studio.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: EFSFileSystemConfig, FSxLustreFileSystemConfig.

EFSFileSystemConfig -> (структура)

Настройки пользовательской файловой системы Amazon EFS.

FileSystemId -> (строка)

Идентификатор вашей файловой системы Amazon EFS.

FileSystemPath -> (строка)

Путь к каталогу файловой системы, доступному в Amazon SageMaker AI Studio. Разрешённые пользователи могут получить доступ только к этому каталогу и нижестоящим папкам.

FSxLustreFileSystemConfig -> (структура)

Настройки пользовательской файловой системы Amazon FSx для Lustre.

FileSystemId -> (строка)

Уникальный 17-значный ID файловой системы, присвоенный Amazon FSx для Lustre.

FileSystemPath -> (строка)

Путь к каталогу файловой системы, доступному в Amazon SageMaker Studio. Разрешённые пользователи могут получить доступ только к этому каталогу и нижестоящим папкам.