Skip to content

get_threat_intel_set

Operation

get_threat_intel_set

get_threat_intel_set(request: GetThreatIntelSetInput | GetThreatIntelSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetThreatIntelSetInputDict]) -> GetThreatIntelSetOutput

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

Parameters:

Name Type Description Default
request GetThreatIntelSetInput | GetThreatIntelSetInputDict | 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[GetThreatIntelSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetThreatIntelSetOutput

An instance of GetThreatIntelSetOutput.

get_threat_intel_set async

get_threat_intel_set(request: GetThreatIntelSetInput | GetThreatIntelSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetThreatIntelSetInputDict]) -> GetThreatIntelSetOutput

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

Parameters:

Name Type Description Default
request GetThreatIntelSetInput | GetThreatIntelSetInputDict | 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[GetThreatIntelSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetThreatIntelSetOutput

An instance of GetThreatIntelSetOutput.

Input

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

GetThreatIntelSetInputDict

Bases: TypedDict

Dictionary form of GetThreatIntelSetInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector that is associated with the threatIntelSet.

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

threat_intel_set_id instance-attribute
threat_intel_set_id: Required[str]

The unique ID of the threatIntelSet that you want to get.

GetThreatIntelSetInput dataclass

Bases: _SerdeShape

Dataclass for GetThreatIntelSetInput structure.

Attributes

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

The unique ID of the detector that is associated with the threatIntelSet.

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

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

The unique ID of the threatIntelSet that you want to get.

Output

GetThreatIntelSetOutput dataclass

Bases: _SerdeShape

Dataclass for GetThreatIntelSetOutput structure.

Attributes

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

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during ThreatIntelSet creation or update.

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

The format of the threatIntelSet.

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

The URI of the file that contains the ThreatIntelSet.

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

A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

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 status of threatIntelSet file uploaded.

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

The tags of the threat list resource.