1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeResourceScan`](crate::operation::describe_resource_scan::builders::DescribeResourceScanFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`resource_scan_id(impl Into<String>)`](crate::operation::describe_resource_scan::builders::DescribeResourceScanFluentBuilder::resource_scan_id) / [`set_resource_scan_id(Option<String>)`](crate::operation::describe_resource_scan::builders::DescribeResourceScanFluentBuilder::set_resource_scan_id):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the resource scan.</p><br>
    /// - On success, responds with [`DescribeResourceScanOutput`](crate::operation::describe_resource_scan::DescribeResourceScanOutput) with field(s):
    ///   - [`resource_scan_id(Option<String>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::resource_scan_id): <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>
    ///   - [`status(Option<ResourceScanStatus>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::status): <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>
    ///   - [`status_reason(Option<String>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::status_reason): <p>The reason for the resource scan status, providing more information if a failure happened.</p>
    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::start_time): <p>The time that the resource scan was started.</p>
    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::end_time): <p>The time that the resource scan was finished.</p>
    ///   - [`percentage_completed(Option<f64>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::percentage_completed): <p>The percentage of the resource scan that has been completed.</p>
    ///   - [`resource_types(Option<Vec::<String>>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::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>
    ///   - [`resources_scanned(Option<i32>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::resources_scanned): <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>
    ///   - [`resources_read(Option<i32>)`](crate::operation::describe_resource_scan::DescribeResourceScanOutput::resources_read): <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>
    /// - On failure, responds with [`SdkError<DescribeResourceScanError>`](crate::operation::describe_resource_scan::DescribeResourceScanError)
    pub fn describe_resource_scan(&self) -> crate::operation::describe_resource_scan::builders::DescribeResourceScanFluentBuilder {
        crate::operation::describe_resource_scan::builders::DescribeResourceScanFluentBuilder::new(self.handle.clone())
    }
}