libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.GetChangeToken

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

Synopsis

Creating a Request

data GetChangeToken Source #

See: newGetChangeToken smart constructor.

Constructors

GetChangeToken' 

Instances

Instances details
Eq GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

(==) :: GetChangeToken -> GetChangeToken -> Bool #

(/=) :: GetChangeToken -> GetChangeToken -> Bool #

Read GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

readsPrec :: Int -> ReadS GetChangeToken #

readList :: ReadS [GetChangeToken] #

readPrec :: ReadPrec GetChangeToken #

readListPrec :: ReadPrec [GetChangeToken] #

Show GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

showsPrec :: Int -> GetChangeToken -> ShowS #

show :: GetChangeToken -> String #

showList :: [GetChangeToken] -> ShowS #

Generic GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Associated Types

type Rep GetChangeToken :: Type -> Type #

Methods

from :: GetChangeToken -> Rep GetChangeToken x #

to :: Rep GetChangeToken x -> GetChangeToken #

NFData GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

rnf :: GetChangeToken -> () #

Hashable GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

hashWithSalt :: Int -> GetChangeToken -> Int #

hash :: GetChangeToken -> Int #

ToJSON GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

toJSON :: GetChangeToken -> Value #

toEncoding :: GetChangeToken -> Encoding #

toJSONList :: [GetChangeToken] -> Value #

toEncodingList :: [GetChangeToken] -> Encoding #

AWSRequest GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Associated Types

type AWSResponse GetChangeToken #

Methods

request :: GetChangeToken -> Request GetChangeToken #

response :: MonadResource m => Logger -> Service -> Proxy GetChangeToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetChangeToken))) #

ToHeaders GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

toHeaders :: GetChangeToken -> [Header] #

ToPath GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

toPath :: GetChangeToken -> ByteString #

ToQuery GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

toQuery :: GetChangeToken -> QueryString #

type Rep GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

type Rep GetChangeToken = D1 ('MetaData "GetChangeToken" "Amazonka.WAF.GetChangeToken" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "GetChangeToken'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse GetChangeToken Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

type AWSResponse GetChangeToken = GetChangeTokenResponse

newGetChangeToken :: GetChangeToken Source #

Create a value of GetChangeToken with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data GetChangeTokenResponse Source #

See: newGetChangeTokenResponse smart constructor.

Constructors

GetChangeTokenResponse' 

Fields

  • changeToken :: Maybe Text

    The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

(==) :: GetChangeTokenResponse -> GetChangeTokenResponse -> Bool #

(/=) :: GetChangeTokenResponse -> GetChangeTokenResponse -> Bool #

Read GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

readsPrec :: Int -> ReadS GetChangeTokenResponse #

readList :: ReadS [GetChangeTokenResponse] #

readPrec :: ReadPrec GetChangeTokenResponse #

readListPrec :: ReadPrec [GetChangeTokenResponse] #

Show GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

showsPrec :: Int -> GetChangeTokenResponse -> ShowS #

show :: GetChangeTokenResponse -> String #

showList :: [GetChangeTokenResponse] -> ShowS #

Generic GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Associated Types

type Rep GetChangeTokenResponse :: Type -> Type #

Methods

from :: GetChangeTokenResponse -> Rep GetChangeTokenResponse x #

to :: Rep GetChangeTokenResponse x -> GetChangeTokenResponse #

NFData GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

Methods

rnf :: GetChangeTokenResponse -> () #

type Rep GetChangeTokenResponse Source # 
Instance details

Defined in Amazonka.WAF.GetChangeToken

type Rep GetChangeTokenResponse = D1 ('MetaData "GetChangeTokenResponse" "Amazonka.WAF.GetChangeToken" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "GetChangeTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetChangeTokenResponse Source #

Arguments

:: Int

$sel:httpStatus:GetChangeTokenResponse'

-> GetChangeTokenResponse 

Create a value of GetChangeTokenResponse 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:changeToken:GetChangeTokenResponse', getChangeTokenResponse_changeToken - The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

$sel:httpStatus:GetChangeTokenResponse', getChangeTokenResponse_httpStatus - The response's http status code.

Response Lenses

getChangeTokenResponse_changeToken :: Lens' GetChangeTokenResponse (Maybe Text) Source #

The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

getChangeTokenResponse_httpStatus :: Lens' GetChangeTokenResponse Int Source #

The response's http status code.