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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
// 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 DescribeResourceScanOutput {
/// <p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>
pub resource_scan_id: ::std::option::Option<::std::string::String>,
/// <p>Status of the resource scan.</p>
/// <dl>
/// <dt>
/// INPROGRESS
/// </dt>
/// <dd>
/// <p>The resource scan is still in progress.</p>
/// </dd>
/// <dt>
/// COMPLETE
/// </dt>
/// <dd>
/// <p>The resource scan is complete.</p>
/// </dd>
/// <dt>
/// EXPIRED
/// </dt>
/// <dd>
/// <p>The resource scan has expired.</p>
/// </dd>
/// <dt>
/// FAILED
/// </dt>
/// <dd>
/// <p>The resource scan has failed.</p>
/// </dd>
/// </dl>
pub status: ::std::option::Option<crate::types::ResourceScanStatus>,
/// <p>The reason for the resource scan status, providing more information if a failure happened.</p>
pub status_reason: ::std::option::Option<::std::string::String>,
/// <p>The time that the resource scan was started.</p>
pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The time that the resource scan was finished.</p>
pub end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The percentage of the resource scan that has been completed.</p>
pub percentage_completed: ::std::option::Option<f64>,
/// <p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>
pub resource_types: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>
pub resources_scanned: ::std::option::Option<i32>,
/// <p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p><note>
/// <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p>
/// </note>
pub resources_read: ::std::option::Option<i32>,
_request_id: Option<String>,
}
impl DescribeResourceScanOutput {
/// <p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>
pub fn resource_scan_id(&self) -> ::std::option::Option<&str> {
self.resource_scan_id.as_deref()
}
/// <p>Status of the resource scan.</p>
/// <dl>
/// <dt>
/// INPROGRESS
/// </dt>
/// <dd>
/// <p>The resource scan is still in progress.</p>
/// </dd>
/// <dt>
/// COMPLETE
/// </dt>
/// <dd>
/// <p>The resource scan is complete.</p>
/// </dd>
/// <dt>
/// EXPIRED
/// </dt>
/// <dd>
/// <p>The resource scan has expired.</p>
/// </dd>
/// <dt>
/// FAILED
/// </dt>
/// <dd>
/// <p>The resource scan has failed.</p>
/// </dd>
/// </dl>
pub fn status(&self) -> ::std::option::Option<&crate::types::ResourceScanStatus> {
self.status.as_ref()
}
/// <p>The reason for the resource scan status, providing more information if a failure happened.</p>
pub fn status_reason(&self) -> ::std::option::Option<&str> {
self.status_reason.as_deref()
}
/// <p>The time that the resource scan was started.</p>
pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.start_time.as_ref()
}
/// <p>The time that the resource scan was finished.</p>
pub fn end_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.end_time.as_ref()
}
/// <p>The percentage of the resource scan that has been completed.</p>
pub fn percentage_completed(&self) -> ::std::option::Option<f64> {
self.percentage_completed
}
/// <p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.resource_types.is_none()`.
pub fn resource_types(&self) -> &[::std::string::String] {
self.resource_types.as_deref().unwrap_or_default()
}
/// <p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>
pub fn resources_scanned(&self) -> ::std::option::Option<i32> {
self.resources_scanned
}
/// <p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p><note>
/// <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p>
/// </note>
pub fn resources_read(&self) -> ::std::option::Option<i32> {
self.resources_read
}
}
impl ::aws_types::request_id::RequestId for DescribeResourceScanOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeResourceScanOutput {
/// Creates a new builder-style object to manufacture [`DescribeResourceScanOutput`](crate::operation::describe_resource_scan::DescribeResourceScanOutput).
pub fn builder() -> crate::operation::describe_resource_scan::builders::DescribeResourceScanOutputBuilder {
crate::operation::describe_resource_scan::builders::DescribeResourceScanOutputBuilder::default()
}
}
/// A builder for [`DescribeResourceScanOutput`](crate::operation::describe_resource_scan::DescribeResourceScanOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeResourceScanOutputBuilder {
pub(crate) resource_scan_id: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::ResourceScanStatus>,
pub(crate) status_reason: ::std::option::Option<::std::string::String>,
pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) percentage_completed: ::std::option::Option<f64>,
pub(crate) resource_types: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) resources_scanned: ::std::option::Option<i32>,
pub(crate) resources_read: ::std::option::Option<i32>,
_request_id: Option<String>,
}
impl DescribeResourceScanOutputBuilder {
/// <p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>
pub fn resource_scan_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.resource_scan_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>
pub fn set_resource_scan_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.resource_scan_id = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the resource scan. The format is <code>arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}</code>. An example is <code>arn:aws:cloudformation:<i>us-east-1</i>:<i>123456789012</i>:resourceScan/<i>f5b490f7-7ed4-428a-aa06-31ff25db0772</i> </code>.</p>
pub fn get_resource_scan_id(&self) -> &::std::option::Option<::std::string::String> {
&self.resource_scan_id
}
/// <p>Status of the resource scan.</p>
/// <dl>
/// <dt>
/// INPROGRESS
/// </dt>
/// <dd>
/// <p>The resource scan is still in progress.</p>
/// </dd>
/// <dt>
/// COMPLETE
/// </dt>
/// <dd>
/// <p>The resource scan is complete.</p>
/// </dd>
/// <dt>
/// EXPIRED
/// </dt>
/// <dd>
/// <p>The resource scan has expired.</p>
/// </dd>
/// <dt>
/// FAILED
/// </dt>
/// <dd>
/// <p>The resource scan has failed.</p>
/// </dd>
/// </dl>
pub fn status(mut self, input: crate::types::ResourceScanStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>Status of the resource scan.</p>
/// <dl>
/// <dt>
/// INPROGRESS
/// </dt>
/// <dd>
/// <p>The resource scan is still in progress.</p>
/// </dd>
/// <dt>
/// COMPLETE
/// </dt>
/// <dd>
/// <p>The resource scan is complete.</p>
/// </dd>
/// <dt>
/// EXPIRED
/// </dt>
/// <dd>
/// <p>The resource scan has expired.</p>
/// </dd>
/// <dt>
/// FAILED
/// </dt>
/// <dd>
/// <p>The resource scan has failed.</p>
/// </dd>
/// </dl>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::ResourceScanStatus>) -> Self {
self.status = input;
self
}
/// <p>Status of the resource scan.</p>
/// <dl>
/// <dt>
/// INPROGRESS
/// </dt>
/// <dd>
/// <p>The resource scan is still in progress.</p>
/// </dd>
/// <dt>
/// COMPLETE
/// </dt>
/// <dd>
/// <p>The resource scan is complete.</p>
/// </dd>
/// <dt>
/// EXPIRED
/// </dt>
/// <dd>
/// <p>The resource scan has expired.</p>
/// </dd>
/// <dt>
/// FAILED
/// </dt>
/// <dd>
/// <p>The resource scan has failed.</p>
/// </dd>
/// </dl>
pub fn get_status(&self) -> &::std::option::Option<crate::types::ResourceScanStatus> {
&self.status
}
/// <p>The reason for the resource scan status, providing more information if a failure happened.</p>
pub fn status_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.status_reason = ::std::option::Option::Some(input.into());
self
}
/// <p>The reason for the resource scan status, providing more information if a failure happened.</p>
pub fn set_status_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.status_reason = input;
self
}
/// <p>The reason for the resource scan status, providing more information if a failure happened.</p>
pub fn get_status_reason(&self) -> &::std::option::Option<::std::string::String> {
&self.status_reason
}
/// <p>The time that the resource scan was started.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.start_time = ::std::option::Option::Some(input);
self
}
/// <p>The time that the resource scan was started.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.start_time = input;
self
}
/// <p>The time that the resource scan was started.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.start_time
}
/// <p>The time that the resource scan was finished.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.end_time = ::std::option::Option::Some(input);
self
}
/// <p>The time that the resource scan was finished.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.end_time = input;
self
}
/// <p>The time that the resource scan was finished.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.end_time
}
/// <p>The percentage of the resource scan that has been completed.</p>
pub fn percentage_completed(mut self, input: f64) -> Self {
self.percentage_completed = ::std::option::Option::Some(input);
self
}
/// <p>The percentage of the resource scan that has been completed.</p>
pub fn set_percentage_completed(mut self, input: ::std::option::Option<f64>) -> Self {
self.percentage_completed = input;
self
}
/// <p>The percentage of the resource scan that has been completed.</p>
pub fn get_percentage_completed(&self) -> &::std::option::Option<f64> {
&self.percentage_completed
}
/// Appends an item to `resource_types`.
///
/// To override the contents of this collection use [`set_resource_types`](Self::set_resource_types).
///
/// <p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>
pub fn resource_types(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.resource_types.unwrap_or_default();
v.push(input.into());
self.resource_types = ::std::option::Option::Some(v);
self
}
/// <p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>
pub fn set_resource_types(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.resource_types = input;
self
}
/// <p>The list of resource types for the specified scan. Resource types are only available for scans with a <code>Status</code> set to <code>COMPLETE</code> or <code>FAILED </code>.</p>
pub fn get_resource_types(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.resource_types
}
/// <p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>
pub fn resources_scanned(mut self, input: i32) -> Self {
self.resources_scanned = ::std::option::Option::Some(input);
self
}
/// <p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>
pub fn set_resources_scanned(mut self, input: ::std::option::Option<i32>) -> Self {
self.resources_scanned = input;
self
}
/// <p>The number of resources that were listed. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p>
pub fn get_resources_scanned(&self) -> &::std::option::Option<i32> {
&self.resources_scanned
}
/// <p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p><note>
/// <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p>
/// </note>
pub fn resources_read(mut self, input: i32) -> Self {
self.resources_read = ::std::option::Option::Some(input);
self
}
/// <p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p><note>
/// <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p>
/// </note>
pub fn set_resources_read(mut self, input: ::std::option::Option<i32>) -> Self {
self.resources_read = input;
self
}
/// <p>The number of resources that were read. This is only available for scans with a <code>Status</code> set to <code>COMPLETE</code>, <code>EXPIRED</code>, or <code>FAILED </code>.</p><note>
/// <p>This field may be 0 if the resource scan failed with a <code>ResourceScanLimitExceededException</code>.</p>
/// </note>
pub fn get_resources_read(&self) -> &::std::option::Option<i32> {
&self.resources_read
}
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 [`DescribeResourceScanOutput`](crate::operation::describe_resource_scan::DescribeResourceScanOutput).
pub fn build(self) -> crate::operation::describe_resource_scan::DescribeResourceScanOutput {
crate::operation::describe_resource_scan::DescribeResourceScanOutput {
resource_scan_id: self.resource_scan_id,
status: self.status,
status_reason: self.status_reason,
start_time: self.start_time,
end_time: self.end_time,
percentage_completed: self.percentage_completed,
resource_types: self.resource_types,
resources_scanned: self.resources_scanned,
resources_read: self.resources_read,
_request_id: self._request_id,
}
}
}