pool_origination_identities

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

Overview

Name	pool_origination_identities
Type	Resource
Id	aws.pinpoint_sms_voice_v2.pool_origination_identities

Fields

The following fields are returned by SELECT queries:

list_pool_origination_identities

Name	Datatype	Description
iso_country_code	string	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and may not be present for origination identity types that are not country-specific, such as RCS agents. (pattern: <code>[A-Z]{2}</code>)
number_capabilities	array	Describes if the origination identity can be used for text messages, voice calls or both.
origination_identity	string	The unique identifier of the origination identity.
origination_identity_arn	string	The Amazon Resource Name (ARN) associated with the origination identity.
phone_number	string	The phone number in E.164 format. (pattern: <code>+?[1-9][0-9]{1,18}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_pool_origination_identities	select	region		Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

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_pool_origination_identities

Lists all associated origination identities in your pool. If you specify filters, the output includes information for only those origination identities that meet the filter criteria.

SELECT
iso_country_code,
number_capabilities,
origination_identity,
origination_identity_arn,
phone_number
FROM aws.pinpoint_sms_voice_v2.pool_origination_identities
WHERE region = '{{ region }}' -- required
;