Skip to content
AWS for Query.Farm

aws.pinpoint.get_application_settings

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_application_settings
WHERE
"application_id" = 'VALUE';

Description

Retrieves information about the settings for an application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
application_settings_resource

Provides information about an application, including the default settings for an application.

STRUCT(
    "application_id" VARCHAR,
    "campaign_hook" STRUCT(
        "lambda_function_name" VARCHAR,
        "mode" VARCHAR,
        "web_url" VARCHAR
    ),
    "last_modified_date" VARCHAR,
    "limits" STRUCT(
        "daily" BIGINT,
        "maximum_duration" BIGINT,
        "messages_per_second" BIGINT,
        "total" BIGINT,
        "session" BIGINT
    ),
    "quiet_time" STRUCT(
        "end" VARCHAR,
        "start" VARCHAR
    ),
    "journey_limits" STRUCT(
        "daily_cap" BIGINT,
        "timeframe_cap" STRUCT(
            "cap" BIGINT,
            "days" BIGINT
        ),
        "total_cap" BIGINT
    )
)
Show child fields
application_settings_resource.application_id

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

application_settings_resource.campaign_hook

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.

Show child fields
application_settings_resource.campaign_hook.lambda_function_name

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

application_settings_resource.campaign_hook.mode

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

  • FILTER - Invoke the function to customize the segment that's used by a campaign.

  • DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.

application_settings_resource.campaign_hook.web_url

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

application_settings_resource.journey_limits

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.

Show child fields
application_settings_resource.journey_limits.daily_cap

The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.

application_settings_resource.journey_limits.timeframe_cap

The default maximum number of messages that can be sent to an endpoint during the specified timeframe for all journeys.

Show child fields
application_settings_resource.journey_limits.timeframe_cap.cap

The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.

application_settings_resource.journey_limits.timeframe_cap.days

The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.

application_settings_resource.journey_limits.total_cap

The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.

application_settings_resource.last_modified_date

The date and time, in ISO 8601 format, when the application's settings were last modified.

application_settings_resource.limits

The default sending limits for campaigns in the application.

Show child fields
application_settings_resource.limits.daily

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

application_settings_resource.limits.maximum_duration

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

application_settings_resource.limits.messages_per_second

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

application_settings_resource.limits.session

The maximum total number of messages that the campaign can send per user session.

application_settings_resource.limits.total

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

application_settings_resource.quiet_time

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.

Show child fields
application_settings_resource.quiet_time.end

The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (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.

application_settings_resource.quiet_time.start

The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (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.