Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

create-configuration-set

Описание

Создайте набор конфигураций. Наборы конфигураций — это группы правил, которые можно применять к отправляемым вами электронным письмам. Вы применяете набор конфигураций к электронному письму, указав имя набора конфигураций при вызове Amazon SES API v2. При применении набора конфигураций к электронному письму ко всем правилам в этом наборе конфигураций применяется к письму.

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

Синтаксис

  create-configuration-set
--configuration-set-name <value>
[--tracking-options <value>]
[--delivery-options <value>]
[--reputation-options <value>]
[--sending-options <value>]
[--tags <value>]
[--suppression-options <value>]
[--vdm-options <value>]
[--archiving-options <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]

Параметры

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

Имя набора конфигураций. Имя может содержать до 64 буквенно-цифровых символов, включая буквы, цифры, дефисы (-) и символы подчеркивания (_) только.

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

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

CustomRedirectDomain -> (строка)

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

HttpsPolicy -> (строка)

Политика HTTPS для отслеживания событий открытия и кликов.

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

CustomRedirectDomain=string,HttpsPolicy=string

Синтаксис JSON:

{
  "CustomRedirectDomain": "string",
  "HttpsPolicy": "REQUIRE"|"REQUIRE_OPEN_ONLY"|"OPTIONAL"
}

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

Объект, определяющий пул выделенных IP-адресов, используемых для отправки электронных писем с использованием набора конфигураций.

TlsPolicy -> (строка)

Указывает, требуется ли использовать Transport Layer Security (TLS) для сообщений, использующих набор конфигураций. Если значение равно Require, сообщения будут доставлены только при установлении подключения TLS. Если значение равно Optional, сообщения могут быть доставлены в текстовом формате, если подключение TLS установить невозможно.

SendingPoolName -> (строка)

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

MaxDeliverySeconds -> (целое число)

Максимальное время в секундах, в течение которого Amazon SES API v2 будет пытаться доставить электронное письмо. Если указано, значение должно быть больше или равно 300 секундам (5 минутам) и меньше или равно 50400 секундам (84 минутам).

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

TlsPolicy=string,SendingPoolName=string,MaxDeliverySeconds=long

Синтаксис JSON:

{
  "TlsPolicy": "REQUIRE"|"OPTIONAL",
  "SendingPoolName": "string",
  "MaxDeliverySeconds": long
}

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

Объект, определяющий, собирает ли Amazon SES метрики репутации для отправляемых вами электронных писем, использующих набор конфигураций.

ReputationMetricsEnabled -> (булево значение)

Если true, отслеживание метрик репутации включено для набора конфигураций. Если false, отслеживание метрик репутации отключено для набора конфигураций.

LastFreshStart -> (метка времени)

Дата и время (в формате Unix time) последнего обновления метрик репутации.

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

ReputationMetricsEnabled=boolean,LastFreshStart=timestamp

Синтаксис JSON:

{
  "ReputationMetricsEnabled": true|false,
  "LastFreshStart": timestamp
}

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

Объект, определяющий, может ли Amazon SES отправлять электронные письма, использующие набор конфигураций.

SendingEnabled -> (булево значение)

Если true, отправка электронных писем включена для набора конфигураций. Если false, отправка электронных писем отключена для набора конфигураций.

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

SendingEnabled=boolean

Синтаксис JSON:

{
  "SendingEnabled": true|false
}

--tags (список)

Массив объектов, определяющих теги (ключи и значения), которые необходимо связать с набором конфигураций.

(структура)

Объект, определяющий теги, связанные с ресурсом. Тег — это метка, которую вы можете дополнительно определить и связать с ресурсом. Теги могут помочь вам категоризировать и управлять ресурсами по-разному, например, по назначению, владельцу, среде или другим критериям. Один ресурс может иметь до 50 тегов.

