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

Description

Returns a list of the available versions for the specified managed rule group.

Synopsis

Creating a Request

data ListAvailableManagedRuleGroupVersions Source #

Constructors

ListAvailableManagedRuleGroupVersions' 

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.

  • vendorName :: Text

    The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

  • name :: Text

    The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

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

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

ToHeaders ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

ToPath ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

ToQuery ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

AWSRequest ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Generic ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Read ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Show ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

NFData ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Eq ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Hashable ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

type AWSResponse ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

type Rep ListAvailableManagedRuleGroupVersions Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

type Rep ListAvailableManagedRuleGroupVersions = D1 ('MetaData "ListAvailableManagedRuleGroupVersions" "Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ListAvailableManagedRuleGroupVersions'" '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 "vendorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope)))))

newListAvailableManagedRuleGroupVersions Source #

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

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersions_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.

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersions_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.

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersions_vendorName - The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersions_name - The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersions_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

listAvailableManagedRuleGroupVersions_limit :: Lens' ListAvailableManagedRuleGroupVersions (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.

listAvailableManagedRuleGroupVersions_nextMarker :: Lens' ListAvailableManagedRuleGroupVersions (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.

listAvailableManagedRuleGroupVersions_vendorName :: Lens' ListAvailableManagedRuleGroupVersions Text Source #

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

listAvailableManagedRuleGroupVersions_name :: Lens' ListAvailableManagedRuleGroupVersions Text Source #

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

listAvailableManagedRuleGroupVersions_scope :: Lens' ListAvailableManagedRuleGroupVersions 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 ListAvailableManagedRuleGroupVersionsResponse Source #

Constructors

ListAvailableManagedRuleGroupVersionsResponse' 

Fields

  • currentDefaultVersion :: Maybe Text

    The name of the version that's currently set as the default.

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

  • versions :: Maybe [ManagedRuleGroupVersion]

    The versions that are currently available for the specified managed rule group.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Read ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Show ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

NFData ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

Eq ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

type Rep ListAvailableManagedRuleGroupVersionsResponse Source # 
Instance details

Defined in Amazonka.WAFV2.ListAvailableManagedRuleGroupVersions

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

newListAvailableManagedRuleGroupVersionsResponse Source #

Create a value of ListAvailableManagedRuleGroupVersionsResponse 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:currentDefaultVersion:ListAvailableManagedRuleGroupVersionsResponse', listAvailableManagedRuleGroupVersionsResponse_currentDefaultVersion - The name of the version that's currently set as the default.

ListAvailableManagedRuleGroupVersions, listAvailableManagedRuleGroupVersionsResponse_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:versions:ListAvailableManagedRuleGroupVersionsResponse', listAvailableManagedRuleGroupVersionsResponse_versions - The versions that are currently available for the specified managed rule group.

$sel:httpStatus:ListAvailableManagedRuleGroupVersionsResponse', listAvailableManagedRuleGroupVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listAvailableManagedRuleGroupVersionsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupVersionsResponse (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.