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

Description

Retrieves the specified managed rule set.

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

See: newGetManagedRuleSet smart constructor.

Constructors

GetManagedRuleSet' 

Fields

  • name :: Text

    The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

    This name is assigned to the corresponding managed rule group, which your customers can access and use.

  • 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.
  • id :: Text

    A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

Instances

Instances details
ToJSON GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

ToHeaders GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

ToPath GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

ToQuery GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

AWSRequest GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Associated Types

type AWSResponse GetManagedRuleSet #

Generic GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Associated Types

type Rep GetManagedRuleSet :: Type -> Type #

Read GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Show GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

NFData GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Methods

rnf :: GetManagedRuleSet -> () #

Eq GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Hashable GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

type AWSResponse GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

type Rep GetManagedRuleSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

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

newGetManagedRuleSet Source #

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

GetManagedRuleSet, getManagedRuleSet_name - The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

GetManagedRuleSet, getManagedRuleSet_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.

GetManagedRuleSet, getManagedRuleSet_id - A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

Request Lenses

getManagedRuleSet_name :: Lens' GetManagedRuleSet Text Source #

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

getManagedRuleSet_scope :: Lens' GetManagedRuleSet 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.

getManagedRuleSet_id :: Lens' GetManagedRuleSet Text Source #

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

Destructuring the Response

data GetManagedRuleSetResponse Source #

See: newGetManagedRuleSetResponse smart constructor.

Constructors

GetManagedRuleSetResponse' 

Fields

  • lockToken :: Maybe Text

    A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

  • managedRuleSet :: Maybe ManagedRuleSet

    The managed rule set that you requested.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Associated Types

type Rep GetManagedRuleSetResponse :: Type -> Type #

Read GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Show GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

NFData GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

Eq GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

type Rep GetManagedRuleSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetManagedRuleSet

type Rep GetManagedRuleSetResponse = D1 ('MetaData "GetManagedRuleSetResponse" "Amazonka.WAFV2.GetManagedRuleSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetManagedRuleSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "managedRuleSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedRuleSet)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetManagedRuleSetResponse Source #

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

GetManagedRuleSetResponse, getManagedRuleSetResponse_lockToken - A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

$sel:managedRuleSet:GetManagedRuleSetResponse', getManagedRuleSetResponse_managedRuleSet - The managed rule set that you requested.

$sel:httpStatus:GetManagedRuleSetResponse', getManagedRuleSetResponse_httpStatus - The response's http status code.

Response Lenses

getManagedRuleSetResponse_lockToken :: Lens' GetManagedRuleSetResponse (Maybe Text) Source #

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.