describe-workspace
Описание
Отображает информацию об одном рабочем пространстве Amazon Managed Grafana.
См. также: Документация API AWS
Синтаксис
describe-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
- текст
- таблица
- 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.
Вывод
workspace -> (структура)
Структура, содержащая информацию о рабочей области.
accountAccessType -> (строка)
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 -> (строка)
freeTrialConsumed -> (булево)
Указывает, полностью ли рабочая область использовала пробный период Grafana Enterprise.
Примечание
Рабочие области Amazon Managed Grafana больше не поддерживают пробный период Grafana Enterprise.freeTrialExpiration -> (метка времени)
Если эта рабочая область в настоящее время участвует в пробном периоде Grafana Enterprise, это значение указывает, когда закончится этот пробный период.
Примечание
Рабочие области Amazon Managed Grafana больше не поддерживают пробный период Grafana Enterprise.grafanaToken -> (строка)
grafanaVersion -> (строка)
id -> (строка)
licenseExpiration -> (метка времени)
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 -> (строка)
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 -> (строка)
status -> (строка)
tags -> (карта)
Список тегов, связанных с рабочей областью.
key -> (строка)
value -> (строка)
vpcConfiguration -> (структура)
Настройка подключения к источникам данных в частной VPC (Amazon Virtual Private Cloud).
securityGroupIds -> (список)
Список идентификаторов групп безопасности Amazon EC2, прикрепленных к Amazon VPC для подключения рабочей области Grafana. Дубликаты запрещены.
(строка)
subnetIds -> (список)
Список идентификаторов подсетей Amazon EC2, созданных в Amazon VPC для подключения рабочей области Grafana. Дубликаты запрещены.
(строка)
workspaceRoleArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.