A *channel* is a type of platform that you can deliver messages to.

You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application.

The ADMChannel resource represents the status and authentication settings for the ADM channel for an application.

CfnADMChannel

The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.

applicationId

The Client ID that you received from Amazon to send messages by using ADM.

clientId

The Client Secret that you received from Amazon to send messages by using ADM.

clientSecret

Specifies whether to enable the ADM channel for the application.

enabled

A *channel* is a type of platform that you can deliver messages to.

You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application.

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

CfnAPNSChannel

The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.

The bundle identifier that's assigned to your iOS app.

This identifier is used for APNs tokens.

bundleId

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

certificate

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Valid options are `key` or `certificate` .

defaultAuthenticationMethod

Specifies whether to enable the APNs channel for the application.

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

privateKey

The identifier that's assigned to your Apple Developer Account team.

This identifier is used for APNs tokens.

teamId

The authentication key to use for APNs tokens.

tokenKey

The key identifier that's assigned to your APNs signing key.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

tokenKeyId

A *channel* is a type of platform that you can deliver messages to.

You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application.

The APNSSandboxChannel resource represents the status and authentication settings of the APNs sandbox channel for an application.

CfnAPNSSandboxChannel

The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to.

Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application.

A *channel* is a type of platform that you can deliver messages to.

You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application.

The APNSVoipChannel resource represents the status and authentication settings of the APNs VoIP channel for an application.

CfnAPNSVoipChannel

The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.

Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.

A *channel* is a type of platform that you can deliver messages to.

You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application.

The APNSVoipSandboxChannel resource represents the status and authentication settings of the APNs VoIP sandbox channel for an application.

CfnAPNSVoipSandboxChannel

The unique identifier for the application that the APNs VoIP sandbox channel applies to.

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

Specifies whether the APNs VoIP sandbox channel is enabled for the application.

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

The identifier that's assigned to your Apple developer account team.

This identifier is used for APNs tokens.

The key identifier that's assigned to your APNs signing key.

Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

An *app* is an Amazon Pinpoint application, also referred to as a *project* .

An application is a collection of related settings, customer information, segments, campaigns, and other types of Amazon Pinpoint resources.

The App resource represents an Amazon Pinpoint application.

CfnApp

name

An array of key-value pairs to apply to this resource.

For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CfnApplicationSettings

The unique identifier for the Amazon Pinpoint application.

The settings for the Lambda function to use by default as a code hook for campaigns in the application.

To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.

campaignHook

cloudWatchMetricsEnabled

The default sending limits for campaigns in the application.

To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.

limits

The default quiet time for campaigns in the application.

Quiet time is a specific time range when campaigns don't send messages 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 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 that has custom quiet time settings).

If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.

To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.

quietTime

A *channel* is a type of platform that you can deliver messages to.

You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application.

The BaiduChannel resource represents the status and authentication settings of the Baidu channel for an application.

CfnBaiduChannel

The API key that you received from the Baidu Cloud Push service to communicate with the service.

apiKey

The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for.

The secret key that you received from the Baidu Cloud Push service to communicate with the service.

secretKey

Specifies whether to enable the Baidu channel for the application.

Specifies the settings for a campaign.

A *campaign* is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

CfnCampaign

The unique identifier for the Amazon Pinpoint application that the campaign is associated with.

schedule

The unique identifier for the segment to associate with the campaign.

segmentId

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

additionalTreatments

Specifies the Lambda function to use as a code hook for a campaign.

The delivery configuration settings for sending the treatment through a custom channel.

This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object.

customDeliveryConfiguration

description

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

holdoutPercent

Specifies whether to pause the campaign.

A paused campaign doesn't run unless you resume it by changing this value to `false` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

isPaused

The message configuration settings for the treatment.

messageConfiguration

An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.

If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

priority

The version of the segment to associate with the campaign.

segmentVersion

The message template to use for the treatment.

templateConfiguration

treatmentDescription

treatmentName

A *channel* is a type of platform that you can deliver messages to.

You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.

The EmailChannel resource represents the status, identity, and other settings of the email channel for an application

CfnEmailChannel

The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.

The verified email address that you want to send email from when you send email through the channel.

fromAddress

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

identity

The [Amazon SES configuration set](https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) that you want to apply to messages that you send through the channel.

configurationSet

Specifies whether to enable the email channel for the application.

The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .

