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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the specified WebACL.

Synopsis

data GetWebACL = GetWebACL' {
- name :: Text
- scope :: Scope
- id :: Text
}
newGetWebACL :: Text -> Scope -> Text -> GetWebACL
getWebACL_name :: Lens' GetWebACL Text
getWebACL_scope :: Lens' GetWebACL Scope
getWebACL_id :: Lens' GetWebACL Text
data GetWebACLResponse = GetWebACLResponse' {
- applicationIntegrationURL :: Maybe Text
- lockToken :: Maybe Text
- webACL :: Maybe WebACL
- httpStatus :: Int
}
newGetWebACLResponse :: Int -> GetWebACLResponse
getWebACLResponse_applicationIntegrationURL :: Lens' GetWebACLResponse (Maybe Text)
getWebACLResponse_lockToken :: Lens' GetWebACLResponse (Maybe Text)
getWebACLResponse_webACL :: Lens' GetWebACLResponse (Maybe WebACL)
getWebACLResponse_httpStatus :: Lens' GetWebACLResponse Int

Creating a Request

data GetWebACL Source #

See: newGetWebACL smart constructor.

Constructors

GetWebACL'

Fields

name :: Text
The name of the web ACL. You cannot change the name of a web ACL after you create it.
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
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Instances

Instances details

ToJSON GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods toJSON :: GetWebACL -> Value # toEncoding :: GetWebACL -> Encoding # toJSONList :: [GetWebACL] -> Value # toEncodingList :: [GetWebACL] -> Encoding #
ToHeaders GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods toHeaders :: GetWebACL -> [Header] #
ToPath GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods toPath :: GetWebACL -> ByteString #
ToQuery GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods toQuery :: GetWebACL -> QueryString #
AWSRequest GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Associated Types type AWSResponse GetWebACL # Methods request :: (Service -> Service) -> GetWebACL -> Request GetWebACL # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetWebACL -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetWebACL))) #
Generic GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Associated Types type Rep GetWebACL :: Type -> Type # Methods from :: GetWebACL -> Rep GetWebACL x # to :: Rep GetWebACL x -> GetWebACL #
Read GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods readsPrec :: Int -> ReadS GetWebACL # readList :: ReadS [GetWebACL] # readPrec :: ReadPrec GetWebACL # readListPrec :: ReadPrec [GetWebACL] #
Show GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods showsPrec :: Int -> GetWebACL -> ShowS # show :: GetWebACL -> String # showList :: [GetWebACL] -> ShowS #
NFData GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods rnf :: GetWebACL -> () #
Eq GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods (==) :: GetWebACL -> GetWebACL -> Bool # (/=) :: GetWebACL -> GetWebACL -> Bool #
Hashable GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods hashWithSalt :: Int -> GetWebACL -> Int # hash :: GetWebACL -> Int #
type AWSResponse GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL type AWSResponse GetWebACL = GetWebACLResponse
type Rep GetWebACL Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL type Rep GetWebACL = D1 ('MetaData "GetWebACL" "Amazonka.WAFV2.GetWebACL" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetWebACL'" '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))))

newGetWebACL Source #

Arguments

:: Text	`GetWebACL`
-> Scope	`GetWebACL`
-> Text	`GetWebACL`
-> GetWebACL

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

GetWebACL, getWebACL_name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

GetWebACL, getWebACL_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.

GetWebACL, getWebACL_id - The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Request Lenses

getWebACL_name :: Lens' GetWebACL Text Source #

The name of the web ACL. You cannot change the name of a web ACL after you create it.

getWebACL_scope :: Lens' GetWebACL 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.

getWebACL_id :: Lens' GetWebACL Text Source #

The unique identifier for the web ACL. 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 GetWebACLResponse Source #

See: newGetWebACLResponse smart constructor.

Constructors

GetWebACLResponse'

Fields

applicationIntegrationURL :: Maybe Text
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.
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.
webACL :: Maybe WebACL
The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Associated Types type Rep GetWebACLResponse :: Type -> Type # Methods from :: GetWebACLResponse -> Rep GetWebACLResponse x # to :: Rep GetWebACLResponse x -> GetWebACLResponse #
Read GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods readsPrec :: Int -> ReadS GetWebACLResponse # readList :: ReadS [GetWebACLResponse] # readPrec :: ReadPrec GetWebACLResponse # readListPrec :: ReadPrec [GetWebACLResponse] #
Show GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods showsPrec :: Int -> GetWebACLResponse -> ShowS # show :: GetWebACLResponse -> String # showList :: [GetWebACLResponse] -> ShowS #
NFData GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods rnf :: GetWebACLResponse -> () #
Eq GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL Methods (==) :: GetWebACLResponse -> GetWebACLResponse -> Bool # (/=) :: GetWebACLResponse -> GetWebACLResponse -> Bool #
type Rep GetWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.GetWebACL type Rep GetWebACLResponse = D1 ('MetaData "GetWebACLResponse" "Amazonka.WAFV2.GetWebACL" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetWebACLResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationIntegrationURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "webACL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebACL)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetWebACLResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetWebACLResponse'`
-> GetWebACLResponse

Create a value of GetWebACLResponse 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:applicationIntegrationURL:GetWebACLResponse', getWebACLResponse_applicationIntegrationURL - The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

GetWebACLResponse, getWebACLResponse_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:webACL:GetWebACLResponse', getWebACLResponse_webACL - The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

$sel:httpStatus:GetWebACLResponse', getWebACLResponse_httpStatus - The response's http status code.

Response Lenses

getWebACLResponse_applicationIntegrationURL :: Lens' GetWebACLResponse (Maybe Text) Source #

The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide.

getWebACLResponse_lockToken :: Lens' GetWebACLResponse (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.

getWebACLResponse_webACL :: Lens' GetWebACLResponse (Maybe WebACL) Source #

The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

getWebACLResponse_httpStatus :: Lens' GetWebACLResponse Int Source #

The response's http status code.