notify_configurations

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

Overview

Name	`notify_configurations`
Type	Resource
Id	`aws.pinpoint_sms_voice_v2.notify_configurations`

Fields

The following fields are returned by SELECT queries:

describe_notify_configurations

Name	Datatype	Description
`created_timestamp`	`string (date-time)`	The time when the notify configuration was created, in UNIX epoch time format.
`default_template_id`	`string`	The default template identifier associated with the notify configuration. (pattern: <code>([A-Za-z0-9_-]*\|UNSET_DEFAULT_TEMPLATE)</code>)
`deletion_protection_enabled`	`boolean`	When set to true deletion protection is enabled. By default this is set to false.
`display_name`	`string`	The display name associated with the notify configuration. (pattern: <code>[A-Za-z0-9_ -]+</code>)
`enabled_channels`	`array`	An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
`enabled_countries`	`array`	An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
`notify_configuration_arn`	`string`	The Amazon Resource Name (ARN) for the notify configuration. (pattern: <code>arn:\S+</code>)
`notify_configuration_id`	`string`	The unique identifier for the notify configuration. (pattern: <code>[A-Za-z0-9_-]+</code>)
`pool_id`	`string`	The identifier of the pool associated with the notify configuration.
`rejection_reason`	`string`	The reason the notify configuration was rejected, if applicable.
`status`	`string`	The current status of the notify configuration. (PENDING, ACTIVE, REJECTED, REQUIRES_VERIFICATION)
`tier`	`string`	The tier of the notify configuration. (BASIC, ADVANCED)
`tier_upgrade_status`	`string`	The tier upgrade status of the notify configuration. (BASIC, PENDING_UPGRADE, ADVANCED, REJECTED)
`use_case`	`string`	The use case for the notify configuration. (CODE_VERIFICATION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_notify_configurations`	`select`	`region`	Describes the specified notify configurations or all notify configurations in your account. If you specify notify configuration IDs, the output includes information for only the specified notify configurations. If you specify filters, the output includes information for only those notify configurations that meet the filter criteria. If you don't specify notify configuration IDs or filters, the output includes information for all notify configurations. If you specify a notify configuration ID that isn't valid, an error is returned.
`create_notify_configuration`	`insert`	`region`, `DisplayName`, `UseCase`, `EnabledChannels`	Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.
`update_notify_configuration`	`update`	`region`, `NotifyConfigurationId`	Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.
`delete_notify_configuration`	`delete`	`region`	Deletes an existing notify configuration. If deletion protection is enabled, an error is returned.
`send_notify_text_message`	`exec`	`region`, `NotifyConfigurationId`, `DestinationPhoneNumber`, `TemplateVariables`	Sends a templated text message through a notify configuration to a recipient's phone number.
`send_notify_voice_message`	`exec`	`region`, `NotifyConfigurationId`, `DestinationPhoneNumber`, `TemplateVariables`	Sends a templated voice message through a notify configuration to a recipient's phone number.

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_notify_configurations

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

SELECT
created_timestamp,
default_template_id,
deletion_protection_enabled,
display_name,
enabled_channels,
enabled_countries,
notify_configuration_arn,
notify_configuration_id,
pool_id,
rejection_reason,
status,
tier,
tier_upgrade_status,
use_case
FROM aws.pinpoint_sms_voice_v2.notify_configurations
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_notify_configuration
Manifest

Creates a new notify configuration for managed messaging. A notify configuration defines the settings for sending templated messages, including the display name, use case, enabled channels, and enabled countries.

INSERT INTO aws.pinpoint_sms_voice_v2.notify_configurations (
DisplayName,
UseCase,
DefaultTemplateId,
PoolId,
EnabledCountries,
EnabledChannels,
DeletionProtectionEnabled,
ClientToken,
Tags,
region
)
SELECT 
'{{ DisplayName }}' /* required */,
'{{ UseCase }}' /* required */,
'{{ DefaultTemplateId }}',
'{{ PoolId }}',
'{{ EnabledCountries }}',
'{{ EnabledChannels }}' /* required */,
{{ DeletionProtectionEnabled }},
'{{ ClientToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
created_timestamp,
default_template_id,
deletion_protection_enabled,
display_name,
enabled_channels,
enabled_countries,
notify_configuration_arn,
notify_configuration_id,
pool_id,
rejection_reason,
status,
tags,
tier,
tier_upgrade_status,
use_case
;

# Description fields are for documentation purposes
- name: notify_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the notify_configurations resource.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The display name to associate with the notify configuration.
  - name: UseCase
    value: "{{ UseCase }}"
    description: |
      The use case for the notify configuration.
    valid_values: ['CODE_VERIFICATION']
  - name: DefaultTemplateId
    value: "{{ DefaultTemplateId }}"
    description: |
      The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
  - name: PoolId
    value: "{{ PoolId }}"
    description: |
      The identifier of the pool to associate with the notify configuration.
  - name: EnabledCountries
    value:
      - "{{ EnabledCountries }}"
    description: |
      An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
  - name: EnabledChannels
    value:
      - "{{ EnabledChannels }}"
    description: |
      An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
  - name: DeletionProtectionEnabled
    value: {{ DeletionProtectionEnabled }}
    description: |
      By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.
  - 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 tags (key and value pairs) associated with the notify configuration.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

update_notify_configuration

Updates an existing notify configuration. You can update the default template, pool association, enabled channels, enabled countries, and deletion protection settings.

UPDATE aws.pinpoint_sms_voice_v2.notify_configurations
SET 
NotifyConfigurationId = '{{ NotifyConfigurationId }}',
DefaultTemplateId = '{{ DefaultTemplateId }}',
PoolId = '{{ PoolId }}',
EnabledCountries = '{{ EnabledCountries }}',
EnabledChannels = '{{ EnabledChannels }}',
DeletionProtectionEnabled = {{ DeletionProtectionEnabled }}
WHERE 
region = '{{ region }}' --required
AND NotifyConfigurationId = '{{ NotifyConfigurationId }}' --required
RETURNING
created_timestamp,
default_template_id,
deletion_protection_enabled,
display_name,
enabled_channels,
enabled_countries,
notify_configuration_arn,
notify_configuration_id,
pool_id,
rejection_reason,
status,
tier,
tier_upgrade_status,
use_case;

`DELETE` examples

delete_notify_configuration

Deletes an existing notify configuration. If deletion protection is enabled, an error is returned.

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

Lifecycle Methods

send_notify_text_message
send_notify_voice_message

Sends a templated text message through a notify configuration to a recipient's phone number.

EXEC aws.pinpoint_sms_voice_v2.notify_configurations.send_notify_text_message 
@region='{{ region }}' --required 
@@json=
'{
"NotifyConfigurationId": "{{ NotifyConfigurationId }}", 
"DestinationPhoneNumber": "{{ DestinationPhoneNumber }}", 
"TemplateId": "{{ TemplateId }}", 
"TemplateVariables": "{{ TemplateVariables }}", 
"TimeToLive": {{ TimeToLive }}, 
"Context": "{{ Context }}", 
"ConfigurationSetName": "{{ ConfigurationSetName }}", 
"DryRun": {{ DryRun }}, 
"MessageFeedbackEnabled": {{ MessageFeedbackEnabled }}
}'
;

Sends a templated voice message through a notify configuration to a recipient's phone number.

EXEC aws.pinpoint_sms_voice_v2.notify_configurations.send_notify_voice_message 
@region='{{ region }}' --required 
@@json=
'{
"NotifyConfigurationId": "{{ NotifyConfigurationId }}", 
"DestinationPhoneNumber": "{{ DestinationPhoneNumber }}", 
"TemplateId": "{{ TemplateId }}", 
"TemplateVariables": "{{ TemplateVariables }}", 
"VoiceId": "{{ VoiceId }}", 
"TimeToLive": {{ TimeToLive }}, 
"Context": "{{ Context }}", 
"ConfigurationSetName": "{{ ConfigurationSetName }}", 
"DryRun": {{ DryRun }}, 
"MessageFeedbackEnabled": {{ MessageFeedbackEnabled }}
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​