Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

get-configuration-set

Описание

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

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

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

Синтаксис

  get-configuration-set
--configuration-set-name <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 (строка)

Имя набора конфигурации, о котором вы хотите получить дополнительную информацию.

--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
  • text
  • table
  • yaml
  • yaml-stream

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

Вывод

ConfigurationSetName -> (строка)

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

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

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

CustomRedirectDomain -> (строка)

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

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

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

TlsPolicy -> (строка)

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

SendingPoolName -> (строка)

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

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

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

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

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

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

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

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

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

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

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

Tags -> (список)

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

(структура)

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

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

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

Key -> (строка)

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

Value -> (строка)

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

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

Spec-Zone.ru

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