Describe Registration Type Definitions

pinpointsmsvoicev2_describe_registration_type_definitions

R Documentation

Retrieves the specified registration type definitions

Description

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

Usage

pinpointsmsvoicev2_describe_registration_type_definitions(
  RegistrationTypes, Filters, NextToken, MaxResults)

Arguments

RegistrationTypes

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

Filters

An array of RegistrationFilter objects to filter the results.

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(
  RegistrationTypeDefinitions = list(
    list(
      RegistrationType = "string",
      SupportedAssociations = list(
        list(
          ResourceType = "string",
          IsoCountryCode = "string",
          AssociationBehavior = "ASSOCIATE_BEFORE_SUBMIT"|"ASSOCIATE_ON_APPROVAL"|"ASSOCIATE_AFTER_COMPLETE",
          DisassociationBehavior = "DISASSOCIATE_ALL_CLOSES_REGISTRATION"|"DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION"|"DELETE_REGISTRATION_DISASSOCIATES"
        )
      ),
      DisplayHints = list(
        Title = "string",
        ShortDescription = "string",
        LongDescription = "string",
        DocumentationTitle = "string",
        DocumentationLink = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_registration_type_definitions(
  RegistrationTypes = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "supported-association-resource-type"|"supported-association-iso-country-code",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)