registration_field_values

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

Overview

Name	registration_field_values
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registration_field_values

Fields

The following fields are returned by SELECT queries:

describe_registration_field_values

Name	Datatype	Description
denied_reason	string	A description of why the registration was denied.
feedback	string	Generative AI feedback information provided for this specific field during the registration review process. This may include validation errors, suggestions for improvement, or additional requirements.
field_path	string	The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths. (pattern: <code>[A-Za-z0-9_.]+</code>)
registration_attachment_id	string	The unique identifier for the registration attachment. (pattern: <code>[A-Za-z0-9_:/-]+</code>)
select_choices	array	An array of values for the form field.
text_value	string	The text data for a free form field.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registration_field_values	select	region		Retrieves the specified registration field values.
put_registration_field_value	replace	region, RegistrationId, FieldPath		Creates or updates a field value for a registration.
delete_registration_field_value	delete	region		Delete the value in a registration form field.

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_field_values

Retrieves the specified registration field values.

SELECT
denied_reason,
feedback,
field_path,
registration_attachment_id,
select_choices,
text_value
FROM aws.pinpoint_sms_voice_v2.registration_field_values
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_registration_field_value

Creates or updates a field value for a registration.

REPLACE aws.pinpoint_sms_voice_v2.registration_field_values
SET 
RegistrationId = '{{ RegistrationId }}',
FieldPath = '{{ FieldPath }}',
SelectChoices = '{{ SelectChoices }}',
TextValue = '{{ TextValue }}',
RegistrationAttachmentId = '{{ RegistrationAttachmentId }}'
WHERE 
region = '{{ region }}' --required
AND RegistrationId = '{{ RegistrationId }}' --required
AND FieldPath = '{{ FieldPath }}' --required
RETURNING
field_path,
registration_arn,
registration_attachment_id,
registration_id,
select_choices,
text_value,
version_number;

DELETE examples

delete_registration_field_value

Delete the value in a registration form field.

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