Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

create-configuration-set

Описание

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

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

Синтаксис

  create-configuration-set
--configuration-set-name <value>
[--tracking-options <value>]
[--delivery-options <value>]
[--reputation-options <value>]
[--sending-options <value>]
[--tags <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 (строка)

Имя набора конфигурации.

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

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

CustomRedirectDomain -> (строка)

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

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

CustomRedirectDomain=string

Синтаксис JSON:

{
  "CustomRedirectDomain": "string"
}

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

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

TlsPolicy -> (строка)

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

SendingPoolName -> (строка)

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

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

TlsPolicy=string,SendingPoolName=string

Синтаксис JSON:

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

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

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

ReputationMetricsEnabled -> (булево)

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

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

Дата и время (в формате Unix time) последнего полного сброса метрик репутации. При сбросе параметров вашей учетной записи метрики репутации рассчитываются начиная с даты сброса.

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

ReputationMetricsEnabled=boolean,LastFreshStart=timestamp

Синтаксис JSON:

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

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

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

SendingEnabled -> (булево)

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

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

SendingEnabled=boolean

Синтаксис JSON:

{
  "SendingEnabled": true|false
}

--tags (список)

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

(структура)

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

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

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

Key -> (строка)

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

Value -> (строка)

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

Нет

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

Spec-Zone.ru

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