aws_sdk_pinpointsmsvoicev2/client/
describe_registration_field_values.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 [`DescribeRegistrationFieldValues`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`registration_id(impl Into<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::registration_id) / [`set_registration_id(Option<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::set_registration_id):<br>required: **true**<br><p>The unique identifier for the registration.</p><br>
8    ///   - [`version_number(i64)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::version_number) / [`set_version_number(Option<i64>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::set_version_number):<br>required: **false**<br><p>The version number of the registration.</p><br>
9    ///   - [`section_path(impl Into<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::section_path) / [`set_section_path(Option<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::set_section_path):<br>required: **false**<br><p>The path to the section of the registration.</p><br>
10    ///   - [`field_paths(impl Into<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::field_paths) / [`set_field_paths(Option<Vec::<String>>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::set_field_paths):<br>required: **false**<br><p>An array of paths to the registration form field.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::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>
12    ///   - [`max_results(i32)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
13    /// - On success, responds with [`DescribeRegistrationFieldValuesOutput`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput) with field(s):
14    ///   - [`registration_arn(String)`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput::registration_arn): <p>The Amazon Resource Name (ARN) for the registration.</p>
15    ///   - [`registration_id(String)`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput::registration_id): <p>The unique identifier for the registration.</p>
16    ///   - [`version_number(i64)`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput::version_number): <p>The current version of the registration.</p>
17    ///   - [`registration_field_values(Vec::<RegistrationFieldValueInformation>)`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput::registration_field_values): <p>An array of RegistrationFieldValues objects that contain the values for the requested registration.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesOutput::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>
19    /// - On failure, responds with [`SdkError<DescribeRegistrationFieldValuesError>`](crate::operation::describe_registration_field_values::DescribeRegistrationFieldValuesError)
20    pub fn describe_registration_field_values(
21        &self,
22    ) -> crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder {
23        crate::operation::describe_registration_field_values::builders::DescribeRegistrationFieldValuesFluentBuilder::new(self.handle.clone())
24    }
25}