Skip to content
AWS for Query.Farm

aws.pinpoint_sms_voice_v2.describe_registration_field_definitions

Example SQL Queries

SELECT * FROM
aws.pinpoint_sms_voice_v2.describe_registration_field_definitions
WHERE
"registration_type" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
registration_type Required Input Column

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

VARCHAR
field_paths Input Column

An array of paths to the registration form field.

VARCHAR[]
Show child fields
field_paths[]
section_path Input Column

The path to the section of the registration.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

registration_field_definitions

An array of RegistrationFieldDefinitions objects that contain the details for the requested fields. 

STRUCT(
    "section_path" VARCHAR,
    "field_path" VARCHAR,
    "field_type" VARCHAR,
    "field_requirement" VARCHAR,
    "select_validation" STRUCT(
        "min_choices" BIGINT,
        "max_choices" BIGINT,
        "options" VARCHAR[]
    ),
    "text_validation" STRUCT(
        "min_length" BIGINT,
        "max_length" BIGINT,
        "pattern" VARCHAR
    ),
    "display_hints" STRUCT(
        "title" VARCHAR,
        "short_description" VARCHAR,
        "long_description" VARCHAR,
        "documentation_title" VARCHAR,
        "documentation_link" VARCHAR,
        "select_option_descriptions" STRUCT(
            "option" VARCHAR,
            "title" VARCHAR,
            "description" VARCHAR
        )[],
        "text_validation_description" VARCHAR,
        "example_text_value" VARCHAR
    )
)[]
Show child fields
registration_field_definitions[]
Show child fields
registration_field_definitions[].display_hints

An array of RegistrationFieldDisplayHints objects for the field.

Show child fields
registration_field_definitions[].display_hints.documentation_link

The link to the document the display hint is associated with.

registration_field_definitions[].display_hints.documentation_title

The title of the document the display hint is associated with.

registration_field_definitions[].display_hints.example_text_value

Example text of what the value of a field should contain.

registration_field_definitions[].display_hints.long_description

A full description of the display hint.

registration_field_definitions[].display_hints.select_option_descriptions[]
Show child fields
registration_field_definitions[].display_hints.select_option_descriptions[].description

A description of the option meaning.

registration_field_definitions[].display_hints.select_option_descriptions[].option

The value of the option.

registration_field_definitions[].display_hints.select_option_descriptions[].title

The title of the select option.

registration_field_definitions[].display_hints.short_description

A short description of the display hint.

registration_field_definitions[].display_hints.text_validation_description

The validation rules for the text field.

registration_field_definitions[].display_hints.title

The title of the display hint.

registration_field_definitions[].field_path

The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

registration_field_definitions[].field_requirement

Specifies if the field for the registration form is required, conditional or optional.

registration_field_definitions[].field_type

The type of field.

registration_field_definitions[].section_path

The section path of the field.

registration_field_definitions[].select_validation

The validation rules for a select field.

Show child fields
registration_field_definitions[].select_validation.max_choices

The maximum number of choices for the select.

registration_field_definitions[].select_validation.min_choices

The minimum number of choices for the select.

registration_field_definitions[].select_validation.options[]
registration_field_definitions[].text_validation

The validation rules for a text field.

Show child fields
registration_field_definitions[].text_validation.max_length

The maximum number of characters for the text field.

registration_field_definitions[].text_validation.min_length

The minimum number of characters for the text field.

registration_field_definitions[].text_validation.pattern

The regular expression used to validate the text field.