aws_sdk_voiceid/client/
list_fraudsters.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListFraudsters`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_id(impl Into<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::set_domain_id):<br>required: **true**<br><p>The identifier of the domain.</p><br>
    ///   - [`watchlist_id(impl Into<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::watchlist_id) / [`set_watchlist_id(Option<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::set_watchlist_id):<br>required: **false**<br><p>The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::set_next_token):<br>required: **false**<br><p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.</p><br>
    /// - On success, responds with [`ListFraudstersOutput`](crate::operation::list_fraudsters::ListFraudstersOutput) with field(s):
    ///   - [`fraudster_summaries(Option<Vec::<FraudsterSummary>>)`](crate::operation::list_fraudsters::ListFraudstersOutput::fraudster_summaries): <p>A list that contains details about each fraudster in the Amazon Web Services account.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_fraudsters::ListFraudstersOutput::next_token): <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.</p>
    /// - On failure, responds with [`SdkError<ListFraudstersError>`](crate::operation::list_fraudsters::ListFraudstersError)
    pub fn list_fraudsters(&self) -> crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder {
        crate::operation::list_fraudsters::builders::ListFraudstersFluentBuilder::new(self.handle.clone())
    }
}