GetThreatEntitySet - Amazon GuardDuty
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetThreatEntitySet

Retrieves the threat entity set associated with the specified threatEntitySetId.

Request Syntax

GET /detector/detectorId/threatentityset/threatEntitySetId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

detectorId

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.

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

threatEntitySetId

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "errorDetails": "string",
   "expectedBucketOwner": "string",
   "format": "string",
   "location": "string",
   "name": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp when the associated threat entity set was created.

Type: Timestamp

errorDetails

The error details when the status is shown as ERROR.

Type: String

expectedBucketOwner

The Amazon account ID that owns the Amazon S3 bucket specified in the location parameter.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]+$

format

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Valid Values: TXT | STIX | OTX_CSV | ALIEN_VAULT | PROOF_POINT | FIRE_EYE

location

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

status

The status of the associated threat entity set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Valid Values: INACTIVE | ACTIVATING | ACTIVE | DEACTIVATING | ERROR | DELETE_PENDING | DELETED

tags

The tags associated with the threat entity set resource.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

updatedAt

The timestamp when the associated threat entity set was updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: