Managing Amazon Pinpoint projects - Amazon Pinpoint

Managing Amazon Pinpoint projects

You can use the Amazon Pinpoint console to create, view, edit, and delete projects. Within a project, you can also import endpoints, build segments, create campaigns, create journeys, and view analytics data for that project.

Use the General settings page to specify when Amazon Pinpoint can send messages for campaigns and journeys in the current project and how many messages Amazon Pinpoint can send for those campaigns and journeys. This includes settings such as the time frame for sending messages and the maximum number of messages to send to each endpoint. You can also use the General settings page to delete a project.

Creating a project

The procedure for creating a new project differs depending on whether your account already contains projects in the current AWS Region.

The procedures in this section show you how to create a new project. If you've never created a project in Amazon Pinpoint, complete the procedures in this section.

If your Amazon Pinpoint account includes one or more existing projects, you should complete the steps in Option 2: Create and configure a project (existing Amazon Pinpoint users) instead.

To create a project
  1. Sign in to the AWS Management Console and open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. If this is your first time using Amazon Pinpoint, you see a page that introduces you to the features of the service.

    In the Get started section, enter a name for your project, and then choose Create a project. The project name that you specify can contain up to 64 characters.

    Note

    You can't rename a project after it's been created.

  3. On the Configure features page, choose a channel to configure. For example, if you plan to use the project to send email, choose the Configure button in the Email section.

    When you choose to set up a channel, you see options related to configuring that channel. For example, if you choose to set up the email channel, you see options related to verifying an email address. If you choose to , you see options related to setting your spending limit and default message type.

    Note

    You can configure additional channels in this project later. You aren't limited to only sending messages through the channel that you configured during this process.

The procedures in this section show you how to create a project if your Amazon Pinpoint account already includes one or more existing projects.

If your Amazon Pinpoint account doesn't contain any projects, you should complete the steps in Option 1: Create and configure a project (new Amazon Pinpoint users) instead.

To create a project
  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. On the All projects page, choose Create a project.

  3. On the Create a project window, for Project name, enter a name for your project, and then choose Create. The project name that you specify can contain up to 64 characters.

  4. On the Configure features page, choose a channel to configure. For example, if you plan to use the project to send email, choose the Configure button in the Email section.

    When you choose to set up a channel, you see options related to configuring that channel. For example, if you choose to set up the email channel, you see options related to verifying an email address. If you choose to set up the SMS channel, you see options related to setting your spending limit and default message type.

    Note

    You can configure additional channels in this project later. You aren't limited to only sending messages through the channel that you configured during this process.

    If you prefer to set up channels later, choose Skip this step.

Editing a project's default settings

On the General settings page, you can configure default settings and quotas that you want to apply to campaigns and journeys in a project. When you change these settings, Amazon Pinpoint automatically applies them to all new campaigns and journeys that you create for the project. The settings aren't applied to any campaigns or journeys that you previously created. You can also configure these same settings for individual campaigns and journeys. If you configure settings for an individual campaign or journey, those settings override the settings that you choose on the General settings page.

