aws_sdk_pinpointsmsvoicev2/client/describe_registrations.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 [`DescribeRegistrations`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`registration_ids(impl Into<String>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::registration_ids) / [`set_registration_ids(Option<Vec::<String>>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::set_registration_ids):<br>required: **false**<br><p>An array of unique identifiers for each registration.</p><br>
8 /// - [`filters(RegistrationFilter)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::filters) / [`set_filters(Option<Vec::<RegistrationFilter>>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of RegistrationFilter objects to filter the results.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::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>
10 /// - [`max_results(i32)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
11 /// - On success, responds with [`DescribeRegistrationsOutput`](crate::operation::describe_registrations::DescribeRegistrationsOutput) with field(s):
12 /// - [`registrations(Vec::<RegistrationInformation>)`](crate::operation::describe_registrations::DescribeRegistrationsOutput::registrations): <p>An array of RegistrationInformation objects.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::describe_registrations::DescribeRegistrationsOutput::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>
14 /// - On failure, responds with [`SdkError<DescribeRegistrationsError>`](crate::operation::describe_registrations::DescribeRegistrationsError)
15 pub fn describe_registrations(&self) -> crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder {
16 crate::operation::describe_registrations::builders::DescribeRegistrationsFluentBuilder::new(self.handle.clone())
17 }
18}