protect_configuration_rule_set_number_overrides

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

Overview

Name	protect_configuration_rule_set_number_overrides
Type	Resource
Id	aws.pinpoint_sms_voice_v2.protect_configuration_rule_set_number_overrides

Fields

The following fields are returned by SELECT queries:

list_protect_configuration_rule_set_number_overrides

Name	Datatype	Description
action	string	The action for the rule to perform of either blocking or allowing messages to the destination phone number. (ALLOW, BLOCK)
created_timestamp	string (date-time)	The time when the rule was created, in UNIX epoch time format.
destination_phone_number	string	The destination phone number in E.164 format. (pattern: <code>+?[1-9][0-9]{1,18}</code>)
expiration_timestamp	string (date-time)	The time the rule will expire at. If ExpirationTimestamp is not set then the rule will not expire.
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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_protect_configuration_rule_set_number_overrides	select	region		Retrieve all of the protect configuration rule set number overrides that match the filters.
put_protect_configuration_rule_set_number_override	replace	region, ProtectConfigurationId, DestinationPhoneNumber		Create or update a phone number rule override and associate it with a protect configuration.
delete_protect_configuration_rule_set_number_override	delete	region		Permanently delete the protect configuration rule set number override.

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

list_protect_configuration_rule_set_number_overrides

Retrieve all of the protect configuration rule set number overrides that match the filters.

SELECT
action,
created_timestamp,
destination_phone_number,
expiration_timestamp,
iso_country_code
FROM aws.pinpoint_sms_voice_v2.protect_configuration_rule_set_number_overrides
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_protect_configuration_rule_set_number_override

Create or update a phone number rule override and associate it with a protect configuration.

REPLACE aws.pinpoint_sms_voice_v2.protect_configuration_rule_set_number_overrides
SET 
ClientToken = '{{ ClientToken }}',
ProtectConfigurationId = '{{ ProtectConfigurationId }}',
DestinationPhoneNumber = '{{ DestinationPhoneNumber }}',
Action = '{{ Action }}',
ExpirationTimestamp = '{{ ExpirationTimestamp }}'
WHERE 
region = '{{ region }}' --required
AND ProtectConfigurationId = '{{ ProtectConfigurationId }}' --required
AND DestinationPhoneNumber = '{{ DestinationPhoneNumber }}' --required
RETURNING
action,
created_timestamp,
destination_phone_number,
expiration_timestamp,
iso_country_code,
protect_configuration_arn,
protect_configuration_id;

DELETE examples

delete_protect_configuration_rule_set_number_override

Permanently delete the protect configuration rule set number override.

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