get_threat_entity_set¶
Operation¶
get_threat_entity_set
¶
get_threat_entity_set(request: GetThreatEntitySetInput | GetThreatEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetThreatEntitySetInputDict]) -> GetThreatEntitySetOutput
Retrieves the threat entity set associated with the specified
threatEntitySetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetThreatEntitySetInput | GetThreatEntitySetInputDict | 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[GetThreatEntitySetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetThreatEntitySetOutput
|
An instance of |
get_threat_entity_set
async
¶
get_threat_entity_set(request: GetThreatEntitySetInput | GetThreatEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetThreatEntitySetInputDict]) -> GetThreatEntitySetOutput
Retrieves the threat entity set associated with the specified
threatEntitySetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetThreatEntitySetInput | GetThreatEntitySetInputDict | 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[GetThreatEntitySetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetThreatEntitySetOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetThreatEntitySetInputDict
¶
Bases: TypedDict
Dictionary form of GetThreatEntitySetInput.
Attributes¶
detector_id
instance-attribute
¶
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.
GetThreatEntitySetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetThreatEntitySetInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
Output¶
GetThreatEntitySetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetThreatEntitySetOutput structure.
Attributes¶
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The timestamp when the associated threat entity set was created.
error_details
class-attribute
instance-attribute
¶
error_details: str | None = ...
The error details when the status is shown as ERROR.
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.
format
class-attribute
instance-attribute
¶
format: str | None = ...
The format of the file that contains the threat entity set.
location
class-attribute
instance-attribute
¶
location: str | None = ...
The URI of the file that contains the threat entity set.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the threat entity set associated with the specified
threatEntitySetId.
response_metadata
class-attribute
instance-attribute
¶
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 the associated threat entity set.
tags
class-attribute
instance-attribute
¶
The tags associated with the threat entity set resource.