create_trusted_entity_set¶
Operation¶
async
¶
create_trusted_entity_set(input: CreateTrustedEntitySetInput, plugins: list[Plugin] | None = None) -> CreateTrustedEntitySetOutput
Creates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty will not generate findings for the entries that are specified in a trusted entity set. At any given time, you can have only one trusted entity set.
Only users of the administrator account can manage the entity sets, which automatically apply to member accounts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTrustedEntitySetInput
|
An instance of |
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 |
|---|---|
CreateTrustedEntitySetOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateTrustedEntitySetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
activate: bool | None = None
A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.
class-attribute
instance-attribute
¶
client_token: str | None = None
The idempotency token for the create request.
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector of the GuardDuty account for which you want to create a trusted entity set.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
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.
class-attribute
instance-attribute
¶
format: TrustedEntitySetFormat | None = None
The format of the file that contains the trusted entity set.
class-attribute
instance-attribute
¶
location: str | None = None
The URI of the file that contains the threat entity set. The format of
the Location URL must be a valid Amazon S3 URL format. Invalid URL
formats will result in an error, regardless of whether you activate the
entity set or not. For more information about format of the location
URLs, see Format of location URL under Step 2: Adding trusted or threat
intelligence
data
in the Amazon GuardDuty User Guide.
class-attribute
instance-attribute
¶
name: str | None = None
A user-friendly name to identify the trusted entity set.
The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The tags to be added to a new trusted entity set resource.