describe_resource_scan¶
Operation¶
async
¶
describe_resource_scan(input: DescribeResourceScanInput, plugins: list[Plugin] | None = None) -> DescribeResourceScanOutput
Describes details of a resource scan.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeResourceScanInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeResourceScanOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeResourceScanOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
end_time: datetime | None = ...
The time that the resource scan was finished.
class-attribute
instance-attribute
¶
percentage_completed: float | None = ...
The percentage of the resource scan that has been completed.
class-attribute
instance-attribute
¶
resource_scan_id: str | None = ...
The Amazon Resource Name (ARN) of the resource scan. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}.
An example is
arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772.
class-attribute
instance-attribute
¶
The list of resource types for the specified scan. Resource types are
only available for scans with a Status set to COMPLETE or FAILED.
class-attribute
instance-attribute
¶
resources_read: int | None = ...
The number of resources that were read. This is only available for scans
with a Status set to COMPLETE, EXPIRED, or FAILED.
Note
This field may be 0 if the resource scan failed with a
ResourceScanLimitExceededException.
class-attribute
instance-attribute
¶
resources_scanned: int | None = ...
The number of resources that were listed. This is only available for
scans with a Status set to COMPLETE, EXPIRED, or FAILED.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
scan_filters: list[ScanFilter] | None = ...
The scan filters that were used.
class-attribute
instance-attribute
¶
start_time: datetime | None = ...
The time that the resource scan was started.