Skip to content

Guardduty  >  Operations  >  get_threat_entity_set

get_threat_entity_set

Operation

get_threat_entity_set async

get_threat_entity_set(input: GetThreatEntitySetInput, plugins: list[Plugin] | None = None) -> GetThreatEntitySetOutput

Retrieves the threat entity set associated with the specified threatEntitySetId.

Parameters:

Name Type Description Default
input GetThreatEntitySetInput

An instance of GetThreatEntitySetInput.

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
GetThreatEntitySetOutput

An instance of GetThreatEntitySetOutput.

Input

GetThreatEntitySetInput dataclass

Dataclass for GetThreatEntitySetInput structure.

Attributes

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

The unique ID of the detector associated with the threat entity set resource.

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

threat_entity_set_id class-attribute instance-attribute
threat_entity_set_id: str | None = None

The unique ID that helps GuardDuty identify the threat entity set.

Output

GetThreatEntitySetOutput dataclass

Dataclass for GetThreatEntitySetOutput structure.

Attributes

created_at class-attribute instance-attribute
created_at: datetime | None = None

The timestamp when the associated threat entity set was created.

error_details class-attribute instance-attribute
error_details: str | None = None

The error details when the status is shown as ERROR.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = None

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

format class-attribute instance-attribute
format: ThreatEntitySetFormat | None = None

The format of the file that contains the threat entity set.

location class-attribute instance-attribute
location: str | None = None

The URI of the file that contains the threat entity set.

name class-attribute instance-attribute
name: str | None = None

The name of the threat entity set associated with the specified threatEntitySetId.

status class-attribute instance-attribute
status: ThreatEntitySetStatus | None = None

The status of the associated threat entity set.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

The tags associated with the threat entity set resource.

updated_at class-attribute instance-attribute
updated_at: datetime | None = None

The timestamp when the associated threat entity set was updated.