Spec-Zone.ru › AWS CLI v2

[ aws . workmail ]

настройка проверки доступности

Описание

Выполняет проверку поставщика доступности, чтобы убедиться, что доступ разрешен. Для EWS проверяет, можно ли использовать предоставленные учетные данные для успешного входа. Для Lambda проверяет, что функция Lambda может быть вызвана и что политика доступа к ресурсу настроена на отказ от анонимного доступа. Анонимное обращение – это обращение без предоставления заголовка SourceArn или SourceAccount.

Примечание

Запрос должен содержать одно определение поставщика (EwsProvider или LambdaProvider) или параметр DomainName. Если указан параметр DomainName, будет проверена конфигурация, хранящаяся в DomainName.

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

Синтаксис

  test-availability-configuration
--organization-id <value>
[--domain-name <value>]
[--ews-provider <value>]
[--lambda-provider <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]

Параметры

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

Организация WorkMail, где будет проверен поставщик доступности.

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

Домен, к которому применяется поставщик. Если этот параметр указан, будет проверен сохранённый поставщик доступности, связанный с этим именем домена.

--ews-provider (структура)

Описание поставщика доступности на основе EWS. Используется только как входной параметр для сервиса.

EwsEndpoint -> (строка)

Адрес конечной точки удаленного сервера EWS.

EwsUsername -> (строка)

Имя пользователя для аутентификации удаленного сервера EWS.

EwsPassword -> (строка)

Пароль для аутентификации удаленного сервера EWS.

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

EwsEndpoint=string,EwsUsername=string,EwsPassword=string

Синтаксис JSON:

{
  "EwsEndpoint": "string",
  "EwsUsername": "string",
  "EwsPassword": "string"
}

--lambda-provider (структура)

Описание поставщика доступности на основе Lambda.

LambdaArn -> (строка)

Amazon Resource Name (ARN) Lambda-функции, выполняющей роль поставщика доступности.

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

LambdaArn=string

Синтаксис JSON:

{
  "LambdaArn": "string"
}

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

Вывод

TestPassed -> (логическое значение)

Логическое значение, указывающее, прошла ли проверка или нет.

FailureReason -> (строка)

Строка, содержащая причину неудачной проверки, если TestPassed ложно.

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

Spec-Zone.ru

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