Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

получение-настроек-приложения

Описание

Получает информацию о настройках приложения.

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

Синтаксис

  get-application-settings
--application-id <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]

Параметры

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

Уникальный идентификатор приложения. Этот идентификатор отображается как **Идентификатор проекта** на консоли Amazon Pinpoint.

--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
  • таблица
  • 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.

Вывод

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

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

ApplicationId -> (строка)

Уникальный идентификатор приложения. Этот идентификатор отображается как **Идентификатор проекта** на консоли Amazon Pinpoint.

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

Настройки функции AWS Lambda, вызываемой по умолчанию как код-хук для кампаний в приложении. Вы можете использовать этот хук для настройки сегментов, используемых кампаниями в приложении.

LambdaFunctionName -> (строка)

Имя или Amazon Resource Name (ARN) функции AWS Lambda, которую Amazon Pinpoint вызывает для настройки сегмента для кампании.

Mode -> (строка)

Режим, в котором Amazon Pinpoint вызывает функцию AWS Lambda. Возможные значения:

  • FILTER - Вызов функции для настройки сегмента, используемого кампанией.
  • DELIVERY - (Устарело) Ранее вызывалась функция для отправки кампании через пользовательский канал. Эта функциональность больше не поддерживается. Чтобы отправить кампанию через пользовательский канал, используйте объекты CustomDeliveryConfiguration и CampaignCustomMessage кампании.

WebUrl -> (строка)

Веб-адрес, который Amazon Pinpoint использует для вызова функции AWS Lambda через HTTPS.

LastModifiedDate -> (строка)

Дата и время (в формате ISO 8601) последнего изменения настроек приложения.

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

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

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

Максимальное количество сообщений, которое кампания может отправить на один конечный пункт в течение 24 часов. Для приложения это значение задаёт стандартный предел для количества сообщений, которые кампании и маршруты могут отправить на один конечный пункт в течение 24 часов. Максимальное значение равно 100.

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

Максимальное время в секундах, которое кампания может пытаться доставить сообщение после запланированного времени начала кампании. Минимальное значение составляет 60 секунд.

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

Максимальное количество сообщений, которое кампания может отправить в секунду. Для приложения это значение устанавливает стандартный предел для количества сообщений, которые кампании могут отправить в секунду. Минимальное значение равно 1. Максимальное значение равно 20 000.

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

Максимальное количество сообщений, которое кампания может отправить на один конечный пункт за время проведения кампании. Если кампания повторяется, это значение применяется ко всем запускам кампании. Максимальное значение равно 100.

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

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

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

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

  • Свойство EndpointDemographic.Timezone конечного пункта установлено на корректное значение.
  • Текущее время в часовом поясе конечного пункта позже или равно времени, указанному в свойстве QuietTime.Start для приложения (или кампании или маршрута, имеющего пользовательские настройки времени тишины).
  • Текущее время в часовом поясе конечного пункта раньше или равно времени, указанному в свойстве QuietTime.End для приложения (или кампании или маршрута, имеющего пользовательские настройки времени тишины).

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

End -> (строка)

Точное время окончания времени тишины. Это значение должно быть в формате 24-часового времени и в формате ЧЧ:ММ, где ЧЧ — час (с ведущим нулём, если необходимо), а ММ — минуты. Например, используйте 02:30 для обозначения 2:30 утра или 14:30 для обозначения 2:30 дня.

Start -> (строка)

Точное время начала времени тишины. Это значение должно быть в формате 24-часового времени и в формате ЧЧ:ММ, где ЧЧ — час (с ведущим нулём, если необходимо), а ММ — минуты. Например, используйте 02:30 для обозначения 2:30 утра или 14:30 для обозначения 2:30 дня.

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

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

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

Ежедневное количество сообщений, которое конечный пункт может получить от всех маршрутов. Максимальное значение равно 100. Если установлено значение 0, этот предел не будет применяться.

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

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

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

Максимальное количество сообщений, которые все маршруты могут отправить на конечный пункт в течение указанного интервала времени. Максимальное значение равно 100. Если установлено значение 0, этот предел не будет применяться.

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

Длительность интервала времени в днях. Максимальное значение равно 30. Если установлено значение 0, этот предел не будет применяться.

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

Максимальное количество сообщений по умолчанию, которое отдельный маршрут может отправить на один конечный пункт. Максимальное значение равно 100. Если установлено значение 0, этот предел не будет применяться.

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

Spec-Zone.ru

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