aws_sdk_pinpointsmsvoicev2/client/
describe_registration_field_definitions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeRegistrationFieldDefinitions`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`registration_type(impl Into<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::registration_type) / [`set_registration_type(Option<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::set_registration_type):<br>required: **true**<br><p>The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <code>DescribeRegistrationTypeDefinitions</code> action.</p><br>
8    ///   - [`section_path(impl Into<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::section_path) / [`set_section_path(Option<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::set_section_path):<br>required: **false**<br><p>The path to the section of the registration.</p><br>
9    ///   - [`field_paths(impl Into<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::field_paths) / [`set_field_paths(Option<Vec::<String>>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::set_field_paths):<br>required: **false**<br><p>An array of paths to the registration form field.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
11    ///   - [`max_results(i32)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
12    /// - On success, responds with [`DescribeRegistrationFieldDefinitionsOutput`](crate::operation::describe_registration_field_definitions::DescribeRegistrationFieldDefinitionsOutput) with field(s):
13    ///   - [`registration_type(String)`](crate::operation::describe_registration_field_definitions::DescribeRegistrationFieldDefinitionsOutput::registration_type): <p>The type of registration form. The list of <b>RegistrationTypes</b> can be found using the <code>DescribeRegistrationTypeDefinitions</code> action.</p>
14    ///   - [`registration_field_definitions(Vec::<RegistrationFieldDefinition>)`](crate::operation::describe_registration_field_definitions::DescribeRegistrationFieldDefinitionsOutput::registration_field_definitions): <p>An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::describe_registration_field_definitions::DescribeRegistrationFieldDefinitionsOutput::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>
16    /// - On failure, responds with [`SdkError<DescribeRegistrationFieldDefinitionsError>`](crate::operation::describe_registration_field_definitions::DescribeRegistrationFieldDefinitionsError)
17    pub fn describe_registration_field_definitions(
18        &self,
19    ) -> crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder {
20        crate::operation::describe_registration_field_definitions::builders::DescribeRegistrationFieldDefinitionsFluentBuilder::new(
21            self.handle.clone(),
22        )
23    }
24}
aws_sdk_pinpointsmsvoicev2/client/describe_registration_field_definitions.rs

aws_sdk_pinpointsmsvoicev2/client/
describe_registration_field_definitions.rs
