registration_field_definitions

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

Overview

Name	registration_field_definitions
Type	Resource
Id	aws.pinpoint_sms_voice_v2.registration_field_definitions

Fields

The following fields are returned by SELECT queries:

describe_registration_field_definitions

Name	Datatype	Description
display_hints	object	An array of RegistrationFieldDisplayHints objects for the field.
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>)
field_requirement	string	Specifies if the field for the registration form is required, conditional or optional. (REQUIRED, CONDITIONAL, OPTIONAL)
field_type	string	The type of field. (SELECT, TEXT, ATTACHMENT)
section_path	string	The section path of the field. (pattern: <code>[A-Za-z0-9_]+</code>)
select_validation	object	The validation rules for a select field.
text_validation	object	The validation rules for a text field.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_registration_field_definitions	select	region		Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

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_definitions

Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.

SELECT
display_hints,
field_path,
field_requirement,
field_type,
section_path,
select_validation,
text_validation
FROM aws.pinpoint_sms_voice_v2.registration_field_definitions
WHERE region = '{{ region }}' -- required
;