update-application-settings

Описание

Обновляет настройки приложения.

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

Синтаксис

  update-application-settings
--application-id <value>
--write-application-settings-request <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.

--write-application-settings-request (структура)

Определяет параметры по умолчанию для приложения.

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

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

Чтобы переопределить эти настройки и задать пользовательские настройки для конкретной кампании, используйте объект CampaignHook ресурса Campaign.

LambdaFunctionName -> (строка)

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

Mode -> (строка)

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

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

WebUrl -> (строка)

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

CloudWatchMetricsEnabled -> (булево)

Указывает, включены ли связанные с приложением оповещения в Amazon CloudWatch.

EventTaggingEnabled -> (булево)

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

Параметры по умолчанию для отправки кампаний в приложении. Чтобы переопределить эти лимиты и задать пользовательские лимиты для конкретной кампании или маршрута, используйте соответственно ресурсы Campaignresource или Journeyresource.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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, этот лимит не применяется.

Краткая запись:

CampaignHook={LambdaFunctionName=string,Mode=string,WebUrl=string},CloudWatchMetricsEnabled=boolean,EventTaggingEnabled=boolean,Limits={Daily=integer,MaximumDuration=integer,MessagesPerSecond=integer,Total=integer,Session=integer},QuietTime={End=string,Start=string},JourneyLimits={DailyCap=integer,TimeframeCap={Cap=integer,Days=integer},TotalCap=integer}

Синтаксис JSON:

{
  "CampaignHook": {
    "LambdaFunctionName": "string",
    "Mode": "DELIVERY"|"FILTER",
    "WebUrl": "string"
  },
  "CloudWatchMetricsEnabled": true|false,
  "EventTaggingEnabled": true|false,
  "Limits": {
    "Daily": integer,
    "MaximumDuration": integer,
    "MessagesPerSecond": integer,
    "Total": integer,
    "Session": integer
  },
  "QuietTime": {
    "End": "string",
    "Start": "string"
  },
  "JourneyLimits": {
    "DailyCap": integer,
    "TimeframeCap": {
      "Cap": integer,
      "Days": integer
    },
    "TotalCap": integer
  }
}

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

Включает/выключает вывод в цвете.

on
off
auto

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

Вывод

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

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

ApplicationId -> (строка)

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 -> (структура)

Настройка по умолчанию для бездействия (Quiet Time) для кампаний в приложении. Бездействие — это определенный интервал времени, когда сообщения не отправляются конечным точкам, если выполнены все следующие условия:

Свойство 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, это ограничение не применяется.