Configuration sets - Amazon Pinpoint SMS
Managing configuration set

Configuration sets

A configuration set is a set of rules that are applied when you send a message. For example, a configuration set can specify a destination for events related to a message. When SMS events occur (such as delivery or failure events), they are routed to the destination associated with the configuration set that you specified when you sent the message. You're not required to use configuration sets when you send messages, but we recommend that you do. If you don't specify a configuration set with an event destination, the API doesn't emit event records. These event records are a useful way to determine how many messages you sent, how much you paid for each one, and whether or not the message was received by the recipient.

Topics

Managing configuration set

This section contains information about using the AWS CLI and AWS Console to manage configuration sets. The procedures in this section assume that you've already configured the AWS CLI. For more information, see Getting started with the AWS CLI in the AWS Command Line Interface User Guide.

Note

Once you've created the configuration set you need to add at least one event destination to record events to. For more information, see Managing event destinations.

Creating a configuration set (Console)

To create a configuration set using the Amazon Pinpoint SMS console, follow these steps:

  1. Open the Amazon Pinpoint SMS console at https://console.aws.amazon.com/sms-voice/.

  2. In the navigation pane, under Configurations, choose Configuration sets and then Create configuration set.

  3. For Configuration set name enter a descriptive name for the configuration set.

  4. Choose Create configuration set.

Creating a configuration set (AWS CLI)

You can use the create-configuration-set command to create a new configuration set.

$ aws pinpoint-sms-voice-v2 create-configuration-set \
> --configuration-set-name configurationSet

In the preceding command, replace configurationSet with the name of the configuration set that you want to create.

Deleting a configuration set (Console)

To delete a configuration set using the Amazon Pinpoint SMS console, follow these steps:

  1. Open the Amazon Pinpoint SMS console at https://console.aws.amazon.com/sms-voice/.

  2. In the navigation pane, under Configurations, choose Configuration sets.

  3. Select the Configuration set you want to delete and then choose Delete.

Deleting a configuration set (AWS CLI)

You can use the delete-configuration-set command to delete a configuration set.

$ aws pinpoint-sms-voice-v2 delete-configuration-set \
> --configuration-set-name configurationSet

In the preceding command, replace configurationSet with the name of the configuration set that you want to delete.

Edit configuration set settings (Console)

To edit a configuration set using the Amazon Pinpoint SMS console, follow these steps:

  1. Open the Amazon Pinpoint SMS console at https://console.aws.amazon.com/sms-voice/.

  2. In the navigation pane, under Configurations, choose Configuration sets.

  3. On the Configuration sets page choose the configuration set to edit.

  4. Select the Set settings tab and then choose Edit settings.

  5. In List settings do the following:

    • Message type choose either:

      • Promotional – Choose this option for sending marketing messages or messages promoting your business or service.

      • Transactional – Choose this option for sending time-sensitive messages, such as password resets or transaction alerts.

    • Default sender ID – Choose the default sender ID for the configuration set.

  6. Choose Save changes.

List configuration sets (AWS CLI)

You can use the describe-configuration-sets command to view information about the configuration sets in your Amazon Pinpoint SMS account.

To view a list of the configuration sets in your account using the AWS CLI

  • At the command line, enter the following command:

    $ aws pinpoint-sms-voice-v2 describe-configuration-sets
Describe a configuration set (AWS CLI)

You can use the describe-configuration-sets command to view information about a configuration set in your Amazon Pinpoint SMS account.

To view information about specific configuration sets using the AWS CLI

  • At the command line, enter the following command:

    $ aws pinpoint-sms-voice-v2 describe-configuration-sets \ 
> --configuration-set-names configurationSet

In the preceding command, replace configurationSet with the name of the configuration set that you want to find the details of. You can also specify multiple configuration sets by separating the name of each configuration set with a space.

Manage tags (Console)

Use the Amazon Pinpoint SMS console to add, edit or delete a Tag.

Add a Tag (Console)

  1. Open the Amazon Pinpoint SMS console at https://console.aws.amazon.com/sms-voice/.

  2. In the navigation pane, under Configurations, choose Configuration sets.

  3. On the Configuration sets page choose the configuration set to add a tag to.

  4. On the Tags tab choose Manage tags.

    • Add a tag – In Manage tags choose Add new tag to create a new blank key/value pair.

    • Delete a tag – In Manage tags choose Remove next to the key/value pair.

    • Edit a tag – In Manage tags choose the Key or Value and edit the text.

  6. Choose Save changes.

Manage tags (AWS CLI)

Use the AWS CLI to add or edit a Tag. 

$ aws pinpoint-sms-voice-v2 tag-resource \
  --resource-arn resource-arn \
  --tags tags={key1=value1,key2=value2}

In the preceding example, do the following:

  • Replace resource-arn with the Amazon Resource Name (ARN) that you want to add the tags to.

  • Replace key1 and key2 with the keys of the tags that you want to add to the resource.

  • Replace value1 and value2 with the values of the tags that you want to add for the respective keys.

Use the AWS CLI to delete a Tag. 

$ aws pinpoint-sms-voice-v2 untag-resource \
  --resource-arn resource-arn \
  --tag-keys tags={key1=value1,key2=value2}

In the preceding example, do the following:

  • Replace resource-arn with the Amazon Resource Name (ARN) that you want to remove the tag from.

  • Replace key1 and key2 with the keys of the tags that you want to remove.

  • Replace value1 and value2 with the values of the tags that you want to remove.