Spec-Zone.ru › AWS CLI v2

[ aws . workmail ]

обновить-ресурс

Описание

Обновляет данные для ресурса. Для получения последней информации необходимо выполнить вызов DescribeResource. Набор данных в запросе должен соответствовать ожидаемому при выполнении другого DescribeResource вызова.

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

Синтаксис

  update-resource
--organization-id <value>
--resource-id <value>
[--name <value>]
[--booking-options <value>]
[--description <value>]
[--type <value>]
[--hidden-from-global-address-list | --no-hidden-from-global-address-list]
[--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]

Параметры

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

Идентификатор, связанный с организацией, для которой обновляется ресурс.

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

Идентификатор ресурса, который необходимо обновить.

Идентификатор может принимать значения ResourceId , Resourcename или email . Доступны следующие форматы идентификаторов:

  • Идентификатор ресурса: r-0123456789a0123456789b0123456789
  • Адрес электронной почты: resource@domain.tld
  • Имя ресурса: resource

--name (строка)

Имя ресурса, который необходимо обновить.

--booking-options (структура)

Параметры бронирования ресурса, которые необходимо обновить.

AutoAcceptRequests -> (булево)

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

AutoDeclineRecurringRequests -> (булево)

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

AutoDeclineConflictingRequests -> (булево)

Возможность ресурса автоматически отклонять конфликтующие запросы.

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

AutoAcceptRequests=boolean,AutoDeclineRecurringRequests=boolean,AutoDeclineConflictingRequests=boolean

Синтаксис JSON:

{
  "AutoAcceptRequests": true|false,
  "AutoDeclineRecurringRequests": true|false,
  "AutoDeclineConflictingRequests": true|false
}

--description (строка)

Обновляет описание ресурса.

--type (строка)

Обновляет тип ресурса.

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

  • ROOM
  • EQUIPMENT

--hidden-from-global-address-list | --no-hidden-from-global-address-list (булево)

Если включено, ресурс скрывается из глобального списка адресов.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила кавычек, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам кавычек вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для обновления ресурса

Следующая update-resource команда обновляет имя указанного ресурса.

aws workmail update-resource \
    --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \
    --resource-id r-7afe0efbade843a58cdc10251fce992c \
    --name exampleRoom2

Эта команда не производит никакого вывода.

Вывод

Нет

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

Spec-Zone.ru

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