registrations

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

Overview

Name	registrations
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registrations

Fields

The following fields are returned by SELECT queries:

describe_registrations

Name	Datatype	Description
additional_attributes	object	Metadata about a given registration which is specific to that registration type.
approved_version_number	integer (int64)	The version number of the registration that was approved.
created_timestamp	string (date-time)	The time when the registration was created, in UNIX epoch time format.
current_version_number	integer (int64)	The current version number of the registration.
latest_denied_version_number	integer (int64)	The latest version number of the registration that was denied.
registration_arn	string	The Amazon Resource Name (ARN) for the registration.
registration_id	string	The unique identifier for the registration.
registration_status	string	The status of the registration. CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. CREATED: Your registration is created but not submitted. COMPLETE: Your registration has been approved and your origination identity has been created. DELETED: The registration has been deleted. PROVISIONING: Your registration has been approved and your origination identity is being created. REQUIRES_AUTHENTICATION: You need to complete email authentication. REQUIRES_UPDATES: You must fix your registration and resubmit it. REVIEWING: Your registration has been accepted and is being reviewed. SUBMITTED: Your registration has been submitted and is awaiting review. (CREATED, SUBMITTED, AWS_REVIEWING, REVIEWING, REQUIRES_AUTHENTICATION, PROVISIONING, COMPLETE, REQUIRES_UPDATES, CLOSED, DELETED)
registration_type	string	The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action. (pattern: <code>[A-Za-z0-9_]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registrations	select	region		Retrieves the specified registrations.
create_registration	insert	region, RegistrationType		Creates a new registration based on the RegistrationType field.
delete_registration	delete	region		Permanently delete an existing registration from your account.
discard_registration_version	exec	region, RegistrationId		Discard the current version of the registration.
submit_registration_version	exec	region, RegistrationId		Submit the specified registration for review and approval.

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_registrations

Retrieves the specified registrations.

SELECT
additional_attributes,
approved_version_number,
created_timestamp,
current_version_number,
latest_denied_version_number,
registration_arn,
registration_id,
registration_status,
registration_type
FROM aws.pinpoint_sms_voice_v2.registrations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_registration

Creates a new registration based on the RegistrationType field.

INSERT INTO aws.pinpoint_sms_voice_v2.registrations (
RegistrationType,
Tags,
ClientToken,
region
)
SELECT 
'{{ RegistrationType }}' /* required */,
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
additional_attributes,
created_timestamp,
current_version_number,
registration_arn,
registration_id,
registration_status,
registration_type,
tags
;

Manifest

# Description fields are for documentation purposes
- name: registrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registrations resource.
  - name: RegistrationType
    value: "{{ RegistrationType }}"
    description: |
      The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
  - name: Tags
    description: |
      An array of tags (key and value pairs) to associate with the registration.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

DELETE examples

delete_registration

Permanently delete an existing registration from your account.

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

Lifecycle Methods

discard_registration_version

Discard the current version of the registration.

EXEC aws.pinpoint_sms_voice_v2.registrations.discard_registration_version 
@region='{{ region }}' --required 
@@json=
'{
"RegistrationId": "{{ RegistrationId }}"
}'
;

submit_registration_version

Submit the specified registration for review and approval.

EXEC aws.pinpoint_sms_voice_v2.registrations.submit_registration_version 
@region='{{ region }}' --required 
@@json=
'{
"RegistrationId": "{{ RegistrationId }}", 
"AwsReview": {{ AwsReview }}
}'
;