update_threat_entity_set¶
Operation¶
update_threat_entity_set
¶
update_threat_entity_set(request: UpdateThreatEntitySetInput | UpdateThreatEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateThreatEntitySetInputDict]) -> UpdateThreatEntitySetOutput
Updates the threat entity set associated with the specified
threatEntitySetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateThreatEntitySetInput | UpdateThreatEntitySetInputDict | 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[UpdateThreatEntitySetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateThreatEntitySetOutput
|
An instance of |
update_threat_entity_set
async
¶
update_threat_entity_set(request: UpdateThreatEntitySetInput | UpdateThreatEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateThreatEntitySetInputDict]) -> UpdateThreatEntitySetOutput
Updates the threat entity set associated with the specified
threatEntitySetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateThreatEntitySetInput | UpdateThreatEntitySetInputDict | 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[UpdateThreatEntitySetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateThreatEntitySetOutput
|
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.
UpdateThreatEntitySetInputDict
¶
Bases: TypedDict
Dictionary form of UpdateThreatEntitySetInput.
Attributes¶
activate
instance-attribute
¶
activate: bool | None
A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.
detector_id
instance-attribute
¶
The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
expected_bucket_owner
instance-attribute
¶
expected_bucket_owner: str | None
The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.
location
instance-attribute
¶
location: str | None
The URI of the file that contains the trusted entity set.
UpdateThreatEntitySetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateThreatEntitySetInput structure.
Attributes¶
activate
class-attribute
instance-attribute
¶
activate: bool | None = ...
A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = ...
The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
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.
location
class-attribute
instance-attribute
¶
location: str | None = ...
The URI of the file that contains the trusted entity set.
Output¶
UpdateThreatEntitySetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateThreatEntitySetOutput structure.