PinpointSMSVoiceV2 / Paginator / DescribeRegistrationSectionDefinitions
DescribeRegistrationSectionDefinitions#
- class PinpointSMSVoiceV2.Paginator.DescribeRegistrationSectionDefinitions#
paginator = client.get_paginator('describe_registration_section_definitions')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
PinpointSMSVoiceV2.Client.describe_registration_section_definitions()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( RegistrationType='string', SectionPaths=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
RegistrationType (string) –
[REQUIRED]
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
SectionPaths (list) –
An array of paths for the registration form section.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'RegistrationType': 'string', 'RegistrationSectionDefinitions': [ { 'SectionPath': 'string', 'DisplayHints': { 'Title': 'string', 'ShortDescription': 'string', 'LongDescription': 'string', 'DocumentationTitle': 'string', 'DocumentationLink': 'string' } }, ], }
Response Structure
(dict) –
RegistrationType (string) –
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
RegistrationSectionDefinitions (list) –
An array of RegistrationSectionDefinition objects.
(dict) –
Provides information on the specified section definition.
SectionPath (string) –
The path to the section of the registration.
DisplayHints (dict) –
The path to the section of the registration.
Title (string) –
The title of the display hint.
ShortDescription (string) –
A short description of the display hint.
LongDescription (string) –
A full description of the display hint.
DocumentationTitle (string) –
The title of the document the display hint is associated with.
DocumentationLink (string) –
The link to the document the display hint is associated with.