| 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 |
Amazonka.WAFV2.GetRegexPatternSet
Description
Retrieves the specified RegexPatternSet.
Synopsis
- data GetRegexPatternSet = GetRegexPatternSet' {}
- newGetRegexPatternSet :: Text -> Scope -> Text -> GetRegexPatternSet
- getRegexPatternSet_name :: Lens' GetRegexPatternSet Text
- getRegexPatternSet_scope :: Lens' GetRegexPatternSet Scope
- getRegexPatternSet_id :: Lens' GetRegexPatternSet Text
- data GetRegexPatternSetResponse = GetRegexPatternSetResponse' {}
- newGetRegexPatternSetResponse :: Int -> GetRegexPatternSetResponse
- getRegexPatternSetResponse_lockToken :: Lens' GetRegexPatternSetResponse (Maybe Text)
- getRegexPatternSetResponse_regexPatternSet :: Lens' GetRegexPatternSetResponse (Maybe RegexPatternSet)
- getRegexPatternSetResponse_httpStatus :: Lens' GetRegexPatternSetResponse Int
Creating a Request
data GetRegexPatternSet Source #
See: newGetRegexPatternSet smart constructor.
Constructors
| GetRegexPatternSet' | |
Fields
| |
Instances
newGetRegexPatternSet Source #
Arguments
| :: Text | |
| -> Scope | |
| -> Text | |
| -> GetRegexPatternSet |
Create a value of GetRegexPatternSet 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:
GetRegexPatternSet, getRegexPatternSet_name - The name of the set. You cannot change the name after you create the
set.
GetRegexPatternSet, getRegexPatternSet_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.
GetRegexPatternSet, getRegexPatternSet_id - A unique identifier for the set. This ID is returned in the responses to
create and list commands. You provide it to operations like update and
delete.
Request Lenses
getRegexPatternSet_name :: Lens' GetRegexPatternSet Text Source #
The name of the set. You cannot change the name after you create the set.
getRegexPatternSet_scope :: Lens' GetRegexPatternSet 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.
getRegexPatternSet_id :: Lens' GetRegexPatternSet Text Source #
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
Destructuring the Response
data GetRegexPatternSetResponse Source #
See: newGetRegexPatternSetResponse smart constructor.
Constructors
| GetRegexPatternSetResponse' | |
Fields
| |
Instances
newGetRegexPatternSetResponse Source #
Create a value of GetRegexPatternSetResponse 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:
GetRegexPatternSetResponse, getRegexPatternSetResponse_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:regexPatternSet:GetRegexPatternSetResponse', getRegexPatternSetResponse_regexPatternSet -
$sel:httpStatus:GetRegexPatternSetResponse', getRegexPatternSetResponse_httpStatus - The response's http status code.
Response Lenses
getRegexPatternSetResponse_lockToken :: Lens' GetRegexPatternSetResponse (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.
getRegexPatternSetResponse_regexPatternSet :: Lens' GetRegexPatternSetResponse (Maybe RegexPatternSet) Source #
getRegexPatternSetResponse_httpStatus :: Lens' GetRegexPatternSetResponse Int Source #
The response's http status code.