Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

описание-пространства

Описание

Описывает пространство.

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

Синтаксис

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

Идентификатор связанного домена.

--space-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
  • текст
  • таблица
  • 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 версии 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 -> (строка)

Идентификатор связанного домена.

SpaceArn -> (строка)

Идентификатор ресурса (ARN) пространства Amazon.

SpaceName -> (строка)

Имя пространства.

HomeEfsFileSystemUid -> (строка)

Идентификатор профиля пространства в томе Amazon EFS.

Status -> (строка)

Состояние.

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

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

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

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

FailureReason -> (строка)

Причина ошибки.

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

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

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

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

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

Тип экземпляра по умолчанию и идентификатор ресурса (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 -> (строка)

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

LifecycleConfigArns -> (список)

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

Примечание

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

(строка)

CodeRepositories -> (список)

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

(структура)

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

RepositoryUrl -> (строка)

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

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

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

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

Тип экземпляра по умолчанию и идентификатор ресурса (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.

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

LifecycleConfigArn -> (строка)

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

CustomImages -> (список)

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

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

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

(структура)

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

ImageName -> (строка)

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

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

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

AppImageConfigName -> (строка)

Имя AppImageConfig.

LifecycleConfigArns -> (список)

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

Примечание

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

(строка)

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

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

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.

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

LifecycleConfigArn -> (строка)

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

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

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

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

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

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

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

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

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

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.

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

LifecycleConfigArn -> (строка)

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

CodeRepositories -> (список)

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

(структура)

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

RepositoryUrl -> (строка)

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

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

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

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

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

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

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

AppType -> (строка)

Тип приложения, созданного в пространстве.

Если вы используете API UpdateSpace, вы не можете изменить тип приложения своего пространства, указав другое значение для этого поля.

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

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

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

Коллекция настроек хранения EBS для пространства.

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

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

SpaceManagedResources -> (строка)

Если вы включите этот параметр, SageMaker AI создаст следующие ресурсы от вашего имени при создании пространства:

  • Профиль пользователя, которому принадлежит пространство.
  • Приложение, содержащееся в пространстве.

CustomFileSystems -> (список)

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

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

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

Примечание

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

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

Пользовательская файловая система в Amazon EFS.

FileSystemId -> (строка)

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

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

Пользовательская файловая система в Amazon FSx for Lustre.

FileSystemId -> (строка)

Идентификатор файловой системы Amazon FSx for Lustre.

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

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

OwnerUserProfileName -> (строка)

Профиль пользователя, являющийся владельцем пространства.

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

Набор настроек совместного использования пространства.

SharingType -> (строка)

Определяет тип совместного использования пространства.

SpaceDisplayName -> (строка)

Название пространства, отображаемое в пользовательском интерфейсе Amazon SageMaker Studio.

Url -> (строка)

Возвращает URL пространства. Если пространство создано с аутентификацией Amazon Web Services IAM Identity Center (преемник Amazon Web Services Single Sign-On), пользователи могут перейти по URL, добавив соответствующий параметр перенаправления для типа приложения, которое должно быть интегрировано через Amazon Web Services IAM Identity Center.

Поддерживаются следующие типы приложений:

  • Studio Classic: &redirect=JupyterServer
  • JupyterLab: &redirect=JupyterLab
  • Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API