Describe Registration Section Definitions

pinpointsmsvoicev2_describe_registration_section_definitions

R Documentation

Retrieves the specified registration section definitions¶

Description¶

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

Usage¶

pinpointsmsvoicev2_describe_registration_section_definitions(
  RegistrationType, SectionPaths, NextToken, MaxResults)

Arguments¶

RegistrationType

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

SectionPaths

An array of paths for the registration form section.

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",
  RegistrationSectionDefinitions = list(
    list(
      SectionPath = "string",
      DisplayHints = list(
        Title = "string",
        ShortDescription = "string",
        LongDescription = "string",
        DocumentationTitle = "string",
        DocumentationLink = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_registration_section_definitions(
  RegistrationType = "string",
  SectionPaths = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)