GuardDuty / Client / create_trusted_entity_set

create_trusted_entity_set

GuardDuty.Client.create_trusted_entity_set(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_trusted_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 trusted 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 trusted 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 trusted entity set.

  • Location (string) –

    [REQUIRED]

    The URI of the file that contains the trusted 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 is to start using the uploaded trusted entity set.

  • 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 trusted entity set resource.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'TrustedEntitySetId': 'string'
}

Response Structure

  • (dict) –

    • TrustedEntitySetId (string) –

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

Exceptions