Каждый тег состоит из обязательного ключа тега и связанного с ним значения тега, которые вы определяете. Ключ тега — это общая метка, которая служит категорией для более конкретного значения тега. Значение тега действует как описание в пределах ключа тега. Ключ тега может содержать до 128 символов. Значение тега может содержать до 256 символов. Символы могут быть буквами, цифрами, пробелами Unicode или одним из следующих символов: _ . : / = + -. К тегам также применяются следующие ограничения:

  • Ключи и значения тегов чувствительны к регистру.
  • Для каждого связанного ресурса каждый ключ тега должен быть уникальным и иметь только одно значение.
  • Префикс aws: зарезервирован для использования Amazon Web Services; вы не можете использовать его в ключах или значениях тегов, которые вы определяете. Кроме того, вы не можете изменять или удалять ключи или значения тегов, использующих этот префикс. Теги, использующие этот префикс, не учитываются при ограничении в 50 тегов на ресурс.
  • Вы можете связать теги с общедоступными или совместно используемыми ресурсами, но теги будут доступны только для вашей учетной записи Amazon Web Services, а не для других учетных записей, которые совместно используют ресурс. Кроме того, теги будут доступны только для ресурсов, расположенных в указанном регионе Amazon Web Services для вашей учетной записи Amazon Web Services.

Key -> (строка)

Одна часть пары «ключ-значение», определяющей тег. Максимальная длина ключа тега — 128 символов. Минимальная длина — 1 символ.

Value -> (строка)

Необязательная часть пары «ключ-значение», определяющей тег. Максимальная длина значения тега — 256 символов. Минимальная длина — 0 символов. Если вы не хотите, чтобы у ресурса было конкретное значение тега, не указывайте значение для этого параметра. Если вы не укажете значение, Amazon SES установит значение в пустую строку.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Объект, содержащий информацию о настройках списка подавления для вашей учетной записи.

SuppressedReasons -> (список)

Список, содержащий причины автоматического добавления адресов электронной почты в список подавления для вашей учетной записи. Этот список может содержать любое или все из следующего:

  • COMPLAINT — Amazon SES добавляет адрес электронной почты в список подавления для вашей учетной записи, когда сообщение, отправленное на этот адрес, приводит к жалобе.
  • BOUNCE — Amazon SES добавляет адрес электронной почты в список подавления для вашей учетной записи, когда сообщение, отправленное на этот адрес, приводит к жесткому отказу доставки.

(строка)

Причина добавления адреса в список подавления для вашей учетной записи. Значение может быть одним из следующих:

  • COMPLAINT — Amazon SES добавила адрес электронной почты в список подавления для вашей учетной записи, потому что сообщение, отправленное на этот адрес, привело к жалобе.
  • BOUNCE — Amazon SES добавила адрес электронной почты в список подавления для вашей учетной записи, потому что сообщение, отправленное на этот адрес, привело к жесткому отказу доставки.

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

SuppressedReasons=string,string

Синтаксис JSON:

{
  "SuppressedReasons": ["BOUNCE"|"COMPLAINT", ...]
}

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

Объект, определяющий параметры VDM для электронных писем, которые вы отправляете с использованием набора конфигураций.

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

Указывает дополнительные параметры вашей конфигурации VDM, применимые к панели инструментов.

EngagementMetrics -> (строка)

Указывает состояние сбора метрик вовлечения VDM. Может быть одним из следующих:

  • ENABLED — Amazon SES включает метрики вовлечения для набора конфигураций.
  • DISABLED — Amazon SES отключает метрики вовлечения для набора конфигураций.

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

Указывает дополнительные параметры вашей конфигурации VDM, применимые к Guardian.

OptimizedSharedDelivery -> (строка)

Указывает состояние оптимизированной совместной доставки VDM. Может быть одним из следующих:

  • ENABLED — Amazon SES включает оптимизированную совместную доставку для набора конфигураций.
  • DISABLED — Amazon SES отключает оптимизированную совместную доставку для набора конфигураций.

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

DashboardOptions={EngagementMetrics=string},GuardianOptions={OptimizedSharedDelivery=string}

Синтаксис JSON:

{
  "DashboardOptions": {
    "EngagementMetrics": "ENABLED"|"DISABLED"
  },
  "GuardianOptions": {
    "OptimizedSharedDelivery": "ENABLED"|"DISABLED"
  }
}

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

Объект, определяющий параметры архивирования MailManager для электронных писем, которые вы отправляете с помощью набора конфигураций.

ArchiveArn -> (строка)

Amazon Resource Name (ARN) архива MailManager, в который Amazon SES API v2 будет архивировать отправленные электронные письма.

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

ArchiveArn=string

Синтаксис JSON:

{
  "ArchiveArn": "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 (boolean)

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

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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.

Вывод

Нет

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

Spec-Zone.ru

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