orchestrationSendingRoleArn

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

roleArn

Creates a message template that you can use in messages that are sent through the email channel.

A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

CfnEmailTemplate

The subject line, or title, to use in email messages that are based on the message template.

subject

templateName

A JSON object that specifies the default values to use for message variables in the message template.

This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

defaultSubstitutions

The message body, in HTML format, to use in email messages that are based on the message template.

We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

htmlPart

A custom description of the message template.

templateDescription

The message body, in plain text format, to use in email messages that are based on the message template.

We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

textPart

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

CfnEventStream

The unique identifier for the Amazon Pinpoint application that you want to export data from.

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want to publish event data to.

For a Kinesis Data Stream, the ARN format is: `arn:aws:kinesis: region : account-id :stream/ stream_name`

For a Firehose delivery stream, the ARN format is: `arn:aws:firehose: region : account-id :deliverystream/ stream_name`

destinationStreamArn

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

A *channel* is a type of platform that you can deliver messages to.

You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaced the Google Cloud Messaging (GCM) service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application.

The GCMChannel resource represents the status and authentication settings of the GCM channel for an application.

CfnGCMChannel

The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.

The Web API key, also called the *server key* , that you received from Google to communicate with Google services.

The default authentication method used for GCM.

Values are either "TOKEN" or "KEY". Defaults to "KEY".

Specifies whether to enable the GCM channel for the Amazon Pinpoint application.

The contents of the JSON file provided by Google during registration in order to generate an access token for authentication.

For more information see [Migrate from legacy FCM APIs to HTTP v1](https://docs.aws.amazon.com/https://firebase.google.com/docs/cloud-messaging/migrate-v1) .

serviceJson

Creates a message template that you can use to send in-app messages.

A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications. The In-App channel is unavailable in AWS GovCloud (US).

CfnInAppTemplate

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

content

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

customConfig

A string that determines the appearance of the in-app message. You can specify one of the following:.

- `BOTTOM_BANNER` – a message that appears as a banner at the bottom of the page.
- `TOP_BANNER` – a message that appears as a banner at the top of the page.
- `OVERLAYS` – a message that covers entire screen.
- `MOBILE_FEED` – a message that appears in a window in front of the page.
- `MIDDLE_BANNER` – a message that appears as a banner in the middle of the page.
- `CAROUSEL` – a scrollable layout of up to five unique messages.

layout

An optional description of the in-app template.

Creates a message template that you can use in messages that are sent through a push notification channel.

A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

CfnPushTemplate

The name of the message template to use for the message.

If specified, this value must match the name of an existing message template.

The message template to use for the ADM (Amazon Device Messaging) channel.

This message template overrides the default template for push notification channels ( `Default` ).

The message template to use for the APNs (Apple Push Notification service) channel.

This message template overrides the default template for push notification channels ( `Default` ).

apns

The message template to use for the Baidu (Baidu Cloud Push) channel.

This message template overrides the default template for push notification channels ( `Default` ).

baidu

The default message template to use for push notification channels.

default

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

This message template overrides the default template for push notification channels ( `Default` ).

Updates the configuration, dimension, and other settings for an existing segment.

CfnSegment

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

The name of the segment.

> A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.

An array that defines the dimensions for the segment.

dimensions

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.

A segment group can consist of zero or more base segments. Your request can include only one segment group.

segmentGroups

A *channel* is a type of platform that you can deliver messages to.

To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.

The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.

CfnSMSChannel

The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

Specifies whether to enable the SMS channel for the application.

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

> SenderIDs are only supported in certain countries and regions. For more information, see [Supported Countries and Regions](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) in the *Amazon Pinpoint User Guide* .

senderId

The registered short code that you want to use when you send messages through the SMS channel.

> For information about obtaining a dedicated short code for sending SMS messages, see [Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html) in the *Amazon Pinpoint User Guide* .

shortCode

Creates a message template that you can use in messages that are sent through the SMS channel.

A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

CfnSmsTemplate

The message body to use in text messages that are based on the message template.

body

A *channel* is a type of platform that you can deliver messages to.

To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.

The VoiceChannel resource represents the status and other information about the voice channel for an application.

CfnVoiceChannel

The unique identifier for the Amazon Pinpoint application that the voice channel applies to.

Specifies whether to enable the voice channel for the application.

AWS pinpoint

L1 Constructs19