aws_sdk_rekognition/operation/list_faces/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_faces::_list_faces_output::ListFacesOutputBuilder;
3
4pub use crate::operation::list_faces::_list_faces_input::ListFacesInputBuilder;
5
6impl crate::operation::list_faces::builders::ListFacesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_faces::ListFacesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_faces::ListFacesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_faces();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListFaces`.
24///
25/// <p>Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.</p>
26/// <p>This operation requires permissions to perform the <code>rekognition:ListFaces</code> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListFacesFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_faces::builders::ListFacesInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl crate::client::customize::internal::CustomizableSend<crate::operation::list_faces::ListFacesOutput, crate::operation::list_faces::ListFacesError>
34    for ListFacesFluentBuilder
35{
36    fn send(
37        self,
38        config_override: crate::config::Builder,
39    ) -> crate::client::customize::internal::BoxFuture<
40        crate::client::customize::internal::SendResult<crate::operation::list_faces::ListFacesOutput, crate::operation::list_faces::ListFacesError>,
41    > {
42        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
43    }
44}
45impl ListFacesFluentBuilder {
46    /// Creates a new `ListFacesFluentBuilder`.
47    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
48        Self {
49            handle,
50            inner: ::std::default::Default::default(),
51            config_override: ::std::option::Option::None,
52        }
53    }
54    /// Access the ListFaces as a reference.
55    pub fn as_input(&self) -> &crate::operation::list_faces::builders::ListFacesInputBuilder {
56        &self.inner
57    }
58    /// Sends the request and returns the response.
59    ///
60    /// If an error occurs, an `SdkError` will be returned with additional details that
61    /// can be matched against.
62    ///
63    /// By default, any retryable failures will be retried twice. Retry behavior
64    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
65    /// set when configuring the client.
66    pub async fn send(
67        self,
68    ) -> ::std::result::Result<
69        crate::operation::list_faces::ListFacesOutput,
70        ::aws_smithy_runtime_api::client::result::SdkError<
71            crate::operation::list_faces::ListFacesError,
72            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
73        >,
74    > {
75        let input = self
76            .inner
77            .build()
78            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
79        let runtime_plugins = crate::operation::list_faces::ListFaces::operation_runtime_plugins(
80            self.handle.runtime_plugins.clone(),
81            &self.handle.conf,
82            self.config_override,
83        );
84        crate::operation::list_faces::ListFaces::orchestrate(&runtime_plugins, input).await
85    }
86
87    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
88    pub fn customize(
89        self,
90    ) -> crate::client::customize::CustomizableOperation<
91        crate::operation::list_faces::ListFacesOutput,
92        crate::operation::list_faces::ListFacesError,
93        Self,
94    > {
95        crate::client::customize::CustomizableOperation::new(self)
96    }
97    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
98        self.set_config_override(::std::option::Option::Some(config_override.into()));
99        self
100    }
101
102    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
103        self.config_override = config_override;
104        self
105    }
106    /// Create a paginator for this request
107    ///
108    /// Paginators are used by calling [`send().await`](crate::operation::list_faces::paginator::ListFacesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
109    pub fn into_paginator(self) -> crate::operation::list_faces::paginator::ListFacesPaginator {
110        crate::operation::list_faces::paginator::ListFacesPaginator::new(self.handle, self.inner)
111    }
112    /// <p>ID of the collection from which to list the faces.</p>
113    pub fn collection_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.collection_id(input.into());
115        self
116    }
117    /// <p>ID of the collection from which to list the faces.</p>
118    pub fn set_collection_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_collection_id(input);
120        self
121    }
122    /// <p>ID of the collection from which to list the faces.</p>
123    pub fn get_collection_id(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_collection_id()
125    }
126    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</p>
127    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.next_token(input.into());
129        self
130    }
131    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</p>
132    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_next_token(input);
134        self
135    }
136    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</p>
137    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_next_token()
139    }
140    /// <p>Maximum number of faces to return.</p>
141    pub fn max_results(mut self, input: i32) -> Self {
142        self.inner = self.inner.max_results(input);
143        self
144    }
145    /// <p>Maximum number of faces to return.</p>
146    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
147        self.inner = self.inner.set_max_results(input);
148        self
149    }
150    /// <p>Maximum number of faces to return.</p>
151    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
152        self.inner.get_max_results()
153    }
154    /// <p>An array of user IDs to filter results with when listing faces in a collection.</p>
155    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
156        self.inner = self.inner.user_id(input.into());
157        self
158    }
159    /// <p>An array of user IDs to filter results with when listing faces in a collection.</p>
160    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
161        self.inner = self.inner.set_user_id(input);
162        self
163    }
164    /// <p>An array of user IDs to filter results with when listing faces in a collection.</p>
165    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
166        self.inner.get_user_id()
167    }
168    ///
169    /// Appends an item to `FaceIds`.
170    ///
171    /// To override the contents of this collection use [`set_face_ids`](Self::set_face_ids).
172    ///
173    /// <p>An array of face IDs to filter results with when listing faces in a collection.</p>
174    pub fn face_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175        self.inner = self.inner.face_ids(input.into());
176        self
177    }
178    /// <p>An array of face IDs to filter results with when listing faces in a collection.</p>
179    pub fn set_face_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
180        self.inner = self.inner.set_face_ids(input);
181        self
182    }
183    /// <p>An array of face IDs to filter results with when listing faces in a collection.</p>
184    pub fn get_face_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
185        self.inner.get_face_ids()
186    }
187}
aws_sdk_rekognition/operation/list_faces/builders.rs

aws_sdk_rekognition/operation/list_faces/
builders.rs
