Describe Registration Field Definitions

pinpointsmsvoicev2_describe_registration_field_definitions

R Documentation

Retrieves the specified registration type field definitions

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.

Usage

pinpointsmsvoicev2_describe_registration_field_definitions(
  RegistrationType, SectionPath, FieldPaths, NextToken, MaxResults)

Arguments

RegistrationType

[required] The type of registration form. The list of RegistrationTypes can be found using the describe_registration_type_definitions action.

SectionPath

The path to the section of the registration.

FieldPaths

An array of paths to the registration form field.

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

MaxResults

The maximum number of results to return per each request.

Value

A list with the following syntax:

list(
  RegistrationType = "string",
  RegistrationFieldDefinitions = list(
    list(
      SectionPath = "string",
      FieldPath = "string",
      FieldType = "SELECT"|"TEXT"|"ATTACHMENT",
      FieldRequirement = "REQUIRED"|"CONDITIONAL"|"OPTIONAL",
      SelectValidation = list(
        MinChoices = 123,
        MaxChoices = 123,
        Options = list(
          "string"
        )
      ),
      TextValidation = list(
        MinLength = 123,
        MaxLength = 123,
        Pattern = "string"
      ),
      DisplayHints = list(
        Title = "string",
        ShortDescription = "string",
        LongDescription = "string",
        DocumentationTitle = "string",
        DocumentationLink = "string",
        SelectOptionDescriptions = list(
          list(
            Option = "string",
            Title = "string",
            Description = "string"
          )
        ),
        TextValidationDescription = "string",
        ExampleTextValue = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_registration_field_definitions(
  RegistrationType = "string",
  SectionPath = "string",
  FieldPaths = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)