Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-application-settings

Description

Used to update the settings for an app.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-application-settings
--application-id <value>
--write-application-settings-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string) The unique ID of your Amazon Pinpoint application.

--write-application-settings-request (structure) Creating application setting request

Shorthand Syntax:

CampaignHook={LambdaFunctionName=string,Mode=string,WebUrl=string},CloudWatchMetricsEnabled=boolean,Limits={Daily=integer,MaximumDuration=integer,MessagesPerSecond=integer,Total=integer},QuietTime={End=string,Start=string}

JSON Syntax:

{
  "CampaignHook": {
    "LambdaFunctionName": "string",
    "Mode": "DELIVERY"|"FILTER",
    "WebUrl": "string"
  },
  "CloudWatchMetricsEnabled": true|false,
  "Limits": {
    "Daily": integer,
    "MaximumDuration": integer,
    "MessagesPerSecond": integer,
    "Total": integer
  },
  "QuietTime": {
    "End": "string",
    "Start": "string"
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ApplicationSettingsResource -> (structure)

Application settings.

ApplicationId -> (string)

The unique ID for the application.

CampaignHook -> (structure)

Default campaign hook.

LambdaFunctionName -> (string)

Lambda function name or arn to be called for delivery

Mode -> (string)

What mode Lambda should be invoked in.

WebUrl -> (string)

Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

LastModifiedDate -> (string)

The date that the settings were last updated in ISO 8601 format.

Limits -> (structure)

The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.

Daily -> (integer)

The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period.

MaximumDuration -> (integer)

The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.

MessagesPerSecond -> (integer)

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

Total -> (integer)

The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.

QuietTime -> (structure)

The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.

End -> (string)

The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Start -> (string)

The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable), and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.