[ aws . pinpoint-email ]
создать отчёт о тестировании доставки
Описание
Создайте новый тест прогнозируемого размещения в папке «Входящие». Тесты прогнозируемого размещения в папке «Входящие» могут помочь вам спрогнозировать, как различные поставщики электронной почты по всему миру будут обрабатывать ваши сообщения. Когда вы выполняете тест прогнозируемого размещения в папке «Входящие», вы предоставляете пример сообщения, содержащего содержимое, которое вы планируете отправлять своим клиентам. Amazon Pinpoint затем отправляет это сообщение на специальные адреса электронной почты, распределенные по нескольким основным поставщикам электронной почты. По прошествии примерно 24 часов тест завершается, и вы можете использовать операцию GetDeliverabilityTestReport, чтобы просмотреть результаты теста.
См. также: Документацию API AWS
Синтаксис
create-deliverability-test-report
[--report-name <value>]
--from-email-address <value>
--content <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]
Параметры
--report-name (строка)
--from-email-address (строка)
--content (структура)
HTML-тело сообщения, которое вы отправили при выполнении теста прогнозируемого размещения в папке «Входящие».
Simple -> (структура)
Простое электронное сообщение. Сообщение состоит из темы и тела сообщения.
Subject -> (структура)
Заголовок сообщения электронной почты. Заголовок может содержать только символы ASCII 7-битной кодировки. Однако вы можете указать не-ASCII символы в заголовке, используя синтаксис encoded-word, как описано в RFC 2047.
Data -> (строка)
Charset -> (строка)
UTF-8 , ISO-8859-1 или Shift_JIS .Body -> (структура)
Тело сообщения. Вы можете указать HTML-версию сообщения, текстовую версию или обе.
Text -> (структура)
Объект, представляющий версию сообщения, отображаемую в клиентах электронной почты, которые не поддерживают HTML, или в клиентах, где получатель отключил отображение HTML.
Data -> (строка)
Charset -> (строка)
UTF-8 , ISO-8859-1 или Shift_JIS .Html -> (структура)
Объект, представляющий версию сообщения, отображаемую в клиентах электронной почты, которые поддерживают HTML. HTML-сообщения могут содержать форматированный текст, гиперссылки, изображения и многое другое.
Data -> (строка)
Charset -> (строка)
UTF-8 , ISO-8859-1 или Shift_JIS .Raw -> (структура)
Исходное сообщение электронной почты. Сообщение должно соответствовать следующим критериям:
- Сообщение должно содержать заголовок и тело, разделенные одной пустой строкой.
- Все необходимые поля заголовка должны быть присутствовать в сообщении.
- Каждая часть сообщения MIME в формате multipart должна быть отформатирована правильно.
- Если вы включаете вложения, они должны быть в формате файла, поддерживаемом Amazon Pinpoint.
- Все сообщение должно быть закодировано в Base64.
- Если какие-либо части MIME вашего сообщения содержат содержимое, выходящее за пределы диапазона символов ASCII 7-битной кодировки, вы должны закодировать это содержимое для правильного отображения сообщения в клиентах электронной почты получателей.
- Длина любой отдельной строки текста в сообщении не должна превышать 1000 символов. Это ограничение определено в RFC 5321.
Data -> (бинарный)
Исходное сообщение электронной почты. Сообщение должно соответствовать следующим критериям:
- Сообщение должно содержать заголовок и тело, разделенные одной пустой строкой.
- Все необходимые поля заголовка должны быть присутствовать в сообщении.
- Каждая часть сообщения MIME в формате multipart должна быть отформатирована правильно.
- Вложения должны быть в формате файла, поддерживаемом Amazon Pinpoint.
- Все сообщение должно быть закодировано в Base64.
- Если какие-либо части MIME вашего сообщения содержат содержимое, выходящее за пределы диапазона символов ASCII 7-битной кодировки, вы должны закодировать это содержимое для правильного отображения сообщения в клиентах электронной почты получателей.
- Длина любой отдельной строки текста в сообщении не должна превышать 1000 символов. Это ограничение определено в RFC 5321.
Template -> (структура)
Шаблон для использования в сообщении электронной почты.
TemplateArn -> (строка)
TemplateData -> (строка)
Синтаксис JSON:
{
"Simple": {
"Subject": {
"Data": "string",
"Charset": "string"
},
"Body": {
"Text": {
"Data": "string",
"Charset": "string"
},
"Html": {
"Data": "string",
"Charset": "string"
}
}
},
"Raw": {
"Data": blob
},
"Template": {
"TemplateArn": "string",
"TemplateData": "string"
}
}
--tags (список)
Массив объектов, определяющих теги (ключи и значения), которые вы хотите связать с тестом прогнозируемого размещения в папке «Входящие».
(структура)
Объект, определяющий теги, связанные с ресурсом. Тег — это метка, которую вы необязательно определяете и связываете с ресурсом в Amazon Pinpoint. Теги могут помочь вам классифицировать и управлять ресурсами различными способами, например, по назначению, владельцу, среде или другим критериям. Ресурс может иметь до 50 тегов.
Каждый тег состоит из обязательного ключа тега и связанного с ним значения тега, которые вы определяете. Ключ тега — это общая метка, которая служит категорией для более конкретного значения тега. Значение тега выступает в качестве описателя в рамках ключа тега. Ключ тега может содержать до 128 символов. Значение тега может содержать до 256 символов. Символы могут быть буквами, цифрами, пробелами Unicode или одним из следующих символов: _ . : / = + -. К тегам применяются следующие дополнительные ограничения:
- Ключи и значения тегов чувствительны к регистру.
- Для каждого связанного ресурса каждый ключ тега должен быть уникальным и иметь только одно значение.
- Префикс
aws:зарезервирован для использования AWS; вы не можете использовать его в ключах или значениях тегов, которые вы определяете. Кроме того, вы не можете изменять или удалять ключи или значения тегов, использующие этот префикс. Теги, использующие этот префикс, не учитываются при подсчете предела в 50 тегов на ресурс. - Вы можете связать теги с общедоступными или совместными ресурсами, но теги доступны только для вашей учетной записи AWS, а не для других учетных записей, которые совместно используют ресурс. Кроме того, теги доступны только для ресурсов, которые находятся в указанной области AWS для вашей учетной записи AWS.
Key -> (строка)
Value -> (строка)
Сокращенный синтаксис:
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 (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)
Файл с сертификатом корневого удостоверения для проверки 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 версии 1, и бинарные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляемого с бинарным блоком 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.
Вывод
ReportId -> (string)
DeliverabilityTestStatus -> (string)
IN_PROGRESS , то тест предсказания расположения ящика для входящей почты в настоящее время выполняется. Тесты предсказания расположения ящика для входящей почты обычно завершаются в течение 24 часов после создания теста. Если статус COMPLETE , то тест завершен, и вы можете использовать GetDeliverabilityTestReport для просмотра результатов теста.
© Copyright 2025, Amazon Web Services. Created using Sphinx.