aws_sdk_pinpointsmsvoicev2/client/
describe_pools.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 [`DescribePools`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`pool_ids(impl Into<String>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::pool_ids) / [`set_pool_ids(Option<Vec::<String>>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::set_pool_ids):<br>required: **false**<br><p>The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.</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(PoolFilter)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::filters) / [`set_filters(Option<Vec::<PoolFilter>>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::set_filters):<br>required: **false**<br><p>An array of PoolFilter objects to filter the results.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::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_pools::builders::DescribePoolsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::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_pools::builders::DescribePoolsFluentBuilder::owner) / [`set_owner(Option<Owner>)`](crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::set_owner):<br>required: **false**<br><p>Use <code>SELF</code> to filter the list of Pools to ones your account owns or use <code>SHARED</code> to filter on Pools shared with your account. The <code>Owner</code> and <code>PoolIds</code> parameters can't be used at the same time.</p><br>
12    /// - On success, responds with [`DescribePoolsOutput`](crate::operation::describe_pools::DescribePoolsOutput) with field(s):
13    ///   - [`pools(Option<Vec::<PoolInformation>>)`](crate::operation::describe_pools::DescribePoolsOutput::pools): <p>An array of PoolInformation objects that contain the details for the requested pools.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_pools::DescribePoolsOutput::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<DescribePoolsError>`](crate::operation::describe_pools::DescribePoolsError)
16    pub fn describe_pools(&self) -> crate::operation::describe_pools::builders::DescribePoolsFluentBuilder {
17        crate::operation::describe_pools::builders::DescribePoolsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_pinpointsmsvoicev2/client/describe_pools.rs

aws_sdk_pinpointsmsvoicev2/client/
describe_pools.rs
