GuardDuty / Client / get_threat_entity_set

get_threat_entity_set

GuardDuty.Client.get_threat_entity_set(**kwargs)

Retrieves the threat entity set associated with the specified threatEntitySetId.

See also: AWS API Documentation

Request Syntax

response = client.get_threat_entity_set(
    DetectorId='string',
    ThreatEntitySetId='string'
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The unique ID of the detector associated with the threat entity set resource.

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

  • ThreatEntitySetId (string) –

    [REQUIRED]

    The unique ID that helps GuardDuty identify the threat entity set.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    'Location': 'string',
    'ExpectedBucketOwner': 'string',
    'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'ErrorDetails': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the threat entity set associated with the specified threatEntitySetId.

    • Format (string) –

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

    • Location (string) –

      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.

    • Status (string) –

      The status of the associated threat entity set.

    • Tags (dict) –

      The tags associated with the threat entity set resource.

      • (string) –

        • (string) –

    • CreatedAt (datetime) –

      The timestamp when the associated threat entity set was created.

    • UpdatedAt (datetime) –

      The timestamp when the associated threat entity set was updated.

    • ErrorDetails (string) –

      The error details when the status is shown as ERROR.

Exceptions