registration_versions

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

Overview

Name	registration_versions
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registration_versions

Fields

The following fields are returned by SELECT queries:

describe_registration_versions

Name	Datatype	Description
denied_reasons	array	An array of RegistrationDeniedReasonInformation objects.
feedback	string	Generative AI feedback information provided during the registration review process. This includes comments, suggestions, or additional requirements.
registration_version_status	string	The status of the registration. APPROVED: Your registration has been approved. ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved. DENIED: You must fix your registration and resubmit it. DISCARDED: You've abandon this version of their registration to start over with a new version. DRAFT: The initial status of a registration version after it’s created. REQUIRES_AUTHENTICATION: You need to complete email authentication. REVIEWING: Your registration has been accepted and is being reviewed. REVOKED: Your previously approved registration has been revoked. SUBMITTED: Your registration has been submitted. (DRAFT, SUBMITTED, AWS_REVIEWING, REVIEWING, REQUIRES_AUTHENTICATION, APPROVED, DISCARDED, DENIED, REVOKED, ARCHIVED, REQUIRES_OFFLINE_REVIEW)
registration_version_status_history	object	The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
version_number	integer (int64)	The version number of the registration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registration_versions	select	region		Retrieves the specified registration version.
create_registration_version	insert	region, RegistrationId		Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

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_registration_versions

Retrieves the specified registration version.

SELECT
denied_reasons,
feedback,
registration_version_status,
registration_version_status_history,
version_number
FROM aws.pinpoint_sms_voice_v2.registration_versions
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_registration_version

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

INSERT INTO aws.pinpoint_sms_voice_v2.registration_versions (
RegistrationId,
region
)
SELECT 
'{{ RegistrationId }}' /* required */,
'{{ region }}'
RETURNING
registration_arn,
registration_id,
registration_version_status,
registration_version_status_history,
version_number
;

Manifest

# Description fields are for documentation purposes
- name: registration_versions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the registration_versions resource.
  - name: RegistrationId
    value: "{{ RegistrationId }}"
    description: |
      The unique identifier for the registration.