Skip to content

DescribeRegistrationFieldDefinitionsRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_registration_field_definitions_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class DescribeRegistrationFieldDefinitionsRequest(TypedDict, closed=True):
    registration_type: (
        "capo_pinpoint_sms_voice_v2.types.registration_type.RegistrationType"
    )
    """<p>The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.</p>"""
    section_path: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.section_path.SectionPath"
    ]
    """<p>The path to the section of the registration.</p>"""
    field_paths: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.field_path_list.FieldPathList"
    ]
    """<p>An array of paths to the registration form field.</p>"""
    next_token: NotRequired["capo_pinpoint_sms_voice_v2.types.next_token.NextToken"]
    """<p>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.</p>"""
    max_results: NotRequired["capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per each request.</p>"""

field_paths instance-attribute 

field_paths: NotRequired[FieldPathList]

An array of paths to the registration form field.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per each request.

next_token instance-attribute 

next_token: NotRequired[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.

registration_type instance-attribute 

registration_type: RegistrationType

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

section_path instance-attribute 

section_path: NotRequired[SectionPath]

The path to the section of the registration.