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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the details of the filter specified by the filter name.

Synopsis

data GetFilter = GetFilter' {
- detectorId :: Text
- filterName :: Text
}
newGetFilter :: Text -> Text -> GetFilter
getFilter_detectorId :: Lens' GetFilter Text
getFilter_filterName :: Lens' GetFilter Text
data GetFilterResponse = GetFilterResponse' {
- description :: Maybe Text
- rank :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- name :: Text
- action :: FilterAction
- findingCriteria :: FindingCriteria
}
newGetFilterResponse :: Int -> Text -> FilterAction -> FindingCriteria -> GetFilterResponse
getFilterResponse_description :: Lens' GetFilterResponse (Maybe Text)
getFilterResponse_rank :: Lens' GetFilterResponse (Maybe Natural)
getFilterResponse_tags :: Lens' GetFilterResponse (Maybe (HashMap Text Text))
getFilterResponse_httpStatus :: Lens' GetFilterResponse Int
getFilterResponse_name :: Lens' GetFilterResponse Text
getFilterResponse_action :: Lens' GetFilterResponse FilterAction
getFilterResponse_findingCriteria :: Lens' GetFilterResponse FindingCriteria

Creating a Request

data GetFilter Source #

See: newGetFilter smart constructor.

Constructors

GetFilter'
Fields detectorId :: Text The unique ID of the detector that the filter is associated with. filterName :: Text The name of the filter you want to get.

Instances

Instances details

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

newGetFilter Source #

Arguments

:: Text	`GetFilter`
-> Text	`$sel:filterName:GetFilter'`
-> GetFilter

Create a value of GetFilter 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:

GetFilter, getFilter_detectorId - The unique ID of the detector that the filter is associated with.

$sel:filterName:GetFilter', getFilter_filterName - The name of the filter you want to get.

Request Lenses

getFilter_detectorId :: Lens' GetFilter Text Source #

The unique ID of the detector that the filter is associated with.

getFilter_filterName :: Lens' GetFilter Text Source #

The name of the filter you want to get.

Destructuring the Response

data GetFilterResponse Source #

See: newGetFilterResponse smart constructor.

Constructors

GetFilterResponse'

Fields

description :: Maybe Text
The description of the filter.
rank :: Maybe Natural
Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
tags :: Maybe (HashMap Text Text)
The tags of the filter resource.
httpStatus :: Int
The response's http status code.
name :: Text
The name of the filter.
action :: FilterAction
Specifies the action that is to be applied to the findings that match the filter.
findingCriteria :: FindingCriteria
Represents the criteria to be used in the filter for querying findings.

Instances

Instances details

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

newGetFilterResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetFilterResponse'`
-> Text	`GetFilterResponse`
-> FilterAction	`GetFilterResponse`
-> FindingCriteria	`$sel:findingCriteria:GetFilterResponse'`
-> GetFilterResponse

Create a value of GetFilterResponse 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:

GetFilterResponse, getFilterResponse_description - The description of the filter.

$sel:rank:GetFilterResponse', getFilterResponse_rank - Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

GetFilterResponse, getFilterResponse_tags - The tags of the filter resource.

$sel:httpStatus:GetFilterResponse', getFilterResponse_httpStatus - The response's http status code.

GetFilterResponse, getFilterResponse_name - The name of the filter.

GetFilterResponse, getFilterResponse_action - Specifies the action that is to be applied to the findings that match the filter.

$sel:findingCriteria:GetFilterResponse', getFilterResponse_findingCriteria - Represents the criteria to be used in the filter for querying findings.

Response Lenses

getFilterResponse_description :: Lens' GetFilterResponse (Maybe Text) Source #

The description of the filter.

getFilterResponse_rank :: Lens' GetFilterResponse (Maybe Natural) Source #

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

getFilterResponse_tags :: Lens' GetFilterResponse (Maybe (HashMap Text Text)) Source #

The tags of the filter resource.

getFilterResponse_httpStatus :: Lens' GetFilterResponse Int Source #

The response's http status code.

getFilterResponse_name :: Lens' GetFilterResponse Text Source #

The name of the filter.

getFilterResponse_action :: Lens' GetFilterResponse FilterAction Source #

Specifies the action that is to be applied to the findings that match the filter.

getFilterResponse_findingCriteria :: Lens' GetFilterResponse FindingCriteria Source #

Represents the criteria to be used in the filter for querying findings.