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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// 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 GetScanOutput {
/// <p>The name of the scan.</p>
pub scan_name: ::std::string::String,
/// <p>UUID that identifies the individual scan run.</p>
pub run_id: ::std::string::String,
/// <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
pub scan_state: crate::types::ScanState,
/// <p>The time the scan was created.</p>
pub created_at: ::aws_smithy_types::DateTime,
/// <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
pub analysis_type: crate::types::AnalysisType,
/// <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The number of times a scan has been re-run on a revised resource.</p>
pub number_of_revisions: ::std::option::Option<i64>,
/// <p>The ARN for the scan name.</p>
pub scan_name_arn: ::std::option::Option<::std::string::String>,
/// <p>Details about the error that causes a scan to fail to be retrieved.</p>
pub error_message: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetScanOutput {
/// <p>The name of the scan.</p>
pub fn scan_name(&self) -> &str {
use std::ops::Deref;
self.scan_name.deref()
}
/// <p>UUID that identifies the individual scan run.</p>
pub fn run_id(&self) -> &str {
use std::ops::Deref;
self.run_id.deref()
}
/// <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
pub fn scan_state(&self) -> &crate::types::ScanState {
&self.scan_state
}
/// <p>The time the scan was created.</p>
pub fn created_at(&self) -> &::aws_smithy_types::DateTime {
&self.created_at
}
/// <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
pub fn analysis_type(&self) -> &crate::types::AnalysisType {
&self.analysis_type
}
/// <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.updated_at.as_ref()
}
/// <p>The number of times a scan has been re-run on a revised resource.</p>
pub fn number_of_revisions(&self) -> ::std::option::Option<i64> {
self.number_of_revisions
}
/// <p>The ARN for the scan name.</p>
pub fn scan_name_arn(&self) -> ::std::option::Option<&str> {
self.scan_name_arn.as_deref()
}
/// <p>Details about the error that causes a scan to fail to be retrieved.</p>
pub fn error_message(&self) -> ::std::option::Option<&str> {
self.error_message.as_deref()
}
}
impl ::aws_types::request_id::RequestId for GetScanOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetScanOutput {
/// Creates a new builder-style object to manufacture [`GetScanOutput`](crate::operation::get_scan::GetScanOutput).
pub fn builder() -> crate::operation::get_scan::builders::GetScanOutputBuilder {
crate::operation::get_scan::builders::GetScanOutputBuilder::default()
}
}
/// A builder for [`GetScanOutput`](crate::operation::get_scan::GetScanOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetScanOutputBuilder {
pub(crate) scan_name: ::std::option::Option<::std::string::String>,
pub(crate) run_id: ::std::option::Option<::std::string::String>,
pub(crate) scan_state: ::std::option::Option<crate::types::ScanState>,
pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) analysis_type: ::std::option::Option<crate::types::AnalysisType>,
pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) number_of_revisions: ::std::option::Option<i64>,
pub(crate) scan_name_arn: ::std::option::Option<::std::string::String>,
pub(crate) error_message: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl GetScanOutputBuilder {
/// <p>The name of the scan.</p>
/// This field is required.
pub fn scan_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scan_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the scan.</p>
pub fn set_scan_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scan_name = input;
self
}
/// <p>The name of the scan.</p>
pub fn get_scan_name(&self) -> &::std::option::Option<::std::string::String> {
&self.scan_name
}
/// <p>UUID that identifies the individual scan run.</p>
/// This field is required.
pub fn run_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.run_id = ::std::option::Option::Some(input.into());
self
}
/// <p>UUID that identifies the individual scan run.</p>
pub fn set_run_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.run_id = input;
self
}
/// <p>UUID that identifies the individual scan run.</p>
pub fn get_run_id(&self) -> &::std::option::Option<::std::string::String> {
&self.run_id
}
/// <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
/// This field is required.
pub fn scan_state(mut self, input: crate::types::ScanState) -> Self {
self.scan_state = ::std::option::Option::Some(input);
self
}
/// <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
pub fn set_scan_state(mut self, input: ::std::option::Option<crate::types::ScanState>) -> Self {
self.scan_state = input;
self
}
/// <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
pub fn get_scan_state(&self) -> &::std::option::Option<crate::types::ScanState> {
&self.scan_state
}
/// <p>The time the scan was created.</p>
/// This field is required.
pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.created_at = ::std::option::Option::Some(input);
self
}
/// <p>The time the scan was created.</p>
pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.created_at = input;
self
}
/// <p>The time the scan was created.</p>
pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_at
}
/// <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
/// This field is required.
pub fn analysis_type(mut self, input: crate::types::AnalysisType) -> Self {
self.analysis_type = ::std::option::Option::Some(input);
self
}
/// <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
pub fn set_analysis_type(mut self, input: ::std::option::Option<crate::types::AnalysisType>) -> Self {
self.analysis_type = input;
self
}
/// <p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>
pub fn get_analysis_type(&self) -> &::std::option::Option<crate::types::AnalysisType> {
&self.analysis_type
}
/// <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.updated_at = ::std::option::Option::Some(input);
self
}
/// <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.updated_at = input;
self
}
/// <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.updated_at
}
/// <p>The number of times a scan has been re-run on a revised resource.</p>
pub fn number_of_revisions(mut self, input: i64) -> Self {
self.number_of_revisions = ::std::option::Option::Some(input);
self
}
/// <p>The number of times a scan has been re-run on a revised resource.</p>
pub fn set_number_of_revisions(mut self, input: ::std::option::Option<i64>) -> Self {
self.number_of_revisions = input;
self
}
/// <p>The number of times a scan has been re-run on a revised resource.</p>
pub fn get_number_of_revisions(&self) -> &::std::option::Option<i64> {
&self.number_of_revisions
}
/// <p>The ARN for the scan name.</p>
pub fn scan_name_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scan_name_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN for the scan name.</p>
pub fn set_scan_name_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scan_name_arn = input;
self
}
/// <p>The ARN for the scan name.</p>
pub fn get_scan_name_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.scan_name_arn
}
/// <p>Details about the error that causes a scan to fail to be retrieved.</p>
pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.error_message = ::std::option::Option::Some(input.into());
self
}
/// <p>Details about the error that causes a scan to fail to be retrieved.</p>
pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.error_message = input;
self
}
/// <p>Details about the error that causes a scan to fail to be retrieved.</p>
pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
&self.error_message
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`GetScanOutput`](crate::operation::get_scan::GetScanOutput).
/// This method will fail if any of the following fields are not set:
/// - [`scan_name`](crate::operation::get_scan::builders::GetScanOutputBuilder::scan_name)
/// - [`run_id`](crate::operation::get_scan::builders::GetScanOutputBuilder::run_id)
/// - [`scan_state`](crate::operation::get_scan::builders::GetScanOutputBuilder::scan_state)
/// - [`created_at`](crate::operation::get_scan::builders::GetScanOutputBuilder::created_at)
/// - [`analysis_type`](crate::operation::get_scan::builders::GetScanOutputBuilder::analysis_type)
pub fn build(self) -> ::std::result::Result<crate::operation::get_scan::GetScanOutput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_scan::GetScanOutput {
scan_name: self.scan_name.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"scan_name",
"scan_name was not specified but it is required when building GetScanOutput",
)
})?,
run_id: self.run_id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"run_id",
"run_id was not specified but it is required when building GetScanOutput",
)
})?,
scan_state: self.scan_state.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"scan_state",
"scan_state was not specified but it is required when building GetScanOutput",
)
})?,
created_at: self.created_at.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"created_at",
"created_at was not specified but it is required when building GetScanOutput",
)
})?,
analysis_type: self.analysis_type.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"analysis_type",
"analysis_type was not specified but it is required when building GetScanOutput",
)
})?,
updated_at: self.updated_at,
number_of_revisions: self.number_of_revisions,
scan_name_arn: self.scan_name_arn,
error_message: self.error_message,
_request_id: self._request_id,
})
}
}