amazonka-wafv2-2.0: Amazon WAFV2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAFV2.GetIPSet

Description

Retrieves the specified IPSet.

Synopsis

Creating a Request

data GetIPSet Source #

See: newGetIPSet smart constructor.

Constructors

GetIPSet' 

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.

Instances

Instances details
ToJSON GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

toJSON :: GetIPSet -> Value #

toEncoding :: GetIPSet -> Encoding #

toJSONList :: [GetIPSet] -> Value #

toEncodingList :: [GetIPSet] -> Encoding #

ToHeaders GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

toHeaders :: GetIPSet -> [Header] #

ToPath GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

toPath :: GetIPSet -> ByteString #

ToQuery GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

toQuery :: GetIPSet -> QueryString #

AWSRequest GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Associated Types

type AWSResponse GetIPSet #

Methods

request :: (Service -> Service) -> GetIPSet -> Request GetIPSet #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIPSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIPSet))) #

Generic GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Associated Types

type Rep GetIPSet :: Type -> Type #

Methods

from :: GetIPSet -> Rep GetIPSet x #

to :: Rep GetIPSet x -> GetIPSet #

Read GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

readsPrec :: Int -> ReadS GetIPSet #

readList :: ReadS [GetIPSet] #

readPrec :: ReadPrec GetIPSet #

readListPrec :: ReadPrec [GetIPSet] #

Show GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

showsPrec :: Int -> GetIPSet -> ShowS #

show :: GetIPSet -> String #

showList :: [GetIPSet] -> ShowS #

NFData GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

rnf :: GetIPSet -> () #

Eq GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

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

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

Hashable GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

hashWithSalt :: Int -> GetIPSet -> Int #

hash :: GetIPSet -> Int #

type AWSResponse GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

type AWSResponse GetIPSet = GetIPSetResponse
type Rep GetIPSet Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

type Rep GetIPSet = D1 ('MetaData "GetIPSet" "Amazonka.WAFV2.GetIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetIPSet'" '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))))

newGetIPSet Source #

Arguments

:: Text

GetIPSet

-> Scope

GetIPSet

-> Text

GetIPSet

-> GetIPSet 

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

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

GetIPSet, getIPSet_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.

GetIPSet, getIPSet_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

getIPSet_name :: Lens' GetIPSet Text Source #

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

getIPSet_scope :: Lens' GetIPSet 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.

getIPSet_id :: Lens' GetIPSet 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 GetIPSetResponse Source #

See: newGetIPSetResponse smart constructor.

Constructors

GetIPSetResponse' 

Fields

  • iPSet :: Maybe IPSet
     
  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Associated Types

type Rep GetIPSetResponse :: Type -> Type #

Methods

from :: GetIPSetResponse -> Rep GetIPSetResponse x #

to :: Rep GetIPSetResponse x -> GetIPSetResponse #

Read GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

readsPrec :: Int -> ReadS GetIPSetResponse #

readList :: ReadS [GetIPSetResponse] #

readPrec :: ReadPrec GetIPSetResponse #

readListPrec :: ReadPrec [GetIPSetResponse] #

Show GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

showsPrec :: Int -> GetIPSetResponse -> ShowS #

show :: GetIPSetResponse -> String #

showList :: [GetIPSetResponse] -> ShowS #

NFData GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

rnf :: GetIPSetResponse -> () #

Eq GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

Methods

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

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

type Rep GetIPSetResponse Source # 
Instance details

Defined in Amazonka.WAFV2.GetIPSet

type Rep GetIPSetResponse = D1 ('MetaData "GetIPSetResponse" "Amazonka.WAFV2.GetIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "GetIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "iPSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IPSet)) :*: (S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIPSetResponse Source #

Arguments

:: Int

$sel:httpStatus:GetIPSetResponse'

-> GetIPSetResponse 

Create a value of GetIPSetResponse 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:iPSet:GetIPSetResponse', getIPSetResponse_iPSet -

GetIPSetResponse, getIPSetResponse_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:httpStatus:GetIPSetResponse', getIPSetResponse_httpStatus - The response's http status code.

Response Lenses

getIPSetResponse_iPSet :: Lens' GetIPSetResponse (Maybe IPSet) Source #

getIPSetResponse_lockToken :: Lens' GetIPSetResponse (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.

getIPSetResponse_httpStatus :: Lens' GetIPSetResponse Int Source #

The response's http status code.