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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

Synopsis

data ListIPSets = ListIPSets' {
- limit :: Maybe Natural
- nextMarker :: Maybe Text
- scope :: Scope
}
newListIPSets :: Scope -> ListIPSets
listIPSets_limit :: Lens' ListIPSets (Maybe Natural)
listIPSets_nextMarker :: Lens' ListIPSets (Maybe Text)
listIPSets_scope :: Lens' ListIPSets Scope
data ListIPSetsResponse = ListIPSetsResponse' {
- iPSets :: Maybe [IPSetSummary]
- nextMarker :: Maybe Text
- httpStatus :: Int
}
newListIPSetsResponse :: Int -> ListIPSetsResponse
listIPSetsResponse_iPSets :: Lens' ListIPSetsResponse (Maybe [IPSetSummary])
listIPSetsResponse_nextMarker :: Lens' ListIPSetsResponse (Maybe Text)
listIPSetsResponse_httpStatus :: Lens' ListIPSetsResponse Int

Creating a Request

data ListIPSets Source #

See: newListIPSets smart constructor.

Constructors

ListIPSets'

Fields

limit :: Maybe Natural
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.
nextMarker :: Maybe Text
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
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.

Instances

Instances details

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

newListIPSets Source #

Arguments

:: Scope	`ListIPSets`
-> ListIPSets

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

ListIPSets, listIPSets_limit - The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

ListIPSets, listIPSets_nextMarker - When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

ListIPSets, listIPSets_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.

Request Lenses

listIPSets_limit :: Lens' ListIPSets (Maybe Natural) Source #

The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

listIPSets_nextMarker :: Lens' ListIPSets (Maybe Text) Source #

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

listIPSets_scope :: Lens' ListIPSets 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.

Destructuring the Response

data ListIPSetsResponse Source #

See: newListIPSetsResponse smart constructor.

Constructors

ListIPSetsResponse'

Fields

iPSets :: Maybe [IPSetSummary]
Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.
nextMarker :: Maybe Text
When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListIPSetsResponse Source #

Arguments

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

Create a value of ListIPSetsResponse 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:iPSets:ListIPSetsResponse', listIPSetsResponse_iPSets - Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

ListIPSets, listIPSetsResponse_nextMarker - When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

$sel:httpStatus:ListIPSetsResponse', listIPSetsResponse_httpStatus - The response's http status code.

Response Lenses

listIPSetsResponse_iPSets :: Lens' ListIPSetsResponse (Maybe [IPSetSummary]) Source #

Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

listIPSetsResponse_nextMarker :: Lens' ListIPSetsResponse (Maybe Text) Source #

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

listIPSetsResponse_httpStatus :: Lens' ListIPSetsResponse Int Source #

The response's http status code.