Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . guardduty ]

create-detector

Description

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-detector
--enable | --no-enable
[--client-token <value>]
[--finding-publishing-frequency <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--enable | --no-enable (boolean)

A boolean value that specifies whether the detector is to be enabled.

--client-token (string)

The idempotency token for the create request.

--finding-publishing-frequency (string)

A enum value that specifies how frequently customer got Finding updates published.

Possible values:

  • FIFTEEN_MINUTES
  • ONE_HOUR
  • SIX_HOURS

--tags (map)

The tags to be added to a new detector resource.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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.

See 'aws help' for descriptions of global parameters.

Output

DetectorId -> (string)

The unique ID of the created detector.