GuardDuty / Client / get_ip_set

get_ip_set#

GuardDuty.Client.get_ip_set(**kwargs)#

Retrieves the IPSet specified by the ipSetId.

See also: AWS API Documentation

Request Syntax

response = client.get_ip_set(
    DetectorId='string',
    IpSetId='string'
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The unique ID of the detector that is associated with the IPSet.

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

  • IpSetId (string) –

    [REQUIRED]

    The unique ID of the IPSet to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    'Location': 'string',
    'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • Name (string) –

      The user-friendly name for the IPSet.

    • Format (string) –

      The format of the file that contains the IPSet.

    • Location (string) –

      The URI of the file that contains the IPSet.

    • Status (string) –

      The status of IPSet file that was uploaded.

    • Tags (dict) –

      The tags of the IPSet resource.

      • (string) –

        • (string) –

Exceptions