aws_sdk_pinpointsmsvoicev2/client/
describe_sender_ids.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 [`DescribeSenderIds`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`sender_ids(SenderIdAndCountry)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::sender_ids) / [`set_sender_ids(Option<Vec::<SenderIdAndCountry>>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::set_sender_ids):<br>required: **false**<br><p>An array of SenderIdAndCountry objects to search for.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
8    ///   - [`filters(SenderIdFilter)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::filters) / [`set_filters(Option<Vec::<SenderIdFilter>>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of SenderIdFilter objects to filter the results.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::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_sender_ids::builders::DescribeSenderIdsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per each request.</p><br>
11    ///   - [`owner(Owner)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::owner) / [`set_owner(Option<Owner>)`](crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::set_owner):<br>required: **false**<br><p>Use <code>SELF</code> to filter the list of Sender Ids to ones your account owns or use <code>SHARED</code> to filter on Sender Ids shared with your account. The <code>Owner</code> and <code>SenderIds</code> parameters can't be used at the same time.</p><br>
12    /// - On success, responds with [`DescribeSenderIdsOutput`](crate::operation::describe_sender_ids::DescribeSenderIdsOutput) with field(s):
13    ///   - [`sender_ids(Option<Vec::<SenderIdInformation>>)`](crate::operation::describe_sender_ids::DescribeSenderIdsOutput::sender_ids): <p>An array of SernderIdInformation objects that contain the details for the requested SenderIds.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_sender_ids::DescribeSenderIdsOutput::next_token): <p>The token to be used for the next set of paginated results. If this field is empty then there are no more results.</p>
15    /// - On failure, responds with [`SdkError<DescribeSenderIdsError>`](crate::operation::describe_sender_ids::DescribeSenderIdsError)
16    pub fn describe_sender_ids(&self) -> crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder {
17        crate::operation::describe_sender_ids::builders::DescribeSenderIdsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_pinpointsmsvoicev2/client/describe_sender_ids.rs

aws_sdk_pinpointsmsvoicev2/client/
describe_sender_ids.rs
