Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WAF.ListRuleGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleGroup objects.

This operation returns paginated results.

Creating a Request

data ListRuleGroups Source #

See: newListRuleGroups smart constructor.

Constructors

ListRuleGroups'

Fields

nextMarker :: Maybe Text
If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.
limit :: Maybe Natural
Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

Instances

Instances details

Eq ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods (==) :: ListRuleGroups -> ListRuleGroups -> Bool # (/=) :: ListRuleGroups -> ListRuleGroups -> Bool #
Read ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods readsPrec :: Int -> ReadS ListRuleGroups # readList :: ReadS [ListRuleGroups] # readPrec :: ReadPrec ListRuleGroups # readListPrec :: ReadPrec [ListRuleGroups] #
Show ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods showsPrec :: Int -> ListRuleGroups -> ShowS # show :: ListRuleGroups -> String # showList :: [ListRuleGroups] -> ShowS #
Generic ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Associated Types type Rep ListRuleGroups :: Type -> Type # Methods from :: ListRuleGroups -> Rep ListRuleGroups x # to :: Rep ListRuleGroups x -> ListRuleGroups #
NFData ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods rnf :: ListRuleGroups -> () #
Hashable ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods hashWithSalt :: Int -> ListRuleGroups -> Int # hash :: ListRuleGroups -> Int #
ToJSON ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods toJSON :: ListRuleGroups -> Value # toEncoding :: ListRuleGroups -> Encoding # toJSONList :: [ListRuleGroups] -> Value # toEncodingList :: [ListRuleGroups] -> Encoding #
AWSPager ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods page :: ListRuleGroups -> AWSResponse ListRuleGroups -> Maybe ListRuleGroups #
AWSRequest ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Associated Types type AWSResponse ListRuleGroups # Methods request :: ListRuleGroups -> Request ListRuleGroups # response :: MonadResource m => Logger -> Service -> Proxy ListRuleGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRuleGroups))) #
ToHeaders ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods toHeaders :: ListRuleGroups -> [Header] #
ToPath ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods toPath :: ListRuleGroups -> ByteString #
ToQuery ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods toQuery :: ListRuleGroups -> QueryString #
type Rep ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups type Rep ListRuleGroups = D1 ('MetaData "ListRuleGroups" "Amazonka.WAF.ListRuleGroups" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "ListRuleGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListRuleGroups Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups type AWSResponse ListRuleGroups = ListRuleGroupsResponse

newListRuleGroups :: ListRuleGroups Source #

Create a value of ListRuleGroups 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:nextMarker:ListRuleGroups', listRuleGroups_nextMarker - If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

$sel:limit:ListRuleGroups', listRuleGroups_limit - Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

Request Lenses

listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text) Source #

If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural) Source #

Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

Destructuring the Response

data ListRuleGroupsResponse Source #

See: newListRuleGroupsResponse smart constructor.

Constructors

ListRuleGroupsResponse'

Fields

ruleGroups :: Maybe [RuleGroupSummary]
An array of RuleGroup objects.
nextMarker :: Maybe Text
If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods (==) :: ListRuleGroupsResponse -> ListRuleGroupsResponse -> Bool # (/=) :: ListRuleGroupsResponse -> ListRuleGroupsResponse -> Bool #
Read ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods readsPrec :: Int -> ReadS ListRuleGroupsResponse # readList :: ReadS [ListRuleGroupsResponse] # readPrec :: ReadPrec ListRuleGroupsResponse # readListPrec :: ReadPrec [ListRuleGroupsResponse] #
Show ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods showsPrec :: Int -> ListRuleGroupsResponse -> ShowS # show :: ListRuleGroupsResponse -> String # showList :: [ListRuleGroupsResponse] -> ShowS #
Generic ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Associated Types type Rep ListRuleGroupsResponse :: Type -> Type # Methods from :: ListRuleGroupsResponse -> Rep ListRuleGroupsResponse x # to :: Rep ListRuleGroupsResponse x -> ListRuleGroupsResponse #
NFData ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups Methods rnf :: ListRuleGroupsResponse -> () #
type Rep ListRuleGroupsResponse Source #
Instance details Defined in Amazonka.WAF.ListRuleGroups type Rep ListRuleGroupsResponse = D1 ('MetaData "ListRuleGroupsResponse" "Amazonka.WAF.ListRuleGroups" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "ListRuleGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleGroupSummary])) :: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRuleGroupsResponse Source #

Arguments

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

Create a value of ListRuleGroupsResponse 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:ruleGroups:ListRuleGroupsResponse', listRuleGroupsResponse_ruleGroups - An array of RuleGroup objects.

$sel:nextMarker:ListRuleGroups', listRuleGroupsResponse_nextMarker - If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

$sel:httpStatus:ListRuleGroupsResponse', listRuleGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary]) Source #

An array of RuleGroup objects.

listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text) Source #

If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int Source #

The response's http status code.