start_resource_scan¶
Operation¶
start_resource_scan
¶
start_resource_scan(request: StartResourceScanInput | StartResourceScanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartResourceScanInputDict]) -> 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 |
|---|---|---|---|
request
|
StartResourceScanInput | StartResourceScanInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartResourceScanInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartResourceScanOutput
|
An instance of |
start_resource_scan
async
¶
start_resource_scan(request: StartResourceScanInput | StartResourceScanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartResourceScanInputDict]) -> 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 |
|---|---|---|---|
request
|
StartResourceScanInput | StartResourceScanInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartResourceScanInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartResourceScanOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StartResourceScanInputDict
¶
Bases: TypedDict
Dictionary form of StartResourceScanInput.
Attributes¶
client_request_token
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
instance-attribute
¶
scan_filters: Sequence[ScanFilter | ScanFilterDict] | None
The scan filters to use.
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
¶
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.