Amazonka.WAFV2.ListAvailableManagedRuleGroups

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.

Creating a Request

data ListAvailableManagedRuleGroups

See: newListAvailableManagedRuleGroups smart constructor.

Constructors

ListAvailableManagedRuleGroups'

Fields

• limit :: Maybe Natural

  The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

• nextMarker :: Maybe Text

  When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

• scope :: Scope

  Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

  To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Instances

ToJSON ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

toJSON :: ListAvailableManagedRuleGroups -> Value

toEncoding :: ListAvailableManagedRuleGroups -> Encoding

toJSONList :: [ListAvailableManagedRuleGroups] -> Value

toEncodingList :: [ListAvailableManagedRuleGroups] -> Encoding

ToHeaders ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

toHeaders :: ListAvailableManagedRuleGroups -> [Header]

ToPath ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

toPath :: ListAvailableManagedRuleGroups -> ByteString

ToQuery ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

toQuery :: ListAvailableManagedRuleGroups -> QueryString

AWSRequest ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Associated Types

type AWSResponse ListAvailableManagedRuleGroups

Methods

request :: (Service -> Service) -> ListAvailableManagedRuleGroups -> Request ListAvailableManagedRuleGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAvailableManagedRuleGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAvailableManagedRuleGroups)))

Generic ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Associated Types

type Rep ListAvailableManagedRuleGroups :: Type -> Type

Methods

from :: ListAvailableManagedRuleGroups -> Rep ListAvailableManagedRuleGroups x

to :: Rep ListAvailableManagedRuleGroups x -> ListAvailableManagedRuleGroups

Read ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

readsPrec :: Int -> ReadS ListAvailableManagedRuleGroups

readList :: ReadS [ListAvailableManagedRuleGroups]

readPrec :: ReadPrec ListAvailableManagedRuleGroups

readListPrec :: ReadPrec [ListAvailableManagedRuleGroups]

Show ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

showsPrec :: Int -> ListAvailableManagedRuleGroups -> ShowS

show :: ListAvailableManagedRuleGroups -> String

showList :: [ListAvailableManagedRuleGroups] -> ShowS

NFData ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

rnf :: ListAvailableManagedRuleGroups -> ()

Eq ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

(==) :: ListAvailableManagedRuleGroups -> ListAvailableManagedRuleGroups -> Bool

(/=) :: ListAvailableManagedRuleGroups -> ListAvailableManagedRuleGroups -> Bool

Hashable ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

hashWithSalt :: Int -> ListAvailableManagedRuleGroups -> Int

hash :: ListAvailableManagedRuleGroups -> Int

type AWSResponse ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

type AWSResponse ListAvailableManagedRuleGroups = ListAvailableManagedRuleGroupsResponse

type Rep ListAvailableManagedRuleGroups

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

type Rep ListAvailableManagedRuleGroups = D1 ('MetaData "ListAvailableManagedRuleGroups" "Amazonka.WAFV2.ListAvailableManagedRuleGroups" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ListAvailableManagedRuleGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope))))

newListAvailableManagedRuleGroups

Arguments

:: Scope

ListAvailableManagedRuleGroups

-> ListAvailableManagedRuleGroups

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

ListAvailableManagedRuleGroups, listAvailableManagedRuleGroups_limit - The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

ListAvailableManagedRuleGroups, listAvailableManagedRuleGroups_nextMarker - When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

ListAvailableManagedRuleGroups, listAvailableManagedRuleGroups_scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
• API and SDKs - For all calls, use the Region endpoint us-east-1.

Request Lenses

listAvailableManagedRuleGroups_limit :: Lens' ListAvailableManagedRuleGroups (Maybe Natural)

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

listAvailableManagedRuleGroups_nextMarker :: Lens' ListAvailableManagedRuleGroups (Maybe Text)

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

listAvailableManagedRuleGroups_scope :: Lens' ListAvailableManagedRuleGroups Scope

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
• API and SDKs - For all calls, use the Region endpoint us-east-1.

Destructuring the Response

data ListAvailableManagedRuleGroupsResponse

See: newListAvailableManagedRuleGroupsResponse smart constructor.

Constructors

ListAvailableManagedRuleGroupsResponse'

Fields

• managedRuleGroups :: Maybe [ManagedRuleGroupSummary]
• nextMarker :: Maybe Text

  When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Associated Types

type Rep ListAvailableManagedRuleGroupsResponse :: Type -> Type

Methods

from :: ListAvailableManagedRuleGroupsResponse -> Rep ListAvailableManagedRuleGroupsResponse x

to :: Rep ListAvailableManagedRuleGroupsResponse x -> ListAvailableManagedRuleGroupsResponse

Read ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

readsPrec :: Int -> ReadS ListAvailableManagedRuleGroupsResponse

readList :: ReadS [ListAvailableManagedRuleGroupsResponse]

readPrec :: ReadPrec ListAvailableManagedRuleGroupsResponse

readListPrec :: ReadPrec [ListAvailableManagedRuleGroupsResponse]

Show ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

showsPrec :: Int -> ListAvailableManagedRuleGroupsResponse -> ShowS

show :: ListAvailableManagedRuleGroupsResponse -> String

showList :: [ListAvailableManagedRuleGroupsResponse] -> ShowS

NFData ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

rnf :: ListAvailableManagedRuleGroupsResponse -> ()

Eq ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

Methods

(==) :: ListAvailableManagedRuleGroupsResponse -> ListAvailableManagedRuleGroupsResponse -> Bool

(/=) :: ListAvailableManagedRuleGroupsResponse -> ListAvailableManagedRuleGroupsResponse -> Bool

type Rep ListAvailableManagedRuleGroupsResponse

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroups

type Rep ListAvailableManagedRuleGroupsResponse = D1 ('MetaData "ListAvailableManagedRuleGroupsResponse" "Amazonka.WAFV2.ListAvailableManagedRuleGroups" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ListAvailableManagedRuleGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "managedRuleGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ManagedRuleGroupSummary])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAvailableManagedRuleGroupsResponse

Arguments

:: Int

$sel:httpStatus:ListAvailableManagedRuleGroupsResponse'

-> ListAvailableManagedRuleGroupsResponse

Create a value of ListAvailableManagedRuleGroupsResponse 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:managedRuleGroups:ListAvailableManagedRuleGroupsResponse', listAvailableManagedRuleGroupsResponse_managedRuleGroups -

ListAvailableManagedRuleGroups, listAvailableManagedRuleGroupsResponse_nextMarker - When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

$sel:httpStatus:ListAvailableManagedRuleGroupsResponse', listAvailableManagedRuleGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listAvailableManagedRuleGroupsResponse_managedRuleGroups :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe [ManagedRuleGroupSummary])

listAvailableManagedRuleGroupsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe Text)

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

listAvailableManagedRuleGroupsResponse_httpStatus :: Lens' ListAvailableManagedRuleGroupsResponse Int

The response's http status code.