Skip to content

list_investigation_records

Operation

list_investigation_records

list_investigation_records(request: ListInvestigationRecordsInput | ListInvestigationRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvestigationRecordsInputDict]) -> ListInvestigationRecordsOutput

This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).

Returns the records for a specific GuardDuty investigation. Each record is one step in the reasoning that GuardDuty followed to reach the results of the investigation.

An administrator account can list the records of any investigation within the organization. Member accounts can only list the records of investigations that belong to them.

Parameters:

Name Type Description Default
request ListInvestigationRecordsInput | ListInvestigationRecordsInputDict | 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[ListInvestigationRecordsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListInvestigationRecordsOutput

An instance of ListInvestigationRecordsOutput.

list_investigation_records async

list_investigation_records(request: ListInvestigationRecordsInput | ListInvestigationRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListInvestigationRecordsInputDict]) -> ListInvestigationRecordsOutput

This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).

Returns the records for a specific GuardDuty investigation. Each record is one step in the reasoning that GuardDuty followed to reach the results of the investigation.

An administrator account can list the records of any investigation within the organization. Member accounts can only list the records of investigations that belong to them.

Parameters:

Name Type Description Default
request ListInvestigationRecordsInput | ListInvestigationRecordsInputDict | 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[ListInvestigationRecordsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListInvestigationRecordsOutput

An instance of ListInvestigationRecordsOutput.

Input

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

ListInvestigationRecordsInputDict

Bases: TypedDict

Dictionary form of ListInvestigationRecordsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the GuardDuty detector associated with the investigation.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

investigation_id instance-attribute
investigation_id: Required[str]

The unique identifier of the investigation whose records you want to list.

max_results instance-attribute
max_results: int | None

The maximum number of records to return in a single response. Valid values are 1 to 50. The default value is 20. A response can contain fewer records than this value, or no records, and still include a NextToken.

next_token instance-attribute
next_token: str | None

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. Use the same InvestigationId and RecordTypes values that you used in the previous request.

If you specify this parameter for an investigation whose status isn't COMPLETED, the operation returns a BadRequestException. A NextToken expires 24 hours after it's returned.

record_types instance-attribute
record_types: Sequence[str] | None

The types of records to return. Possible values are UPDATE, FETCH, OBSERVATION, ANALYSIS, and METADATA. If you don't specify this parameter, GuardDuty returns records of all types.

ListInvestigationRecordsInput dataclass

Bases: _SerdeShape

Dataclass for ListInvestigationRecordsInput structure.

Attributes

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

The unique ID of the GuardDuty detector associated with the investigation.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

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

The unique identifier of the investigation whose records you want to list.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of records to return in a single response. Valid values are 1 to 50. The default value is 20. A response can contain fewer records than this value, or no records, and still include a NextToken.

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

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data. Use the same InvestigationId and RecordTypes values that you used in the previous request.

If you specify this parameter for an investigation whose status isn't COMPLETED, the operation returns a BadRequestException. A NextToken expires 24 hours after it's returned.

record_types class-attribute instance-attribute
record_types: list[str] | None = ...

The types of records to return. Possible values are UPDATE, FETCH, OBSERVATION, ANALYSIS, and METADATA. If you don't specify this parameter, GuardDuty returns records of all types.

Output

ListInvestigationRecordsOutput dataclass

Bases: _SerdeShape

Dataclass for ListInvestigationRecordsOutput structure.

Attributes

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

The unique identifier of the investigation.

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

The pagination parameter to be used on the next list operation to retrieve more items. If this value is absent, there are no more records to retrieve.

records class-attribute instance-attribute
records: list[InvestigationRecord] | None = ...

The records for the investigation, in the order that GuardDuty created them, oldest first. This list can contain fewer records than MaxResults, or no records, even when more records are available. To check for more records, use NextToken.

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.

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

The current status of the investigation. Possible values are RUNNING, COMPLETED, and FAILED. Records are returned only when the status is COMPLETED. If the status is RUNNING or FAILED, the response contains an empty list of records and no NextToken.