GetDetector - Amazon GuardDuty
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetDetector

Retrieves a GuardDuty detector specified by the detectorId.

There might be regional differences because some data sources might not be available in all the AWS Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Request Syntax

GET /detector/detectorId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

detectorId

The unique ID of the detector that you want to get.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "dataSources": { 
      "cloudTrail": { 
         "status": "string"
      },
      "dnsLogs": { 
         "status": "string"
      },
      "flowLogs": { 
         "status": "string"
      },
      "kubernetes": { 
         "auditLogs": { 
            "status": "string"
         }
      },
      "malwareProtection": { 
         "scanEc2InstanceWithFindings": { 
            "ebsVolumes": { 
               "reason": "string",
               "status": "string"
            }
         },
         "serviceRole": "string"
      },
      "s3Logs": { 
         "status": "string"
      }
   },
   "features": [ 
      { 
         "additionalConfiguration": [ 
            { 
               "name": "string",
               "status": "string",
               "updatedAt": number
            }
         ],
         "name": "string",
         "status": "string",
         "updatedAt": number
      }
   ],
   "findingPublishingFrequency": "string",
   "serviceRole": "string",
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "updatedAt": "string"
}

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 of when the detector was created.

Type: String

dataSources

This parameter has been deprecated.

Describes which data sources are enabled for the detector.

Type: DataSourceConfigurationsResult object

features

Describes the features that have been enabled for the detector.

Type: Array of DetectorFeatureConfigurationResult objects

findingPublishingFrequency

The publishing frequency of the finding.

Type: String

Valid Values: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS

serviceRole

The GuardDuty service role.

Type: String

status

The detector status.

Type: String

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

Valid Values: ENABLED | DISABLED

tags

The tags of the detector 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 last-updated timestamp for the detector.

Type: String

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 AWS SDKs, see the following: