create_sample_findings¶
Operation¶
create_sample_findings
async
¶
create_sample_findings(input: CreateSampleFindingsInput, plugins: list[Plugin] | None = None) -> CreateSampleFindingsOutput
Generates sample findings of types specified by the list of finding
types. If 'NULL' is specified for findingTypes, the API generates
sample findings of all supported finding types.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateSampleFindingsInput
|
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 |
|---|---|
CreateSampleFindingsOutput
|
An instance of |
Input¶
CreateSampleFindingsInput
dataclass
¶
Dataclass for CreateSampleFindingsInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = None
The ID of the detector for which you need to create sample findings.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
finding_types
class-attribute
instance-attribute
¶
finding_types: list[str] | None = None
The types of sample findings to generate.
Output¶
CreateSampleFindingsOutput
dataclass
¶
Dataclass for CreateSampleFindingsOutput structure.