Skip to content

create_threat_intel_set

Operation

create_threat_intel_set

create_threat_intel_set(request: CreateThreatIntelSetInput | CreateThreatIntelSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateThreatIntelSetInputDict]) -> CreateThreatIntelSetOutput

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.

Parameters:

Name Type Description Default
request CreateThreatIntelSetInput | CreateThreatIntelSetInputDict | 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[CreateThreatIntelSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateThreatIntelSetOutput

An instance of CreateThreatIntelSetOutput.

create_threat_intel_set async

create_threat_intel_set(request: CreateThreatIntelSetInput | CreateThreatIntelSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateThreatIntelSetInputDict]) -> CreateThreatIntelSetOutput

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator account can use this operation.

Parameters:

Name Type Description Default
request CreateThreatIntelSetInput | CreateThreatIntelSetInputDict | 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[CreateThreatIntelSetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateThreatIntelSetOutput

An instance of CreateThreatIntelSetOutput.

Input

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

CreateThreatIntelSetInputDict

Bases: TypedDict

Dictionary form of CreateThreatIntelSetInput.

Attributes

activate instance-attribute
activate: Required[bool]

A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

client_token instance-attribute
client_token: str | None

The idempotency token for the create request.

This field is autopopulated if not provided.

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.

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.

format instance-attribute
format: Required[str]

The format of the file that contains the ThreatIntelSet.

location instance-attribute
location: Required[str]

The URI of the file that contains the ThreatIntelSet.

name instance-attribute
name: Required[str]

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

tags instance-attribute
tags: Mapping[str, str] | None

The tags to be added to a new threat list resource.

CreateThreatIntelSetInput dataclass

Bases: _SerdeShape

Dataclass for CreateThreatIntelSetInput structure.

Attributes

activate class-attribute instance-attribute
activate: bool | None = ...

A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

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

The idempotency token for the create request.

This field is autopopulated if not provided.

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

The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.

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.

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

The format of the file that contains 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.

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

The tags to be added to a new threat list resource.

Output

CreateThreatIntelSetOutput dataclass

Bases: _SerdeShape

Dataclass for CreateThreatIntelSetOutput structure.

Attributes

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.

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

The ID of the ThreatIntelSet resource.