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

Description

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

Synopsis

Creating a Request

data ListWebACLs Source #

See: newListWebACLs smart constructor.

Constructors

ListWebACLs' 

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 ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

ToHeaders ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Methods

toHeaders :: ListWebACLs -> [Header] #

ToPath ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

ToQuery ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

AWSRequest ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Associated Types

type AWSResponse ListWebACLs #

Generic ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Associated Types

type Rep ListWebACLs :: Type -> Type #

Read ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Show ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

NFData ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Methods

rnf :: ListWebACLs -> () #

Eq ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Hashable ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

type AWSResponse ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

type Rep ListWebACLs Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

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

newListWebACLs Source #

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

ListWebACLs, listWebACLs_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.

ListWebACLs, listWebACLs_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.

ListWebACLs, listWebACLs_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

listWebACLs_limit :: Lens' ListWebACLs (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.

listWebACLs_nextMarker :: Lens' ListWebACLs (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.

listWebACLs_scope :: Lens' ListWebACLs 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 ListWebACLsResponse Source #

See: newListWebACLsResponse smart constructor.

Constructors

ListWebACLsResponse' 

Fields

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

  • webACLs :: Maybe [WebACLSummary]
     
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Associated Types

type Rep ListWebACLsResponse :: Type -> Type #

Read ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Show ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

NFData ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

Methods

rnf :: ListWebACLsResponse -> () #

Eq ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

type Rep ListWebACLsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListWebACLs

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

newListWebACLsResponse Source #

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

ListWebACLs, listWebACLsResponse_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:webACLs:ListWebACLsResponse', listWebACLsResponse_webACLs -

$sel:httpStatus:ListWebACLsResponse', listWebACLsResponse_httpStatus - The response's http status code.

Response Lenses

listWebACLsResponse_nextMarker :: Lens' ListWebACLsResponse (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.