aws_sdk_rekognition/operation/create_face_liveness_session/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_face_liveness_session::_create_face_liveness_session_output::CreateFaceLivenessSessionOutputBuilder;
3
4pub use crate::operation::create_face_liveness_session::_create_face_liveness_session_input::CreateFaceLivenessSessionInputBuilder;
5
6impl crate::operation::create_face_liveness_session::builders::CreateFaceLivenessSessionInputBuilder {
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::create_face_liveness_session::CreateFaceLivenessSessionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_face_liveness_session::CreateFaceLivenessSessionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_face_liveness_session();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateFaceLivenessSession`.
24///
25/// <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session.</p>
26/// <p>You can use the <code>OutputConfig</code> option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead.</p>
27/// <p>You can use <code>AuditImagesLimit</code> to limit the number of audit images returned when <code>GetFaceLivenessSessionResults</code> is called. This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on the duration of the selfie-video.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct CreateFaceLivenessSessionFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::create_face_liveness_session::builders::CreateFaceLivenessSessionInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::create_face_liveness_session::CreateFaceLivenessSessionOutput,
37        crate::operation::create_face_liveness_session::CreateFaceLivenessSessionError,
38    > for CreateFaceLivenessSessionFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::create_face_liveness_session::CreateFaceLivenessSessionOutput,
46            crate::operation::create_face_liveness_session::CreateFaceLivenessSessionError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl CreateFaceLivenessSessionFluentBuilder {
53    /// Creates a new `CreateFaceLivenessSessionFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the CreateFaceLivenessSession as a reference.
62    pub fn as_input(&self) -> &crate::operation::create_face_liveness_session::builders::CreateFaceLivenessSessionInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::create_face_liveness_session::CreateFaceLivenessSessionOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::create_face_liveness_session::CreateFaceLivenessSessionError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::create_face_liveness_session::CreateFaceLivenessSession::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::create_face_liveness_session::CreateFaceLivenessSession::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::create_face_liveness_session::CreateFaceLivenessSessionOutput,
99        crate::operation::create_face_liveness_session::CreateFaceLivenessSessionError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.</p>
114    pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.kms_key_id(input.into());
116        self
117    }
118    /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.</p>
119    pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_kms_key_id(input);
121        self
122    }
123    /// <p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.</p>
124    pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_kms_key_id()
126    }
127    /// <p>A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>
128    pub fn settings(mut self, input: crate::types::CreateFaceLivenessSessionRequestSettings) -> Self {
129        self.inner = self.inner.settings(input);
130        self
131    }
132    /// <p>A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>
133    pub fn set_settings(mut self, input: ::std::option::Option<crate::types::CreateFaceLivenessSessionRequestSettings>) -> Self {
134        self.inner = self.inner.set_settings(input);
135        self
136    }
137    /// <p>A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>
138    pub fn get_settings(&self) -> &::std::option::Option<crate::types::CreateFaceLivenessSessionRequestSettings> {
139        self.inner.get_settings()
140    }
141    /// <p>Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
142    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143        self.inner = self.inner.client_request_token(input.into());
144        self
145    }
146    /// <p>Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
147    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_client_request_token(input);
149        self
150    }
151    /// <p>Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.</p>
152    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
153        self.inner.get_client_request_token()
154    }
155}
aws_sdk_rekognition/operation/create_face_liveness_session/builders.rs

aws_sdk_rekognition/operation/create_face_liveness_session/
builders.rs
