sender_ids

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

Overview

Name	sender_ids
Type	Resource
Id	aws.pinpoint_sms_voice_v2.sender_ids

Fields

The following fields are returned by SELECT queries:

describe_sender_ids

Name	Datatype	Description
deletion_protection_enabled	boolean	By default this is set to false. When set to true the sender ID can't be deleted.
iso_country_code	string	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. (pattern: <code>[A-Z]{2}</code>)
message_types	array	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.
monthly_leasing_price	string	The monthly leasing price, in US dollars.
registered	boolean	True if the sender ID is registered.
registration_id	string	The unique identifier for the registration.
sender_id	string	The alphanumeric sender ID in a specific country that you'd like to describe. (pattern: <code>[A-Za-z0-9_-]+</code>)
sender_id_arn	string	The Amazon Resource Name (ARN) associated with the SenderId.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_sender_ids	select	region		Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.
release_sender_id	update	region, SenderId, IsoCountryCode		Releases an existing sender ID in your account.
set_default_sender_id	update	region, ConfigurationSetName, SenderId		Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
delete_default_sender_id	delete	region		Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
update_sender_id	exec	region, SenderId, IsoCountryCode		Updates the configuration of an existing sender ID.

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_sender_ids

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account. If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds. f you specify a sender ID that isn't valid, an error is returned.

SELECT
deletion_protection_enabled,
iso_country_code,
message_types,
monthly_leasing_price,
registered,
registration_id,
sender_id,
sender_id_arn
FROM aws.pinpoint_sms_voice_v2.sender_ids
WHERE region = '{{ region }}' -- required
;

UPDATE examples

release_sender_id

Releases an existing sender ID in your account.

UPDATE aws.pinpoint_sms_voice_v2.sender_ids
SET 
SenderId = '{{ SenderId }}',
IsoCountryCode = '{{ IsoCountryCode }}'
WHERE 
region = '{{ region }}' --required
AND SenderId = '{{ SenderId }}' --required
AND IsoCountryCode = '{{ IsoCountryCode }}' --required
RETURNING
iso_country_code,
message_types,
monthly_leasing_price,
registered,
registration_id,
sender_id,
sender_id_arn;

set_default_sender_id

Sets default sender ID on a configuration set. When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.

UPDATE aws.pinpoint_sms_voice_v2.sender_ids
SET 
ConfigurationSetName = '{{ ConfigurationSetName }}',
SenderId = '{{ SenderId }}'
WHERE 
region = '{{ region }}' --required
AND ConfigurationSetName = '{{ ConfigurationSetName }}' --required
AND SenderId = '{{ SenderId }}' --required
RETURNING
configuration_set_arn,
configuration_set_name,
sender_id;

DELETE examples

delete_default_sender_id

Deletes an existing default sender ID on a configuration set. A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.

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

Lifecycle Methods

update_sender_id

Updates the configuration of an existing sender ID.

EXEC aws.pinpoint_sms_voice_v2.sender_ids.update_sender_id 
@region='{{ region }}' --required 
@@json=
'{
"SenderId": "{{ SenderId }}", 
"IsoCountryCode": "{{ IsoCountryCode }}", 
"DeletionProtectionEnabled": {{ DeletionProtectionEnabled }}
}'
;