GuardDuty / Client / create_threat_entity_set

create_threat_entity_set

GuardDuty.Client.create_threat_entity_set(**kwargs)

Creates a new threat entity set. In a threat entity set, you can provide known malicious IP addresses and domains for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts.

See also: AWS API Documentation

Request Syntax

response = client.create_threat_entity_set(
    DetectorId='string',
    Name='string',
    Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    Location='string',
    ExpectedBucketOwner='string',
    Activate=True|False,
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

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

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

  • Name (string) –

    [REQUIRED]

    A user-friendly name to identify the threat entity set.

    The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

  • Format (string) –

    [REQUIRED]

    The format of the file that contains the threat entity set.

  • Location (string) –

    [REQUIRED]

    The URI of the file that contains the threat entity set.

  • ExpectedBucketOwner (string) – The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

  • Activate (boolean) –

    [REQUIRED]

    A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to generate findings.

  • ClientToken (string) –

    The idempotency token for the create request.

    This field is autopopulated if not provided.

  • Tags (dict) –

    The tags to be added to a new threat entity set resource.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ThreatEntitySetId': 'string'
}

Response Structure

  • (dict) –

    • ThreatEntitySetId (string) –

      The ID returned by GuardDuty after creation of the threat entity set resource.

Exceptions