Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

Поиск адресов электронной почты

Описание

Ищет адреса электронной почты в экземпляре с дополнительным фильтрованием.

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

Синтаксис

  search-email-addresses
--instance-id <value>
[--max-results <value>]
[--next-token <value>]
[--search-criteria <value>]
[--search-filter <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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Идентификатор экземпляра можно найти в имени Amazon Resource Name (ARN) экземпляра.

--max-results (целое число)

Максимальное количество результатов на странице.

--next-token (строка)

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

--search-criteria (структура)

Критерии поиска для возврата адресов электронной почты.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием ИЛИ.

(структура)

Критерии поиска для возврата адресов электронной почты.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием ИЛИ.

(… рекурсивно …)

AndConditions -> (список)

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

(… рекурсивно …)

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

Условие узла листа, которое может быть использовано для указания условия строки.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения для оценки условия строки.

AndConditions -> (список)

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

(структура)

Критерии поиска для возврата адресов электронной почты.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием ИЛИ.

(… рекурсивно …)

AndConditions -> (список)

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

(… рекурсивно …)

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

Условие узла листа, которое может быть использовано для указания условия строки.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения для оценки условия строки.

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

Условие узла листа, которое может быть использовано для указания условия строки.

FieldName -> (строка)

Имя поля в условии строки.

Value -> (строка)

Значение строки.

ComparisonType -> (строка)

Тип сравнения для оценки условия строки.

Синтаксис JSON:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  }
}

--search-filter (структура)

Фильтры, которые будут применяться к результатам поиска.

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

Объект, который может быть использован для указания условий тегов в SearchFilter. Это принимает OR входной данных AND (список списков), где:

  • Вложенный список определяет условия, которые необходимо применить с оператором OR
  • Внутренний список определяет условия, которые необходимо применить с оператором AND.

OrConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(список)

(структура)

Условие узла листа, которое можно использовать для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

AndConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое можно использовать для указания условия тега, например, HAVE BPO = 123.

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

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

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

TagKey -> (строка)

Ключ тега в условии тега.

TagValue -> (строка)

Значение тега в условии тега.

Синтаксис JSON:

{
  "TagFilter": {
    "OrConditions": [
      [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ]
      ...
    ],
    "AndConditions": [
      {
        "TagKey": "string",
        "TagValue": "string"
      }
      ...
    ],
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "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.

Вывод

NextToken -> (строка)

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

EmailAddresses -> (список)

Список адресов электронной почты, соответствующих SearchFilter и SearchCriteria

(структура)

Содержит информацию об адресе электронной почты для контактного центра.

EmailAddressId -> (строка)

Идентификатор адреса электронной почты.

EmailAddressArn -> (строка)

Имя Amazon Resource Name (ARN) адреса электронной почты.

EmailAddress -> (строка)

Адрес электронной почты с экземпляром в формате [^s@]+@[^s@]+.[^s@]+.

Description -> (строка)

Описание адреса электронной почты.

DisplayName -> (строка)

Имя для отображения адреса электронной почты.

ApproximateTotalCount -> (длинное целое число)

Общее количество адресов электронной почты, которые соответствуют вашему запросу.

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

Spec-Zone.ru

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