aws-sdk-connect 1.171.0

AWS SDK for Amazon Connect Service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::search_contact_evaluations::_search_contact_evaluations_input::SearchContactEvaluationsInputBuilder;

pub use crate::operation::search_contact_evaluations::_search_contact_evaluations_output::SearchContactEvaluationsOutputBuilder;

impl crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::search_contact_evaluations::SearchContactEvaluationsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.search_contact_evaluations();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `SearchContactEvaluations`.
///
/// <p>Searches contact evaluations in an Amazon Connect instance, with optional filtering.</p>
/// <p><b>Use cases</b></p>
/// <p>Following are common uses cases for this API:</p>
/// <ul>
/// <li>
/// <p>Find contact evaluations by using specific search criteria.</p></li>
/// <li>
/// <p>Find contact evaluations that are tagged with a specific set of tags.</p></li>
/// </ul>
/// <p><b>Important things to know</b></p>
/// <ul>
/// <li>
/// <p>A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.</p></li>
/// </ul>
/// <p><b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and quotas</a>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct SearchContactEvaluationsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput,
        crate::operation::search_contact_evaluations::SearchContactEvaluationsError,
    > for SearchContactEvaluationsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput,
            crate::operation::search_contact_evaluations::SearchContactEvaluationsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl SearchContactEvaluationsFluentBuilder {
    /// Creates a new `SearchContactEvaluationsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the SearchContactEvaluations as a reference.
    pub fn as_input(&self) -> &crate::operation::search_contact_evaluations::builders::SearchContactEvaluationsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::search_contact_evaluations::SearchContactEvaluationsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::search_contact_evaluations::SearchContactEvaluations::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::search_contact_evaluations::SearchContactEvaluations::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::search_contact_evaluations::SearchContactEvaluationsOutput,
        crate::operation::search_contact_evaluations::SearchContactEvaluationsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.instance_id(input.into());
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_instance_id(input);
        self
    }
    /// <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_instance_id()
    }
    /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>The maximum number of results to return per page.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The maximum number of results to return per page.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The maximum number of results to return per page.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <p>The search criteria to be used to return contact evaluations.</p>
    pub fn search_criteria(mut self, input: crate::types::EvaluationSearchCriteria) -> Self {
        self.inner = self.inner.search_criteria(input);
        self
    }
    /// <p>The search criteria to be used to return contact evaluations.</p>
    pub fn set_search_criteria(mut self, input: ::std::option::Option<crate::types::EvaluationSearchCriteria>) -> Self {
        self.inner = self.inner.set_search_criteria(input);
        self
    }
    /// <p>The search criteria to be used to return contact evaluations.</p>
    pub fn get_search_criteria(&self) -> &::std::option::Option<crate::types::EvaluationSearchCriteria> {
        self.inner.get_search_criteria()
    }
    /// <p>Filters to be applied to search results.</p>
    pub fn search_filter(mut self, input: crate::types::EvaluationSearchFilter) -> Self {
        self.inner = self.inner.search_filter(input);
        self
    }
    /// <p>Filters to be applied to search results.</p>
    pub fn set_search_filter(mut self, input: ::std::option::Option<crate::types::EvaluationSearchFilter>) -> Self {
        self.inner = self.inner.set_search_filter(input);
        self
    }
    /// <p>Filters to be applied to search results.</p>
    pub fn get_search_filter(&self) -> &::std::option::Option<crate::types::EvaluationSearchFilter> {
        self.inner.get_search_filter()
    }
}