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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_top_path_statistics_by_traffic::_get_top_path_statistics_by_traffic_input::GetTopPathStatisticsByTrafficInputBuilder;
pub use crate::operation::get_top_path_statistics_by_traffic::_get_top_path_statistics_by_traffic_output::GetTopPathStatisticsByTrafficOutputBuilder;
impl crate::operation::get_top_path_statistics_by_traffic::builders::GetTopPathStatisticsByTrafficInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.get_top_path_statistics_by_traffic();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `GetTopPathStatisticsByTraffic`.
///
/// <p>Retrieves aggregated statistics about the top URI paths accessed by bot traffic for a specified web ACL and time window. You can use this operation to analyze which paths on your web application receive the most bot traffic and identify the specific bots accessing those paths. The operation supports filtering by bot category, organization, or name, and allows you to drill down into specific path prefixes to view detailed URI-level statistics.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetTopPathStatisticsByTrafficFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::get_top_path_statistics_by_traffic::builders::GetTopPathStatisticsByTrafficInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficOutput,
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficError,
> for GetTopPathStatisticsByTrafficFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficOutput,
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl GetTopPathStatisticsByTrafficFluentBuilder {
/// Creates a new `GetTopPathStatisticsByTrafficFluentBuilder`.
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 GetTopPathStatisticsByTraffic as a reference.
pub fn as_input(&self) -> &crate::operation::get_top_path_statistics_by_traffic::builders::GetTopPathStatisticsByTrafficInputBuilder {
&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::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficError,
::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::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTraffic::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTraffic::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::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficOutput,
crate::operation::get_top_path_statistics_by_traffic::GetTopPathStatisticsByTrafficError,
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 Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.</p>
pub fn web_acl_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.web_acl_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.</p>
pub fn set_web_acl_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_web_acl_arn(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the web ACL for which you want to retrieve path statistics.</p>
pub fn get_web_acl_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_web_acl_arn()
}
/// <p>Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.</p>
pub fn scope(mut self, input: crate::types::Scope) -> Self {
self.inner = self.inner.scope(input);
self
}
/// <p>Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.</p>
pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
self.inner = self.inner.set_scope(input);
self
}
/// <p>Specifies whether the web ACL is for an Amazon Web Services CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an Amazon Web Services App Runner service, or an Amazon Web Services Verified Access instance.</p>
pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
self.inner.get_scope()
}
/// <p>A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify <code>/api</code>, the response includes statistics for paths like <code>/api/v1/users</code> and <code>/api/v2/orders</code>. If you don't specify this parameter, the operation returns top-level path statistics.</p>
pub fn uri_path_prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.uri_path_prefix(input.into());
self
}
/// <p>A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify <code>/api</code>, the response includes statistics for paths like <code>/api/v1/users</code> and <code>/api/v2/orders</code>. If you don't specify this parameter, the operation returns top-level path statistics.</p>
pub fn set_uri_path_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_uri_path_prefix(input);
self
}
/// <p>A URI path prefix to filter the results. When you specify this parameter, the operation returns statistics for individual URIs within the specified path prefix. For example, if you specify <code>/api</code>, the response includes statistics for paths like <code>/api/v1/users</code> and <code>/api/v2/orders</code>. If you don't specify this parameter, the operation returns top-level path statistics.</p>
pub fn get_uri_path_prefix(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_uri_path_prefix()
}
/// <p>The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.</p>
pub fn time_window(mut self, input: crate::types::TimeWindow) -> Self {
self.inner = self.inner.time_window(input);
self
}
/// <p>The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.</p>
pub fn set_time_window(mut self, input: ::std::option::Option<crate::types::TimeWindow>) -> Self {
self.inner = self.inner.set_time_window(input);
self
}
/// <p>The time window for which you want to retrieve path statistics. The time window must be within the data retention period for your web ACL.</p>
pub fn get_time_window(&self) -> &::std::option::Option<crate::types::TimeWindow> {
self.inner.get_time_window()
}
/// <p>Filters the results to include only traffic from bots in the specified category. For example, you can filter by <code>ai</code> to see only AI crawler traffic, or <code>search_engine</code> to see only search engine bot traffic. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn bot_category(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.bot_category(input.into());
self
}
/// <p>Filters the results to include only traffic from bots in the specified category. For example, you can filter by <code>ai</code> to see only AI crawler traffic, or <code>search_engine</code> to see only search engine bot traffic. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn set_bot_category(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_bot_category(input);
self
}
/// <p>Filters the results to include only traffic from bots in the specified category. For example, you can filter by <code>ai</code> to see only AI crawler traffic, or <code>search_engine</code> to see only search engine bot traffic. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn get_bot_category(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_bot_category()
}
/// <p>Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by <code>openai</code> or <code>google</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn bot_organization(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.bot_organization(input.into());
self
}
/// <p>Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by <code>openai</code> or <code>google</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn set_bot_organization(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_bot_organization(input);
self
}
/// <p>Filters the results to include only traffic from bots belonging to the specified organization. For example, you can filter by <code>openai</code> or <code>google</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn get_bot_organization(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_bot_organization()
}
/// <p>Filters the results to include only traffic from the specified bot. For example, you can filter by <code>gptbot</code> or <code>googlebot</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn bot_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.bot_name(input.into());
self
}
/// <p>Filters the results to include only traffic from the specified bot. For example, you can filter by <code>gptbot</code> or <code>googlebot</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn set_bot_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_bot_name(input);
self
}
/// <p>Filters the results to include only traffic from the specified bot. For example, you can filter by <code>gptbot</code> or <code>googlebot</code>. When you apply this filter, the <code>Source</code> field is populated in the response.</p>
pub fn get_bot_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_bot_name()
}
/// <p>The maximum number of path statistics to return. Valid values are 1 to 100.</p>
pub fn limit(mut self, input: i32) -> Self {
self.inner = self.inner.limit(input);
self
}
/// <p>The maximum number of path statistics to return. Valid values are 1 to 100.</p>
pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_limit(input);
self
}
/// <p>The maximum number of path statistics to return. Valid values are 1 to 100.</p>
pub fn get_limit(&self) -> &::std::option::Option<i32> {
self.inner.get_limit()
}
/// <p>The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.</p>
pub fn number_of_top_traffic_bots_per_path(mut self, input: i32) -> Self {
self.inner = self.inner.number_of_top_traffic_bots_per_path(input);
self
}
/// <p>The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.</p>
pub fn set_number_of_top_traffic_bots_per_path(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_number_of_top_traffic_bots_per_path(input);
self
}
/// <p>The maximum number of top bots to include in the statistics for each path. Valid values are 1 to 10.</p>
pub fn get_number_of_top_traffic_bots_per_path(&self) -> &::std::option::Option<i32> {
self.inner.get_number_of_top_traffic_bots_per_path()
}
/// <p>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.</p>
pub fn next_marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_marker(input.into());
self
}
/// <p>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.</p>
pub fn set_next_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_marker(input);
self
}
/// <p>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.</p>
pub fn get_next_marker(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_marker()
}
}