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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a paginated list of the current filters.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFilters Source #

See: newListFilters smart constructor.

Constructors

ListFilters'

Fields

maxResults :: Maybe Natural
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
nextToken :: Maybe Text
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
detectorId :: Text
The unique ID of the detector that the filter is associated with.

Instances

Instances details

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

newListFilters Source #

Arguments

:: Text	`ListFilters`
-> ListFilters

Create a value of ListFilters 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:maxResults:ListFilters', listFilters_maxResults - You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

ListFilters, listFilters_nextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

ListFilters, listFilters_detectorId - The unique ID of the detector that the filter is associated with.

Request Lenses

listFilters_maxResults :: Lens' ListFilters (Maybe Natural) Source #

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

listFilters_nextToken :: Lens' ListFilters (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listFilters_detectorId :: Lens' ListFilters Text Source #

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

Destructuring the Response

data ListFiltersResponse Source #

See: newListFiltersResponse smart constructor.

Constructors

ListFiltersResponse'
Fields nextToken :: Maybe Text The pagination parameter to be used on the next list operation to retrieve more items. httpStatus :: Int The response's http status code. filterNames :: [Text] A list of filter names.

Instances

Instances details

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

newListFiltersResponse Source #

Arguments

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

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

ListFilters, listFiltersResponse_nextToken - The pagination parameter to be used on the next list operation to retrieve more items.

$sel:httpStatus:ListFiltersResponse', listFiltersResponse_httpStatus - The response's http status code.

$sel:filterNames:ListFiltersResponse', listFiltersResponse_filterNames - A list of filter names.

Response Lenses

listFiltersResponse_nextToken :: Lens' ListFiltersResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.

listFiltersResponse_httpStatus :: Lens' ListFiltersResponse Int Source #

The response's http status code.

listFiltersResponse_filterNames :: Lens' ListFiltersResponse [Text] Source #

A list of filter names.