Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

Удалить рабочее пространство

Описание

Удаляет рабочее пространство Amazon Managed Grafana.

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

Синтаксис

  delete-workspace
--workspace-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]

Параметры

--workspace-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
  • 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 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.

Вывод

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

Структура, содержащая информацию о удаленном рабочем пространстве.

accountAccessType -> (строка)

Указывает, может ли рабочее пространство получать доступ к ресурсам Amazon Web Services только в данной учетной записи Amazon Web Services или также к ресурсам Amazon Web Services в других учетных записях в той же организации. Если это ORGANIZATION, параметр workspaceOrganizationalUnits указывает, к каким организационным единицам может получить доступ рабочее пространство.

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

Структура, описывающая, использует ли рабочее пространство SAML, IAM Identity Center или оба метода для аутентификации пользователей.

providers -> (список)

Указывает, использует ли рабочее пространство SAML, IAM Identity Center или оба метода для аутентификации пользователей.

(строка)

samlConfigurationStatus -> (строка)

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

created -> (временная метка)

Дата создания рабочего пространства.

dataSources -> (список)

Указывает источники данных Amazon Web Services, для которых были настроены IAM-роли и разрешения, позволяющие Amazon Managed Grafana читать данные из этих источников.

Этот список используется только в случае, если рабочее пространство было создано через консоль Amazon Web Services, и permissionType равно SERVICE_MANAGED.

(строка)

description -> (строка)

Пользовательское описание рабочего пространства.

endpoint -> (строка)

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

freeTrialConsumed -> (булево)

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

Примечание

Рабочие пространства Amazon Managed Grafana больше не поддерживают пробные периоды для Grafana Enterprise.

freeTrialExpiration -> (временная метка)

Если рабочее пространство сейчас находится в пробном периоде для Grafana Enterprise, это значение указывает, когда этот пробный период закончится.

Примечание

Рабочие пространства Amazon Managed Grafana больше не поддерживают пробные периоды для Grafana Enterprise.

grafanaToken -> (строка)

Токен, связывающий данное рабочее пространство с учетной записью Grafana Labs. Дополнительную информацию см. в разделе Свяжите свою учетную запись с Grafana Labs.

grafanaVersion -> (строка)

Версия Grafana, поддерживаемая в этом рабочем пространстве.

id -> (строка)

Уникальный идентификатор этого рабочего пространства.

licenseExpiration -> (временная метка)

Если у этого рабочего пространства есть полная лицензия Grafana Enterprise, приобретенная через Amazon Web Services Marketplace, это указывает, когда лицензия истекает и ее необходимо будет обновить. Приобретение плагина Enterprise через Amazon Managed Grafana не имеет срока действия. Она действительна до тех пор, пока лицензия не будет удалена.

licenseType -> (строка)

Указывает, имеет ли это рабочее пространство полную лицензию Grafana Enterprise.

Примечание

Рабочие пространства Amazon Managed Grafana больше не поддерживают пробные периоды для Grafana Enterprise.

modified -> (временная метка)

Самая последняя дата изменения рабочего пространства.

name -> (строка)

Название рабочего пространства.

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

Настройки конфигурации сетевого доступа к вашему рабочему пространству.

prefixListIds -> (список)

Массив идентификаторов списков префиксов. Список префиксов — это список диапазонов CIDR IP-адресов. Указанные IP-адреса разрешено использовать для доступа к вашему рабочему пространству. Если список не включен в конфигурацию (передан пустой массив), то доступ к рабочему пространству не разрешен ни для каких IP-адресов. Вы создаете список префиксов с помощью консоли Amazon VPC.

Идентификаторы списков префиксов имеют формат ``pl-1a2b3c4d ``.

Дополнительную информацию о списках префиксов см. в разделе Группирование блоков CIDR с помощью управляемых списков префиксов в Руководстве пользователя Amazon Virtual Private Cloud.

(строка)

vpceIds -> (список)

Массив идентификаторов конечных точек Amazon VPC для рабочего пространства. Вы можете создать конечные точки VPC для доступа к вашему рабочему пространству Amazon Managed Grafana изнутри VPC. Если указан NetworkAccessConfiguration, то доступ к рабочему пространству разрешен только для указанных здесь конечных точек VPC. Если вы передаете пустой массив строк, то доступ к рабочему пространству не разрешен ни для каких VPC.

Идентификаторы конечных точек VPC имеют формат ``vpce-1a2b3c4d ``.

Дополнительную информацию о создании интерфейсной конечной точки VPC см. в разделе Интерфейсные конечные точки VPC в Руководстве пользователя Amazon Managed Grafana.

Примечание

Здесь можно указать только интерфейсные конечные точки VPC для рабочих пространств Grafana (используя конечную точку сервиса com.amazonaws.[region].grafana-workspace). Другие конечные точки VPC игнорируются.

(строка)

notificationDestinations -> (список)

Каналы уведомлений Amazon Web Services, для которых Amazon Managed Grafana может автоматически создать IAM-роли и разрешения, позволяющие Amazon Managed Grafana использовать эти каналы.

(строка)

organizationRoleName -> (строка)

Имя IAM-роли, используемой для доступа к ресурсам через Организации.

organizationalUnits -> (список)

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

(строка)

permissionType -> (строка)

Если это SERVICE_MANAGED, и рабочее пространство было создано через консоль Amazon Managed Grafana, то Amazon Managed Grafana автоматически создает IAM-роли и предоставляет разрешения, необходимые рабочему пространству для использования источников данных и каналов уведомлений Amazon Web Services.

Если это CUSTOMER_MANAGED, вы должны самостоятельно управлять этими ролями и разрешениями.

Если вы работаете с рабочим пространством в учетной записи участника организации, и эта учетная запись не является делегированной учетной записью администратора, и вы хотите, чтобы рабочее пространство получало доступ к источникам данных в других учетных записях Amazon Web Services в организации, этот параметр должен быть установлен на CUSTOMER_MANAGED.

Дополнительную информацию о переходе между управлением клиентом и сервисом см. в разделе Управление разрешениями для источников данных и каналов уведомлений. Дополнительную информацию о ролях и разрешениях, которые необходимо управлять для рабочих пространств клиентов, см. в разделе Разрешения и политики Amazon Managed Grafana для источников данных и каналов уведомлений Amazon Web Services.

stackSetName -> (строка)

Имя набора стеков CloudFormation, используемого для генерации IAM-ролей, которые будут использоваться для этого рабочего пространства.

status -> (строка)

Текущий статус рабочего пространства.

tags -> (карта)

Список тегов, связанных с рабочим пространством.

key -> (строка)

value -> (строка)

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

Настройка подключения к источникам данных в частной VPC (Amazon Virtual Private Cloud).

securityGroupIds -> (список)

Список идентификаторов групп безопасности Amazon EC2, присоединенных к Amazon VPC для подключения вашего рабочего пространства Grafana. Дубликаты не допускаются.

(строка)

subnetIds -> (список)

Список идентификаторов подсетей Amazon EC2, созданных в Amazon VPC для подключения вашего рабочего пространства Grafana. Дубликаты не допускаются.

(строка)

workspaceRoleArn -> (строка)

IAM-роль, предоставляющая разрешения на ресурсы Amazon Web Services, данные из которых будет просматривать рабочее пространство. Эта роль должна уже существовать.

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

Spec-Zone.ru

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