Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

обновить-рабочее-пространство

Описание

Изменяет существующее рабочее пространство Amazon Managed Grafana. Если вы используете эту операцию и опустите любые необязательные параметры, существующие значения этих параметров не изменятся.

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

Для изменения пользователей в рабочем пространстве, имеющих роли Grafana Admin и Editor, используйте UpdatePermissions.

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

Синтаксис

  update-workspace
[--account-access-type <value>]
[--network-access-control <value>]
[--organization-role-name <value>]
[--permission-type <value>]
[--remove-network-access-configuration | --no-remove-network-access-configuration]
[--remove-vpc-configuration | --no-remove-vpc-configuration]
[--stack-set-name <value>]
[--vpc-configuration <value>]
[--workspace-data-sources <value>]
[--workspace-description <value>]
--workspace-id <value>
[--workspace-name <value>]
[--workspace-notification-destinations <value>]
[--workspace-organizational-units <value>]
[--workspace-role-arn <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]

Параметры

--account-access-type (строка)

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

Возможные значения:

  • CURRENT_ACCOUNT
  • ORGANIZATION

--network-access-control (структура)

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

При этой конфигурации доступ к вашему рабочему пространству будут иметь только указанные IP-адреса и VPC-точки входа. Стандартная аутентификация и авторизация Grafana по-прежнему будут необходимы.

Если эта конфигурация не настроена или удалена, будут разрешены все IP-адреса и VPC-точки входа. Стандартная аутентификация и авторизация Grafana по-прежнему будут необходимы.

prefixListIds -> (список)

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

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

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

(строка)

vpceIds -> (список)

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

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

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

Примечание

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

(строка)

Сокращённый синтаксис:

prefixListIds=string,string,vpceIds=string,string

Синтаксис JSON:

{
  "prefixListIds": ["string", ...],
  "vpceIds": ["string", ...]
}

--organization-role-name (строка)

Имя существующей роли IAM, используемой для доступа к ресурсам через Organizations. Используется только с рабочим пространством, у которого permissionType установлено в CUSTOMER_MANAGED.

--permission-type (строка)

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

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

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

Примечание

Не используйте этот параметр для преобразования рабочего пространства CUSTOMER_MANAGED в SERVICE_MANAGED. Не включайте этот параметр, если вы хотите оставить рабочее пространство в качестве SERVICE_MANAGED.

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

Возможные значения:

  • CUSTOMER_MANAGED
  • SERVICE_MANAGED

--remove-network-access-configuration | --no-remove-network-access-configuration (булево)

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

Установка этого параметра в true и предоставление networkAccessControl для установки вернёт ошибку.

Если вы удалите эту конфигурацию, установив этот параметр в значение true, будут разрешены все IP-адреса и VPC-точки входа. Стандартная аутентификация и авторизация Grafana по-прежнему будут необходимы.

--remove-vpc-configuration | --no-remove-vpc-configuration (булево)

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

Установка этого параметра в true и предоставление vpcConfiguration для установки вернёт ошибку.

--stack-set-name (строка)

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

--vpc-configuration (структура)

Настройки конфигурации Amazon VPC, содержащей источники данных, к которым должно подключиться ваше рабочее пространство Grafana.

securityGroupIds -> (список)

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

(строка)

subnetIds -> (список)

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

(строка)

Сокращённый синтаксис:

securityGroupIds=string,string,subnetIds=string,string

Синтаксис JSON:

{
  "securityGroupIds": ["string", ...],
  "subnetIds": ["string", ...]
}

--workspace-data-sources (список)

Этот параметр предназначен только для внутреннего использования и не должен использоваться.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AMAZON_OPENSEARCH_SERVICE
  CLOUDWATCH
  PROMETHEUS
  XRAY
  TIMESTREAM
  SITEWISE
  ATHENA
  REDSHIFT
  TWINMAKER

--workspace-description (строка)

Описание рабочего пространства. Используется только для идентификации этого рабочего пространства.

--workspace-id (строка)

Идентификатор рабочего пространства для обновления.

--workspace-name (строка)

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

--workspace-notification-destinations (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SNS

--workspace-organizational-units (список)

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

(строка)

Синтаксис:

"string" "string" ...

--workspace-role-arn (строка)

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

--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 (boolean)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--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 (boolean)

Отключить вывод CLI-страницы для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода 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 -> (boolean)

Указывает, уже ли полностью использовано рабочее пространство для пробного периода 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 см. в Руководстве пользователя Amazon Managed Grafana.

Примечание

Единственные конечные точки VPC, которые могут быть указаны здесь, — это интерфейсные конечные точки 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