application_settings

Creates, updates, deletes, gets or lists an application_settings resource.

Overview

Name	application_settings
Type	Resource
Id	aws.pinpoint.application_settings

Fields

The following fields are returned by SELECT queries:

get_application_settings

Name	Datatype	Description
application_id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
campaign_hook	object	The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
journey_limits	object	The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
last_modified_date	string	The date and time, in ISO 8601 format, when the application's settings were last modified.
limits	object	The default sending limits for campaigns in the application.
quiet_time	object	The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application_settings	select	application-id, region		Retrieves information about the settings for an application.
update_application_settings	update	application-id, region, WriteApplicationSettingsRequest		Updates the settings for an application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)

SELECT examples

get_application_settings

Retrieves information about the settings for an application.

SELECT
application_id,
campaign_hook,
journey_limits,
last_modified_date,
limits,
quiet_time
FROM aws.pinpoint.application_settings
WHERE `application-id` = '{{ application-id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_application_settings

Updates the settings for an application.

UPDATE aws.pinpoint.application_settings
SET 
WriteApplicationSettingsRequest = '{{ WriteApplicationSettingsRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND WriteApplicationSettingsRequest = '{{ WriteApplicationSettingsRequest }}' --required
RETURNING
application_settings_resource;