Skip to content

create_sample_findings

Operation

create_sample_findings

create_sample_findings(request: CreateSampleFindingsInput | CreateSampleFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSampleFindingsInputDict]) -> 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
request CreateSampleFindingsInput | CreateSampleFindingsInputDict | 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[CreateSampleFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSampleFindingsOutput

An instance of CreateSampleFindingsOutput.

create_sample_findings async

create_sample_findings(request: CreateSampleFindingsInput | CreateSampleFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSampleFindingsInputDict]) -> 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
request CreateSampleFindingsInput | CreateSampleFindingsInputDict | 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[CreateSampleFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSampleFindingsOutput

An instance of CreateSampleFindingsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateSampleFindingsInputDict

Bases: TypedDict

Dictionary form of CreateSampleFindingsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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 instance-attribute
finding_types: Sequence[str] | None

The types of sample findings to generate.

CreateSampleFindingsInput dataclass

Bases: _SerdeShape

Dataclass for CreateSampleFindingsInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | 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 = ...

The types of sample findings to generate.

Output

CreateSampleFindingsOutput dataclass

Bases: _SerdeShape

Dataclass for CreateSampleFindingsOutput structure.

Attributes

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.