Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GuardDuty.CreateDetector

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.

Synopsis

data CreateDetector = CreateDetector' {
- clientToken :: Maybe Text
- dataSources :: Maybe DataSourceConfigurations
- findingPublishingFrequency :: Maybe FindingPublishingFrequency
- tags :: Maybe (HashMap Text Text)
- enable :: Bool
}
newCreateDetector :: Bool -> CreateDetector
createDetector_clientToken :: Lens' CreateDetector (Maybe Text)
createDetector_dataSources :: Lens' CreateDetector (Maybe DataSourceConfigurations)
createDetector_findingPublishingFrequency :: Lens' CreateDetector (Maybe FindingPublishingFrequency)
createDetector_tags :: Lens' CreateDetector (Maybe (HashMap Text Text))
createDetector_enable :: Lens' CreateDetector Bool
data CreateDetectorResponse = CreateDetectorResponse' {
- detectorId :: Maybe Text
- unprocessedDataSources :: Maybe UnprocessedDataSourcesResult
- httpStatus :: Int
}
newCreateDetectorResponse :: Int -> CreateDetectorResponse
createDetectorResponse_detectorId :: Lens' CreateDetectorResponse (Maybe Text)
createDetectorResponse_unprocessedDataSources :: Lens' CreateDetectorResponse (Maybe UnprocessedDataSourcesResult)
createDetectorResponse_httpStatus :: Lens' CreateDetectorResponse Int

Creating a Request

data CreateDetector Source #

See: newCreateDetector smart constructor.

Constructors

CreateDetector'

Fields

clientToken :: Maybe Text
The idempotency token for the create request.
dataSources :: Maybe DataSourceConfigurations
Describes which data sources will be enabled for the detector.
findingPublishingFrequency :: Maybe FindingPublishingFrequency
A value that specifies how frequently updated findings are exported.
tags :: Maybe (HashMap Text Text)
The tags to be added to a new detector resource.
enable :: Bool
A Boolean value that specifies whether the detector is to be enabled.

Instances

Instances details

ToJSON CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods toJSON :: CreateDetector -> Value # toEncoding :: CreateDetector -> Encoding # toJSONList :: [CreateDetector] -> Value # toEncodingList :: [CreateDetector] -> Encoding #
ToHeaders CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods toHeaders :: CreateDetector -> [Header] #
ToPath CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods toPath :: CreateDetector -> ByteString #
ToQuery CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods toQuery :: CreateDetector -> QueryString #
AWSRequest CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Associated Types type AWSResponse CreateDetector # Methods request :: (Service -> Service) -> CreateDetector -> Request CreateDetector # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDetector -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDetector))) #
Generic CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Associated Types type Rep CreateDetector :: Type -> Type # Methods from :: CreateDetector -> Rep CreateDetector x # to :: Rep CreateDetector x -> CreateDetector #
Read CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods readsPrec :: Int -> ReadS CreateDetector # readList :: ReadS [CreateDetector] # readPrec :: ReadPrec CreateDetector # readListPrec :: ReadPrec [CreateDetector] #
Show CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods showsPrec :: Int -> CreateDetector -> ShowS # show :: CreateDetector -> String # showList :: [CreateDetector] -> ShowS #
NFData CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods rnf :: CreateDetector -> () #
Eq CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods (==) :: CreateDetector -> CreateDetector -> Bool # (/=) :: CreateDetector -> CreateDetector -> Bool #
Hashable CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods hashWithSalt :: Int -> CreateDetector -> Int # hash :: CreateDetector -> Int #
type AWSResponse CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector type AWSResponse CreateDetector = CreateDetectorResponse
type Rep CreateDetector Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector type Rep CreateDetector = D1 ('MetaData "CreateDetector" "Amazonka.GuardDuty.CreateDetector" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "CreateDetector'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceConfigurations))) :: (S1 ('MetaSel ('Just "findingPublishingFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingPublishingFrequency)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newCreateDetector Source #

Arguments

:: Bool	`CreateDetector`
-> CreateDetector

Create a value of CreateDetector with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateDetector', createDetector_clientToken - The idempotency token for the create request.

CreateDetector, createDetector_dataSources - Describes which data sources will be enabled for the detector.

$sel:findingPublishingFrequency:CreateDetector', createDetector_findingPublishingFrequency - A value that specifies how frequently updated findings are exported.

CreateDetector, createDetector_tags - The tags to be added to a new detector resource.

CreateDetector, createDetector_enable - A Boolean value that specifies whether the detector is to be enabled.

Request Lenses

createDetector_clientToken :: Lens' CreateDetector (Maybe Text) Source #

The idempotency token for the create request.

createDetector_dataSources :: Lens' CreateDetector (Maybe DataSourceConfigurations) Source #

Describes which data sources will be enabled for the detector.

createDetector_findingPublishingFrequency :: Lens' CreateDetector (Maybe FindingPublishingFrequency) Source #

A value that specifies how frequently updated findings are exported.

createDetector_tags :: Lens' CreateDetector (Maybe (HashMap Text Text)) Source #

The tags to be added to a new detector resource.

createDetector_enable :: Lens' CreateDetector Bool Source #

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

Destructuring the Response

data CreateDetectorResponse Source #

See: newCreateDetectorResponse smart constructor.

Constructors

CreateDetectorResponse'
Fields detectorId :: Maybe Text The unique ID of the created detector. unprocessedDataSources :: Maybe UnprocessedDataSourcesResult Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Associated Types type Rep CreateDetectorResponse :: Type -> Type # Methods from :: CreateDetectorResponse -> Rep CreateDetectorResponse x # to :: Rep CreateDetectorResponse x -> CreateDetectorResponse #
Read CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods readsPrec :: Int -> ReadS CreateDetectorResponse # readList :: ReadS [CreateDetectorResponse] # readPrec :: ReadPrec CreateDetectorResponse # readListPrec :: ReadPrec [CreateDetectorResponse] #
Show CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods showsPrec :: Int -> CreateDetectorResponse -> ShowS # show :: CreateDetectorResponse -> String # showList :: [CreateDetectorResponse] -> ShowS #
NFData CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods rnf :: CreateDetectorResponse -> () #
Eq CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector Methods (==) :: CreateDetectorResponse -> CreateDetectorResponse -> Bool # (/=) :: CreateDetectorResponse -> CreateDetectorResponse -> Bool #
type Rep CreateDetectorResponse Source #
Instance details Defined in Amazonka.GuardDuty.CreateDetector type Rep CreateDetectorResponse = D1 ('MetaData "CreateDetectorResponse" "Amazonka.GuardDuty.CreateDetector" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "CreateDetectorResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "unprocessedDataSources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UnprocessedDataSourcesResult)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDetectorResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDetectorResponse'`
-> CreateDetectorResponse

Create a value of CreateDetectorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDetectorResponse, createDetectorResponse_detectorId - The unique ID of the created detector.

$sel:unprocessedDataSources:CreateDetectorResponse', createDetectorResponse_unprocessedDataSources - Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.

$sel:httpStatus:CreateDetectorResponse', createDetectorResponse_httpStatus - The response's http status code.

Response Lenses

createDetectorResponse_detectorId :: Lens' CreateDetectorResponse (Maybe Text) Source #

The unique ID of the created detector.

createDetectorResponse_unprocessedDataSources :: Lens' CreateDetectorResponse (Maybe UnprocessedDataSourcesResult) Source #

Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.

createDetectorResponse_httpStatus :: Lens' CreateDetectorResponse Int Source #

The response's http status code.