configuration_sets

Creates, updates, deletes, gets or lists a configuration_sets resource.

Overview

Name	configuration_sets
Type	Resource
Id	aws.pinpoint_sms_voice_v2.configuration_sets

Fields

The following fields are returned by SELECT queries:

describe_configuration_sets

Name	Datatype	Description
configuration_set_arn	string	The Resource Name (ARN) of the ConfigurationSet.
configuration_set_name	string	The name of the ConfigurationSet. (pattern: <code>[A-Za-z0-9_-]+</code>)
created_timestamp	string (date-time)	The time when the ConfigurationSet was created, in UNIX epoch time format.
default_message_feedback_enabled	boolean	True if message feedback is enabled.
default_message_type	string	The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. (TRANSACTIONAL, PROMOTIONAL)
default_sender_id	string	The default sender ID used by the ConfigurationSet. (pattern: <code>[A-Za-z0-9_-]+</code>)
event_destinations	array	An array of EventDestination objects that describe any events to log and where to log them.
protect_configuration_id	string	The unique identifier for the protect configuration. (pattern: <code>[A-Za-z0-9_:/-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configuration_sets	select	region		Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned.
create_event_destination	insert	region, ConfigurationSetName, EventDestinationName, MatchingEventTypes		Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
create_configuration_set	insert	region, ConfigurationSetName		Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set.
set_default_message_feedback_enabled	update	region, ConfigurationSetName, MessageFeedbackEnabled		Sets a configuration set's default for message feedback.
set_default_message_type	update	region, ConfigurationSetName, MessageType		Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
update_event_destination	update	region, ConfigurationSetName, EventDestinationName		Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.
delete_event_destination	delete	region		Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
delete_configuration_set	delete	region		Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
delete_default_message_type	exec	region, ConfigurationSetName		Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_configuration_sets

Describes the specified configuration sets or all in your account. If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets. If you specify a configuration set name that isn't valid, an error is returned.

SELECT
configuration_set_arn,
configuration_set_name,
created_timestamp,
default_message_feedback_enabled,
default_message_type,
default_sender_id,
event_destinations,
protect_configuration_id
FROM aws.pinpoint_sms_voice_v2.configuration_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_event_destination

Creates a new event destination in a configuration set. An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic. You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned. Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.

INSERT INTO aws.pinpoint_sms_voice_v2.configuration_sets (
ConfigurationSetName,
EventDestinationName,
MatchingEventTypes,
CloudWatchLogsDestination,
KinesisFirehoseDestination,
SnsDestination,
ClientToken,
region
)
SELECT 
'{{ ConfigurationSetName }}' /* required */,
'{{ EventDestinationName }}' /* required */,
'{{ MatchingEventTypes }}' /* required */,
'{{ CloudWatchLogsDestination }}',
'{{ KinesisFirehoseDestination }}',
'{{ SnsDestination }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
configuration_set_arn,
configuration_set_name,
event_destination
;

create_configuration_set

Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it. A configuration set is a set of rules that you apply to the SMS and voice messages that you send. When you send a message, you can optionally specify a single configuration set.

INSERT INTO aws.pinpoint_sms_voice_v2.configuration_sets (
ConfigurationSetName,
Tags,
ClientToken,
region
)
SELECT 
'{{ ConfigurationSetName }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
configuration_set_arn,
configuration_set_name,
created_timestamp,
tags
;

Manifest

# Description fields are for documentation purposes
- name: configuration_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_sets resource.
  - name: ConfigurationSetName
    value: "{{ ConfigurationSetName }}"
    description: |
      The name to use for the new configuration set.
  - name: EventDestinationName
    value: "{{ EventDestinationName }}"
    description: |
      The name that identifies the event destination.
  - name: MatchingEventTypes
    value:
      - "{{ MatchingEventTypes }}"
    description: |
      An array of event types that determine which events to log. If "ALL" is used, then End User Messaging SMS logs every event type. The TEXT_SENT event type is not supported.
  - name: CloudWatchLogsDestination
    description: |
      An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
    value:
      IamRoleArn: "{{ IamRoleArn }}"
      LogGroupArn: "{{ LogGroupArn }}"
  - name: KinesisFirehoseDestination
    description: |
      An object that contains information about an event destination for logging to Amazon Data Firehose.
    value:
      IamRoleArn: "{{ IamRoleArn }}"
      DeliveryStreamArn: "{{ DeliveryStreamArn }}"
  - name: SnsDestination
    description: |
      An object that contains information about an event destination for logging to Amazon SNS.
    value:
      TopicArn: "{{ TopicArn }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
  - name: Tags
    description: |
      An array of key and value pair tags that's associated with the new configuration set.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

set_default_message_feedback_enabled

Sets a configuration set's default for message feedback.

UPDATE aws.pinpoint_sms_voice_v2.configuration_sets
SET 
ConfigurationSetName = '{{ ConfigurationSetName }}',
MessageFeedbackEnabled = {{ MessageFeedbackEnabled }}
WHERE 
region = '{{ region }}' --required
AND ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND MessageFeedbackEnabled = {{ MessageFeedbackEnabled }} --required
RETURNING
configuration_set_arn,
configuration_set_name,
message_feedback_enabled;

set_default_message_type

Sets the default message type on a configuration set. Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

UPDATE aws.pinpoint_sms_voice_v2.configuration_sets
SET 
ConfigurationSetName = '{{ ConfigurationSetName }}',
MessageType = '{{ MessageType }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND MessageType = '{{ MessageType }}' --required
RETURNING
configuration_set_arn,
configuration_set_name,
message_type;

update_event_destination

Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.

UPDATE aws.pinpoint_sms_voice_v2.configuration_sets
SET 
ConfigurationSetName = '{{ ConfigurationSetName }}',
EventDestinationName = '{{ EventDestinationName }}',
Enabled = {{ Enabled }},
MatchingEventTypes = '{{ MatchingEventTypes }}',
CloudWatchLogsDestination = '{{ CloudWatchLogsDestination }}',
KinesisFirehoseDestination = '{{ KinesisFirehoseDestination }}',
SnsDestination = '{{ SnsDestination }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND EventDestinationName = '{{ EventDestinationName }}' --required
RETURNING
configuration_set_arn,
configuration_set_name,
event_destination;

DELETE examples

delete_event_destination

Deletes an existing event destination. An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.

DELETE FROM aws.pinpoint_sms_voice_v2.configuration_sets
WHERE region = '{{ region }}' --required
;

delete_configuration_set

Deletes an existing configuration set. A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.

DELETE FROM aws.pinpoint_sms_voice_v2.configuration_sets
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

delete_default_message_type

Deletes an existing default message type on a configuration set. A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.

EXEC aws.pinpoint_sms_voice_v2.configuration_sets.delete_default_message_type 
@region='{{ region }}' --required 
@@json=
'{
"ConfigurationSetName": "{{ ConfigurationSetName }}"
}'
;