amazonka-wafv2-2.0: Amazon WAFV2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFV2.ListManagedRuleSets

Description

Retrieves the managed rule sets that you own.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Synopsis

Creating a Request

data ListManagedRuleSets Source #

See: newListManagedRuleSets smart constructor.

Constructors

ListManagedRuleSets' 

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

Instances details
ToJSON ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

ToHeaders ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

ToPath ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

ToQuery ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

AWSRequest ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Associated Types

type AWSResponse ListManagedRuleSets #

Generic ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Associated Types

type Rep ListManagedRuleSets :: Type -> Type #

Read ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Show ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

NFData ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Methods

rnf :: ListManagedRuleSets -> () #

Eq ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Hashable ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

type AWSResponse ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

type Rep ListManagedRuleSets Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

type Rep ListManagedRuleSets = D1 ('MetaData "ListManagedRuleSets" "Amazonka.WAFV2.ListManagedRuleSets" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ListManagedRuleSets'" '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))))

newListManagedRuleSets Source #

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

ListManagedRuleSets, listManagedRuleSets_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.

ListManagedRuleSets, listManagedRuleSets_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.

ListManagedRuleSets, listManagedRuleSets_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

listManagedRuleSets_limit :: Lens' ListManagedRuleSets (Maybe Natural) Source #

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.

listManagedRuleSets_nextMarker :: Lens' ListManagedRuleSets (Maybe Text) Source #

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.

listManagedRuleSets_scope :: Lens' ListManagedRuleSets Scope Source #

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 ListManagedRuleSetsResponse Source #

See: newListManagedRuleSetsResponse smart constructor.

Constructors

ListManagedRuleSetsResponse' 

Fields

  • managedRuleSets :: Maybe [ManagedRuleSetSummary]

    Your managed rule sets.

  • 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

Instances details
Generic ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Associated Types

type Rep ListManagedRuleSetsResponse :: Type -> Type #

Read ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Show ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

NFData ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

Eq ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

type Rep ListManagedRuleSetsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListManagedRuleSets

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

newListManagedRuleSetsResponse Source #

Create a value of ListManagedRuleSetsResponse 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:managedRuleSets:ListManagedRuleSetsResponse', listManagedRuleSetsResponse_managedRuleSets - Your managed rule sets.

ListManagedRuleSets, listManagedRuleSetsResponse_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:ListManagedRuleSetsResponse', listManagedRuleSetsResponse_httpStatus - The response's http status code.

Response Lenses

listManagedRuleSetsResponse_nextMarker :: Lens' ListManagedRuleSetsResponse (Maybe Text) Source #

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.