GuardDuty / Client / create_ip_set

create_ip_set#

GuardDuty.Client.create_ip_set(**kwargs)#

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services infrastructure and applications. GuardDuty doesn’t generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

See also: AWS API Documentation

Request Syntax

response = client.create_ip_set(
    DetectorId='string',
    Name='string',
    Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    Location='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 an IPSet.

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

  • Name (string) –

    [REQUIRED]

    The user-friendly name to identify the IPSet.

    Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

  • Format (string) –

    [REQUIRED]

    The format of the file that contains the IPSet.

  • Location (string) –

    [REQUIRED]

    The URI of the file that contains the IPSet.

  • Activate (boolean) –

    [REQUIRED]

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

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IpSetId': 'string'
}

Response Structure

  • (dict) –

    • IpSetId (string) –

      The ID of the IPSet resource.

Exceptions