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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified IPSet.

Synopsis

data DeleteIPSet = DeleteIPSet' {
- name :: Text
- scope :: Scope
- id :: Text
- lockToken :: Text
}
newDeleteIPSet :: Text -> Scope -> Text -> Text -> DeleteIPSet
deleteIPSet_name :: Lens' DeleteIPSet Text
deleteIPSet_scope :: Lens' DeleteIPSet Scope
deleteIPSet_id :: Lens' DeleteIPSet Text
deleteIPSet_lockToken :: Lens' DeleteIPSet Text
data DeleteIPSetResponse = DeleteIPSetResponse' {
- httpStatus :: Int
}
newDeleteIPSetResponse :: Int -> DeleteIPSetResponse
deleteIPSetResponse_httpStatus :: Lens' DeleteIPSetResponse Int

Creating a Request

data DeleteIPSet Source #

See: newDeleteIPSet smart constructor.

Constructors

DeleteIPSet'

Fields

name :: Text
The name of the IP set. You cannot change the name of an IPSet 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
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.
lockToken :: 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.

Instances

Instances details

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

newDeleteIPSet Source #

Arguments

:: Text	`DeleteIPSet`
-> Scope	`DeleteIPSet`
-> Text	`DeleteIPSet`
-> Text	`DeleteIPSet`
-> DeleteIPSet

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

DeleteIPSet, deleteIPSet_name - The name of the IP set. You cannot change the name of an IPSet after you create it.

DeleteIPSet, deleteIPSet_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.

DeleteIPSet, deleteIPSet_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.

DeleteIPSet, deleteIPSet_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.

Request Lenses

deleteIPSet_name :: Lens' DeleteIPSet Text Source #

The name of the IP set. You cannot change the name of an IPSet after you create it.

deleteIPSet_scope :: Lens' DeleteIPSet 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.

deleteIPSet_id :: Lens' DeleteIPSet 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.

deleteIPSet_lockToken :: Lens' DeleteIPSet 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.

Destructuring the Response

data DeleteIPSetResponse Source #

See: newDeleteIPSetResponse smart constructor.

Constructors

DeleteIPSetResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteIPSetResponse Source #

Arguments

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

Create a value of DeleteIPSetResponse 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:httpStatus:DeleteIPSetResponse', deleteIPSetResponse_httpStatus - The response's http status code.

Response Lenses

deleteIPSetResponse_httpStatus :: Lens' DeleteIPSetResponse Int Source #

The response's http status code.