Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data GetManagedRuleSet = GetManagedRuleSet' {}
- newGetManagedRuleSet :: Text -> Scope -> Text -> GetManagedRuleSet
- getManagedRuleSet_name :: Lens' GetManagedRuleSet Text
- getManagedRuleSet_scope :: Lens' GetManagedRuleSet Scope
- getManagedRuleSet_id :: Lens' GetManagedRuleSet Text
- data GetManagedRuleSetResponse = GetManagedRuleSetResponse' {}
- newGetManagedRuleSetResponse :: Int -> GetManagedRuleSetResponse
- getManagedRuleSetResponse_lockToken :: Lens' GetManagedRuleSetResponse (Maybe Text)
- getManagedRuleSetResponse_managedRuleSet :: Lens' GetManagedRuleSetResponse (Maybe ManagedRuleSet)
- getManagedRuleSetResponse_httpStatus :: Lens' GetManagedRuleSetResponse Int
Creating a Request
data GetManagedRuleSet Source #
See: newGetManagedRuleSet
smart constructor.
GetManagedRuleSet' | |
|
Instances
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.
GetManagedRuleSetResponse' | |
|
Instances
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.
getManagedRuleSetResponse_managedRuleSet :: Lens' GetManagedRuleSetResponse (Maybe ManagedRuleSet) Source #
The managed rule set that you requested.
getManagedRuleSetResponse_httpStatus :: Lens' GetManagedRuleSetResponse Int Source #
The response's http status code.