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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetSampledRequestsInput {
/// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
pub web_acl_arn: ::std::option::Option<::std::string::String>,
/// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
pub rule_metric_name: ::std::option::Option<::std::string::String>,
/// <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>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub scope: ::std::option::Option<crate::types::Scope>,
/// <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>
pub time_window: ::std::option::Option<crate::types::TimeWindow>,
/// <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>
pub max_items: ::std::option::Option<i64>,
}
impl GetSampledRequestsInput {
/// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
pub fn web_acl_arn(&self) -> ::std::option::Option<&str> {
self.web_acl_arn.as_deref()
}
/// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
pub fn rule_metric_name(&self) -> ::std::option::Option<&str> {
self.rule_metric_name.as_deref()
}
/// <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>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn scope(&self) -> ::std::option::Option<&crate::types::Scope> {
self.scope.as_ref()
}
/// <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>
pub fn time_window(&self) -> ::std::option::Option<&crate::types::TimeWindow> {
self.time_window.as_ref()
}
/// <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>
pub fn max_items(&self) -> ::std::option::Option<i64> {
self.max_items
}
}
impl GetSampledRequestsInput {
/// Creates a new builder-style object to manufacture [`GetSampledRequestsInput`](crate::operation::get_sampled_requests::GetSampledRequestsInput).
pub fn builder() -> crate::operation::get_sampled_requests::builders::GetSampledRequestsInputBuilder {
crate::operation::get_sampled_requests::builders::GetSampledRequestsInputBuilder::default()
}
}
/// A builder for [`GetSampledRequestsInput`](crate::operation::get_sampled_requests::GetSampledRequestsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetSampledRequestsInputBuilder {
pub(crate) web_acl_arn: ::std::option::Option<::std::string::String>,
pub(crate) rule_metric_name: ::std::option::Option<::std::string::String>,
pub(crate) scope: ::std::option::Option<crate::types::Scope>,
pub(crate) time_window: ::std::option::Option<crate::types::TimeWindow>,
pub(crate) max_items: ::std::option::Option<i64>,
}
impl GetSampledRequestsInputBuilder {
/// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
/// This field is required.
pub fn web_acl_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.web_acl_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
pub fn set_web_acl_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.web_acl_arn = input;
self
}
/// <p>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</p>
pub fn get_web_acl_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.web_acl_arn
}
/// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
/// This field is required.
pub fn rule_metric_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.rule_metric_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
pub fn set_rule_metric_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.rule_metric_name = input;
self
}
/// <p>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension for which you want a sample of requests.</p>
pub fn get_rule_metric_name(&self) -> &::std::option::Option<::std::string::String> {
&self.rule_metric_name
}
/// <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>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
/// This field is required.
pub fn scope(mut self, input: crate::types::Scope) -> Self {
self.scope = ::std::option::Option::Some(input);
self
}
/// <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>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn set_scope(mut self, input: ::std::option::Option<crate::types::Scope>) -> Self {
self.scope = input;
self
}
/// <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>
/// <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:</p>
/// <ul>
/// <li>
/// <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>.</p></li>
/// <li>
/// <p>API and SDKs - For all calls, use the Region endpoint us-east-1.</p></li>
/// </ul>
pub fn get_scope(&self) -> &::std::option::Option<crate::types::Scope> {
&self.scope
}
/// <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>
/// This field is required.
pub fn time_window(mut self, input: crate::types::TimeWindow) -> Self {
self.time_window = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_time_window(mut self, input: ::std::option::Option<crate::types::TimeWindow>) -> Self {
self.time_window = input;
self
}
/// <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>
pub fn get_time_window(&self) -> &::std::option::Option<crate::types::TimeWindow> {
&self.time_window
}
/// <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>
/// This field is required.
pub fn max_items(mut self, input: i64) -> Self {
self.max_items = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_max_items(mut self, input: ::std::option::Option<i64>) -> Self {
self.max_items = input;
self
}
/// <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>
pub fn get_max_items(&self) -> &::std::option::Option<i64> {
&self.max_items
}
/// Consumes the builder and constructs a [`GetSampledRequestsInput`](crate::operation::get_sampled_requests::GetSampledRequestsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_sampled_requests::GetSampledRequestsInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::get_sampled_requests::GetSampledRequestsInput {
web_acl_arn: self.web_acl_arn,
rule_metric_name: self.rule_metric_name,
scope: self.scope,
time_window: self.time_window,
max_items: self.max_items,
})
}
}