registration_associations

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

Overview

Name	registration_associations
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registration_associations

Fields

The following fields are returned by SELECT queries:

list_registration_associations

Name	Datatype	Description
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>)
phone_number	string	The phone number associated with the registration in E.164 format. (pattern: <code>+?[1-9][0-9]{1,18}</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
resource_id	string	The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
resource_type	string	The origination identity type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_registration_associations	select	region		Retrieve all of the origination identities that are associated with a registration.
create_registration_association	insert	region, RegistrationId, ResourceId		Associate the registration with an origination identity such as a phone number or 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

list_registration_associations

Retrieve all of the origination identities that are associated with a registration.

SELECT
iso_country_code,
phone_number,
resource_arn,
resource_id,
resource_type
FROM aws.pinpoint_sms_voice_v2.registration_associations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_registration_association

Associate the registration with an origination identity such as a phone number or sender ID.

INSERT INTO aws.pinpoint_sms_voice_v2.registration_associations (
RegistrationId,
ResourceId,
region
)
SELECT 
'{{ RegistrationId }}' /* required */,
'{{ ResourceId }}' /* required */,
'{{ region }}'
RETURNING
iso_country_code,
phone_number,
registration_arn,
registration_id,
registration_type,
resource_arn,
resource_id,
resource_type
;

Manifest

# Description fields are for documentation purposes
- name: registration_associations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registration_associations resource.
  - name: RegistrationId
    value: "{{ RegistrationId }}"
    description: |
      The unique identifier for the registration.
  - name: ResourceId
    value: "{{ ResourceId }}"
    description: |
      The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.