Skip to content

CloudFormation  >  Operations  >  start_resource_scan

start_resource_scan

Operation

start_resource_scan async 

start_resource_scan(input: StartResourceScanInput, plugins: list[Plugin] | None = None) -> StartResourceScanOutput

Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.

Parameters:

Name Type Description Default
input StartResourceScanInput

An instance of StartResourceScanInput.

 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
StartResourceScanOutput

An instance of StartResourceScanOutput.

Input

StartResourceScanInput dataclass

Bases: _SerdeShape

Dataclass for StartResourceScanInput structure.

Attributes

client_request_token class-attribute instance-attribute 
client_request_token: str | None = ...

A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.

scan_filters class-attribute instance-attribute 
scan_filters: list[ScanFilter] | None = ...

The scan filters to use.

Output

StartResourceScanOutput dataclass

Bases: _SerdeShape

Dataclass for StartResourceScanOutput structure.

Attributes

resource_scan_id 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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.