describe_registration_field_definitions ¶

describe_registration_field_definitions(
    registration_type: RegistrationType,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    section_path: Optional[SectionPath] = None,
    field_paths: Optional[FieldPathList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> DescribeRegistrationFieldDefinitionsResult

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

Parameters:

registration_type (RegistrationType) –

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
section_path (Optional[SectionPath], default: None ) –

The path to the section of the registration.
field_paths (Optional[FieldPathList], default: None ) –

An array of paths to the registration form field.
next_token (Optional[NextToken], default: None ) –

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.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return per each request.

Raises:

AccessDeniedException –

The request was denied because you don't have sufficient permissions to access the resource.
InternalServerException –

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
ThrottlingException –

An error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

A validation exception for a field.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py

def describe_registration_field_definitions(
    self,
    registration_type: "capo_pinpoint_sms_voice_v2.types.registration_type.RegistrationType",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    section_path: Optional[
        "capo_pinpoint_sms_voice_v2.types.section_path.SectionPath"
    ] = None,
    field_paths: Optional[
        "capo_pinpoint_sms_voice_v2.types.field_path_list.FieldPathList"
    ] = None,
    next_token: Optional[
        "capo_pinpoint_sms_voice_v2.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.describe_registration_field_definitions_result.DescribeRegistrationFieldDefinitionsResult":
    """<p>Retrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.</p>

    Args:
        registration_type: <p>The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.</p>
        section_path: <p>The path to the section of the registration.</p>
        field_paths: <p>An array of paths to the registration form field.</p>
        next_token: <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: <p>The maximum number of results to return per each request.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.describe_registration_field_definitions_request.DescribeRegistrationFieldDefinitionsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.describe_registration_field_definitions_result.DescribeRegistrationFieldDefinitionsResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_registration_field_definitions

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_registration_field_definitions.describe_registration_field_definitions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRegistrationFieldDefinitions")
    )
    input_: capo_pinpoint_sms_voice_v2.types.describe_registration_field_definitions_request.DescribeRegistrationFieldDefinitionsRequest = {
        "registration_type": registration_type
    }
    if section_path is not None:
        input_["section_path"] = section_path
    if field_paths is not None:
        input_["field_paths"] = field_paths
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output