Skip to content

DescribeResourceScanOutput

Source code in docs_src/capo_cloudformation/types/describe_resource_scan_output.py
class DescribeResourceScanOutput(TypedDict, closed=True):
    resource_scan_id: NotRequired[
        "capo_cloudformation.types.resource_scan_id.ResourceScanId"
    ]
    """<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: NotRequired[
        "capo_cloudformation.types.resource_scan_status.ResourceScanStatus"
    ]
    """<p>Status of the resource scan.</p> <dl> <dt> IN_PROGRESS </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: NotRequired[
        "capo_cloudformation.types.resource_scan_status_reason.ResourceScanStatusReason"
    ]
    """<p>The reason for the resource scan status, providing more information if a failure happened.</p>"""
    start_time: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The time that the resource scan was started.</p>"""
    end_time: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>The time that the resource scan was finished.</p>"""
    percentage_completed: NotRequired[
        "capo_cloudformation.types.percentage_completed.PercentageCompleted"
    ]
    """<p>The percentage of the resource scan that has been completed.</p>"""
    resource_types: NotRequired[
        "capo_cloudformation.types.resource_types.ResourceTypes"
    ]
    """<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: NotRequired[
        "capo_cloudformation.types.resources_scanned.ResourcesScanned"
    ]
    """<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: NotRequired[
        "capo_cloudformation.types.resources_read.ResourcesRead"
    ]
    """<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>"""
    scan_filters: NotRequired["capo_cloudformation.types.scan_filters.ScanFilters"]
    """<p>The scan filters that were used.</p>"""

end_time instance-attribute

end_time: NotRequired[Timestamp]

The time that the resource scan was finished.

percentage_completed instance-attribute

percentage_completed: NotRequired[PercentageCompleted]

The percentage of the resource scan that has been completed.

resource_scan_id instance-attribute

resource_scan_id: NotRequired[ResourceScanId]

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 .

resource_types instance-attribute

resource_types: NotRequired[ResourceTypes]

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

resources_read instance-attribute

resources_read: NotRequired[ResourcesRead]

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

resources_scanned instance-attribute

resources_scanned: NotRequired[ResourcesScanned]

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

scan_filters instance-attribute

scan_filters: NotRequired[ScanFilters]

The scan filters that were used.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The time that the resource scan was started.

status instance-attribute

status: NotRequired[ResourceScanStatus]

Status of the resource scan.

IN_PROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

status_reason instance-attribute

status_reason: NotRequired[ResourceScanStatusReason]

The reason for the resource scan status, providing more information if a failure happened.