configuration_sets

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

Overview

Name	configuration_sets
Type	Resource
Id	aws.pinpoint_sms_voice.configuration_sets

Fields

The following fields are returned by SELECT queries:

list_configuration_sets

Name	Datatype	Description
configuration_set	string	An object that contains a list of configuration sets for your account in the current region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_configuration_sets	select	region	NextToken, PageSize	List all of the configuration sets associated with your Amazon Pinpoint account in the current region.
create_configuration_set	insert	region		Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
delete_configuration_set	delete	configuration_set_name, region		Deletes an existing configuration set.

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
configuration_set_name	string	ConfigurationSetName
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to the API that indicates the position in the list of results.
PageSize	string	Used to specify the number of items that should be returned in the response.

SELECT examples

list_configuration_sets

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

SELECT
configuration_set
FROM aws.pinpoint_sms_voice.configuration_sets
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_configuration_set

Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it.

INSERT INTO aws.pinpoint_sms_voice.configuration_sets (
ConfigurationSetName,
region
)
SELECT 
'{{ ConfigurationSetName }}',
'{{ region }}'
;

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 }}"

DELETE examples

delete_configuration_set

Deletes an existing configuration set.

DELETE FROM aws.pinpoint_sms_voice.configuration_sets
WHERE configuration_set_name = '{{ configuration_set_name }}' --required
AND region = '{{ region }}' --required
;