Skip to content

DescribeRegistrationFieldValuesRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_registration_field_values_request.py
class DescribeRegistrationFieldValuesRequest(TypedDict, closed=True):
    registration_id: (
        "capo_pinpoint_sms_voice_v2.types.registration_id_or_arn.RegistrationIdOrArn"
    )
    """<p>The unique identifier for the registration.</p>"""
    version_number: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.registration_version_number.RegistrationVersionNumber"
    ]
    """<p>The version number of the registration.</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_id instance-attribute

registration_id: RegistrationIdOrArn

The unique identifier for the registration.

section_path instance-attribute

section_path: NotRequired[SectionPath]

The path to the section of the registration.

version_number instance-attribute

version_number: NotRequired[RegistrationVersionNumber]

The version number of the registration.