libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.ListSubscribedRuleGroups

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 that you are subscribed to.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSubscribedRuleGroups Source #

See: newListSubscribedRuleGroups smart constructor.

Constructors

ListSubscribedRuleGroups' 

Fields

  • nextMarker :: Maybe Text

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

  • limit :: Maybe Natural

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

Instances

Instances details
Eq ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

(==) :: ListSubscribedRuleGroups -> ListSubscribedRuleGroups -> Bool #

(/=) :: ListSubscribedRuleGroups -> ListSubscribedRuleGroups -> Bool #

Read ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

readsPrec :: Int -> ReadS ListSubscribedRuleGroups #

readList :: ReadS [ListSubscribedRuleGroups] #

readPrec :: ReadPrec ListSubscribedRuleGroups #

readListPrec :: ReadPrec [ListSubscribedRuleGroups] #

Show ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

showsPrec :: Int -> ListSubscribedRuleGroups -> ShowS #

show :: ListSubscribedRuleGroups -> String #

showList :: [ListSubscribedRuleGroups] -> ShowS #

Generic ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Associated Types

type Rep ListSubscribedRuleGroups :: Type -> Type #

Methods

from :: ListSubscribedRuleGroups -> Rep ListSubscribedRuleGroups x #

to :: Rep ListSubscribedRuleGroups x -> ListSubscribedRuleGroups #

NFData ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

rnf :: ListSubscribedRuleGroups -> () #

Hashable ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

hashWithSalt :: Int -> ListSubscribedRuleGroups -> Int #

hash :: ListSubscribedRuleGroups -> Int #

ToJSON ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

toJSON :: ListSubscribedRuleGroups -> Value #

toEncoding :: ListSubscribedRuleGroups -> Encoding #

toJSONList :: [ListSubscribedRuleGroups] -> Value #

toEncodingList :: [ListSubscribedRuleGroups] -> Encoding #

AWSPager ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

page :: ListSubscribedRuleGroups -> AWSResponse ListSubscribedRuleGroups -> Maybe ListSubscribedRuleGroups #

AWSRequest ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Associated Types

type AWSResponse ListSubscribedRuleGroups #

Methods

request :: ListSubscribedRuleGroups -> Request ListSubscribedRuleGroups #

response :: MonadResource m => Logger -> Service -> Proxy ListSubscribedRuleGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSubscribedRuleGroups))) #

ToHeaders ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

toHeaders :: ListSubscribedRuleGroups -> [Header] #

ToPath ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

toPath :: ListSubscribedRuleGroups -> ByteString #

ToQuery ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

toQuery :: ListSubscribedRuleGroups -> QueryString #

type Rep ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

type Rep ListSubscribedRuleGroups = D1 ('MetaData "ListSubscribedRuleGroups" "Amazonka.WAF.ListSubscribedRuleGroups" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "ListSubscribedRuleGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListSubscribedRuleGroups Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

type AWSResponse ListSubscribedRuleGroups = ListSubscribedRuleGroupsResponse

newListSubscribedRuleGroups :: ListSubscribedRuleGroups Source #

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

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

Request Lenses

listSubscribedRuleGroups_nextMarker :: Lens' ListSubscribedRuleGroups (Maybe Text) Source #

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

listSubscribedRuleGroups_limit :: Lens' ListSubscribedRuleGroups (Maybe Natural) Source #

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

Destructuring the Response

data ListSubscribedRuleGroupsResponse Source #

See: newListSubscribedRuleGroupsResponse smart constructor.

Constructors

ListSubscribedRuleGroupsResponse' 

Fields

  • ruleGroups :: Maybe [SubscribedRuleGroupSummary]

    An array of RuleGroup objects.

  • nextMarker :: Maybe Text

    If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups 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 ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

(==) :: ListSubscribedRuleGroupsResponse -> ListSubscribedRuleGroupsResponse -> Bool #

(/=) :: ListSubscribedRuleGroupsResponse -> ListSubscribedRuleGroupsResponse -> Bool #

Read ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

readsPrec :: Int -> ReadS ListSubscribedRuleGroupsResponse #

readList :: ReadS [ListSubscribedRuleGroupsResponse] #

readPrec :: ReadPrec ListSubscribedRuleGroupsResponse #

readListPrec :: ReadPrec [ListSubscribedRuleGroupsResponse] #

Show ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

showsPrec :: Int -> ListSubscribedRuleGroupsResponse -> ShowS #

show :: ListSubscribedRuleGroupsResponse -> String #

showList :: [ListSubscribedRuleGroupsResponse] -> ShowS #

Generic ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Associated Types

type Rep ListSubscribedRuleGroupsResponse :: Type -> Type #

Methods

from :: ListSubscribedRuleGroupsResponse -> Rep ListSubscribedRuleGroupsResponse x #

to :: Rep ListSubscribedRuleGroupsResponse x -> ListSubscribedRuleGroupsResponse #

NFData ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

Methods

rnf :: ListSubscribedRuleGroupsResponse -> () #

type Rep ListSubscribedRuleGroupsResponse Source # 
Instance details

Defined in Amazonka.WAF.ListSubscribedRuleGroups

type Rep ListSubscribedRuleGroupsResponse = D1 ('MetaData "ListSubscribedRuleGroupsResponse" "Amazonka.WAF.ListSubscribedRuleGroups" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "ListSubscribedRuleGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubscribedRuleGroupSummary])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSubscribedRuleGroupsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSubscribedRuleGroupsResponse'

-> ListSubscribedRuleGroupsResponse 

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

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

$sel:httpStatus:ListSubscribedRuleGroupsResponse', listSubscribedRuleGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listSubscribedRuleGroupsResponse_ruleGroups :: Lens' ListSubscribedRuleGroupsResponse (Maybe [SubscribedRuleGroupSummary]) Source #

An array of RuleGroup objects.

listSubscribedRuleGroupsResponse_nextMarker :: Lens' ListSubscribedRuleGroupsResponse (Maybe Text) Source #

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

listSubscribedRuleGroupsResponse_httpStatus :: Lens' ListSubscribedRuleGroupsResponse Int Source #

The response's http status code.