Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . guardduty ]

get-detector¶

Description¶

Retrieves a GuardDuty detector specified by the detectorId.

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

Synopsis¶

  get-detector
--detector-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--detector-id (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve details of a specific detector

The following get-detector example displays the configurations details of the specified detector.

aws guardduty get-detector \
    --detector-id 12abc34d567e8fa901bc2d34eexample

Output:

{
    "Status": "ENABLED",
    "ServiceRole": "arn:aws:iam::111122223333:role/aws-service-role/guardduty.amazonaws.com/AWSServiceRoleForAmazonGuardDuty",
    "Tags": {},
    "FindingPublishingFrequency": "SIX_HOURS",
    "UpdatedAt": "2018-11-07T03:24:22.938Z",
    "CreatedAt": "2017-12-22T22:51:31.940Z"
}

For more information, see Concepts and Terminology in the GuardDuty User Guide.

Output¶

CreatedAt -> (string)

The timestamp of when the detector was created.

FindingPublishingFrequency -> (string)

The publishing frequency of the finding.

ServiceRole -> (string)

The GuardDuty service role.

Status -> (string)

The detector status.

UpdatedAt -> (string)

The last-updated timestamp for the detector.

DataSources -> (structure)

Describes which data sources are enabled for the detector.

CloudTrail -> (structure)

An object that contains information on the status of CloudTrail as a data source.

Status -> (string)

Describes whether CloudTrail is enabled as a data source for the detector.

DNSLogs -> (structure)

An object that contains information on the status of DNS logs as a data source.

Status -> (string)

Denotes whether DNS logs is enabled as a data source.

FlowLogs -> (structure)

An object that contains information on the status of VPC flow logs as a data source.

Status -> (string)

Denotes whether VPC flow logs is enabled as a data source.

S3Logs -> (structure)

An object that contains information on the status of S3 Data event logs as a data source.

Status -> (string)

A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

Kubernetes -> (structure)

An object that contains information on the status of all Kubernetes data sources.

AuditLogs -> (structure)

Describes whether Kubernetes audit logs are enabled as a data source.

Status -> (string)

A value that describes whether Kubernetes audit logs are enabled as a data source.

MalwareProtection -> (structure)

Describes the configuration of Malware Protection data sources.

ScanEc2InstanceWithFindings -> (structure)

Describes the configuration of Malware Protection for EC2 instances with findings.

EbsVolumes -> (structure)

Describes the configuration of scanning EBS volumes as a data source.

Status -> (string)

Describes whether scanning EBS volumes is enabled as a data source.

Reason -> (string)

Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source.

ServiceRole -> (string)

The GuardDuty Malware Protection service role.

Tags -> (map)

The tags of the detector resource.

key -> (string)

value -> (string)

Features -> (list)

Describes the features that have been enabled for the detector.

(structure)

Contains information about a GuardDuty feature.

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING ) and Runtime Monitoring (RUNTIME_MONITORING ) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring .

Name -> (string)

Indicates the name of the feature that can be enabled for the detector.

Status -> (string)

Indicates the status of the feature that is enabled for the detector.

UpdatedAt -> (timestamp)

The timestamp at which the feature object was updated.

AdditionalConfiguration -> (list)

Additional configuration for a resource.

(structure)

Information about the additional configuration.

Name -> (string)

Name of the additional configuration.

Status -> (string)

Status of the additional configuration.

UpdatedAt -> (timestamp)

The timestamp at which the additional configuration was last updated. This is in UTC format.

Table Of Contents

Feedback

User Guide