aws_sdk_wafv2/operation/get_sampled_requests/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_sampled_requests::_get_sampled_requests_output::GetSampledRequestsOutputBuilder;
3
4pub use crate::operation::get_sampled_requests::_get_sampled_requests_input::GetSampledRequestsInputBuilder;
5
6impl crate::operation::get_sampled_requests::builders::GetSampledRequestsInputBuilder {
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::get_sampled_requests::GetSampledRequestsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_sampled_requests::GetSampledRequestsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_sampled_requests();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetSampledRequests`.
24///
25/// <p>Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.</p>
26/// <p><code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct GetSampledRequestsFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::get_sampled_requests::builders::GetSampledRequestsInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::get_sampled_requests::GetSampledRequestsOutput,
36 crate::operation::get_sampled_requests::GetSampledRequestsError,
37 > for GetSampledRequestsFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::get_sampled_requests::GetSampledRequestsOutput,
45 crate::operation::get_sampled_requests::GetSampledRequestsError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl GetSampledRequestsFluentBuilder {
52 /// Creates a new `GetSampledRequestsFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the GetSampledRequests as a reference.
61 pub fn as_input(&self) -> &crate::operation::get_sampled_requests::builders::GetSampledRequestsInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::get_sampled_requests::GetSampledRequestsOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::get_sampled_requests::GetSampledRequestsError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::get_sampled_requests::GetSampledRequests::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::get_sampled_requests::GetSampledRequests::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::get_sampled_requests::GetSampledRequestsOutput,
98 crate::operation::get_sampled_requests::GetSampledRequestsError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
113 pub fn web_acl_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114 self.inner = self.inner.web_acl_arn(input.into());
115 self
116 }
117 /// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
118 pub fn set_web_acl_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119 self.inner = self.inner.set_web_acl_arn(input);
120 self
121 }
122 /// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
123 pub fn get_web_acl_arn(&self) -> &::std::option::Option<::std::string::String> {
124 self.inner.get_web_acl_arn()
125 }
126 /// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
127 pub fn rule_metric_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128 self.inner = self.inner.rule_metric_name(input.into());
129 self
130 }
131 /// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
132 pub fn set_rule_metric_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133 self.inner = self.inner.set_rule_metric_name(input);
134 self
135 }
136 /// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
137 pub fn get_rule_metric_name(&self) -> &::std::option::Option<::std::string::String> {
138 self.inner.get_rule_metric_name()
139 }
140 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
141 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
142 /// <ul>
143 /// <li>
144 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
145 /// <li>
146 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
147 /// </ul>
148 pub fn scope(mut self, input: crate::types::Scope) -> Self {
149 self.inner = self.inner.scope(input);
150 self
151 }
152 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
153 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
154 /// <ul>
155 /// <li>
156 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
157 /// <li>
158 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
159 /// </ul>
160 pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
161 self.inner = self.inner.set_scope(input);
162 self
163 }
164 /// <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p>
165 /// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
166 /// <ul>
167 /// <li>
168 /// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
169 /// <li>
170 /// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
171 /// </ul>
172 pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
173 self.inner.get_scope()
174 }
175 /// <p>The start date and time and the end date and time of the range for which you want <code>GetSampledRequests</code> to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.</p>
176 pub fn time_window(mut self, input: crate::types::TimeWindow) -> Self {
177 self.inner = self.inner.time_window(input);
178 self
179 }
180 /// <p>The start date and time and the end date and time of the range for which you want <code>GetSampledRequests</code> to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.</p>
181 pub fn set_time_window(mut self, input: ::std::option::Option<crate::types::TimeWindow>) -> Self {
182 self.inner = self.inner.set_time_window(input);
183 self
184 }
185 /// <p>The start date and time and the end date and time of the range for which you want <code>GetSampledRequests</code> to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.</p>
186 pub fn get_time_window(&self) -> &::std::option::Option<crate::types::TimeWindow> {
187 self.inner.get_time_window()
188 }
189 /// <p>The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them.</p>
190 pub fn max_items(mut self, input: i64) -> Self {
191 self.inner = self.inner.max_items(input);
192 self
193 }
194 /// <p>The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them.</p>
195 pub fn set_max_items(mut self, input: ::std::option::Option<i64>) -> Self {
196 self.inner = self.inner.set_max_items(input);
197 self
198 }
199 /// <p>The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them.</p>
200 pub fn get_max_items(&self) -> &::std::option::Option<i64> {
201 self.inner.get_max_items()
202 }
203}