To configure default settings for a project
  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. On the All projects page, choose the project that you want to change the default settings for.

  3. In the navigation pane, under Settings, choose General settings.

  4. Choose Edit.

  5. On the Edit general settings page, change any of the following settings:

    1. Campaign settings

      Quiet time hours

      Use these settings to prevent Amazon Pinpoint from sending messages during specific hours. When you configure these settings, you provide a Start time and an End time. If a message would be sent between the start and end times in an endpoint's local time zone, Amazon Pinpoint doesn't attempt to send the message to that endpoint.

      Note

      In order for this setting to observe local time zones, the endpoint definition for a recipient has to include a properly-formatted Demographic.Timezone attribute.

      The times that you specify must use 24-hour notation and be in HH:MM format. For example, for 9:30 PM, enter 21:30.

      Maximum number of daily messages per endpoint

      Use this setting to specify the maximum number of messages that can be sent to a single endpoint during a 24-hour period by all the campaigns in the project. The value that you specify can't be larger than 100.

      Note

      In certain situations, it's possible for an endpoint to receive a number of messages that exceed the value that you specify in this setting. For example, assume that this setting is configured to send a maximum of five messages per day. If you have 10 campaigns that target the endpoint, and all 10 are launched at the same time, then the endpoint receives 10 messages. However, if there are 10 campaigns that target the endpoint, and the start times for the campaigns are separated by several minutes, then the recipient only receives five messages.

      Maximum number of messages per endpoint

      Use this setting to specify the maximum number of messages that can be sent to a single endpoint by each campaign. If a campaign recurs, this setting applies to all runs of the campaign. The value that you specify can't be larger than 100.

      Note

      This setting considers the number of messages that target an endpoint, as opposed to the number of messages that are actually delivered to an endpoint. For example, if a campaign is configured to automatically send a message when a customer creates a new account, but the endpoint isn't able to receive the message (for example, if the quiet time setting applies to the endpoint), then the endpoint is still counted as having been targeted. In this situation, the endpoint would be removed from subsequent runs of the campaign.

      Maximum number of messages per second

      Use this setting to specify the maximum number of messages that can be sent each second by a campaign. The value that you specify has to be a number between 1 and 20,000. If you define a messages per second parameter, we try to match it. Otherwise, if this isn't defined, we attempt to deliver the message as fast as possible. Note that delivery speed, however, is dependent on channel latency at any given time.

      Maximum amount of time for a campaign run

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

    2. Journey settings

      Maximum daily messages per endpoint across all journeys

      Use this setting to specify the maximum number of times in a 24 hour period that an endpoint can be messaged across all journeys. The default value is zero and means that there is no limit on the number of times an endpoint can be messaged in a 24 hour period.

      Maximum number of messages across all journeys within a time frame

      Use this setting to specify the maximum number of times a message can be sent to a single endpoint within the specified Timeframe. For example, if you want to send a maximum of three messages within a Timeframe of seven days to each endpoint. The default setting is 0, which means that there is no limit on the number of messages that endpoints in the journey can receive.

      Timeframe

      The number of days applied to the Maximum number of messages across all journeys within a time frame if not set to 0. The default setting is 0, which means that there is no limit on the number of days that endpoints in the journey can receive.

  6. When you finish, choose Save.

Deleting a project

If you want to remove a project from Amazon Pinpoint completely, you can delete the project by using the Amazon Pinpoint console.

Warning

If you delete a project, Amazon Pinpoint deletes all project-specific settings, campaigns, journeys, and other information for the project. The information can't be recovered.

When you delete a project, Amazon Pinpoint deletes all project-specific settings for the push notification and two-way SMS messaging channels, and all segments, campaigns, journeys, and project-specific analytics data that's stored in Amazon Pinpoint, such as the following:

  • Segments – All segment settings and data. For dynamic segments, this includes segment groups and filters that you defined. For imported segments, this includes endpoints, user IDs, and other data that you imported, and any filters that you applied.

  • Campaigns – All messages, message treatments and variables, analytics data, schedules, and other settings.

  • Journeys – All activities, analytics data, schedules, and other settings.

  • Analytics – Data for all engagement metrics, such as the number of messages sent and delivered for campaigns and journeys, and all journey execution metrics. For mobile and web apps, all event data that wasn't streamed to another AWS service such as Amazon Kinesis, all funnels, and data for application usage, revenue, and demographic metrics. Before you delete a project, we recommend that you export this data to another location. For more information, see Exporting dashboards.

Note that account-level settings and data for your Amazon Pinpoint account and your AWS account aren't deleted. This includes:

  • Message templates.

  • Production access and sending quotas for channels.

  • Dedicated phone numbers for sending SMS and voice messages, and for receiving SMS messages.

  • Verified identities for sending email and SMS messages.

  • SMS information such as short codes, long codes, keywords, and registered sender IDs for sending SMS messages.

  • SMTP credentials and other settings for sending email by using the Amazon Pinpoint SMTP interface.

  • Configuration settings for connecting to and using machine learning models.

In addition, data that's stored in other AWS services isn't deleted. This includes event data that you streamed to other AWS services such as Amazon Kinesis, files that you imported from an Amazon Simple Storage Service (Amazon S3) bucket to define a segment, and any Amazon Pinpoint metrics and spending alarms that you configured in Amazon CloudWatch.

To delete a project
  1. Open the Amazon Pinpoint console at https://console.aws.amazon.com/pinpoint/.

  2. On the All projects page, choose the project that you want to delete.

  3. In the navigation pane, under Settings, choose General settings.

  4. Choose Delete project.

  5. Enter the name of the project that you want to delete, and then choose Ok.