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.EC2.DescribeIpv6Pools

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes your IPv6 address pools.

This operation returns paginated results.

Synopsis

data DescribeIpv6Pools = DescribeIpv6Pools' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- poolIds :: Maybe [Text]
}
newDescribeIpv6Pools :: DescribeIpv6Pools
describeIpv6Pools_dryRun :: Lens' DescribeIpv6Pools (Maybe Bool)
describeIpv6Pools_filters :: Lens' DescribeIpv6Pools (Maybe [Filter])
describeIpv6Pools_maxResults :: Lens' DescribeIpv6Pools (Maybe Natural)
describeIpv6Pools_nextToken :: Lens' DescribeIpv6Pools (Maybe Text)
describeIpv6Pools_poolIds :: Lens' DescribeIpv6Pools (Maybe [Text])
data DescribeIpv6PoolsResponse = DescribeIpv6PoolsResponse' {
- ipv6Pools :: Maybe [Ipv6Pool]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeIpv6PoolsResponse :: Int -> DescribeIpv6PoolsResponse
describeIpv6PoolsResponse_ipv6Pools :: Lens' DescribeIpv6PoolsResponse (Maybe [Ipv6Pool])
describeIpv6PoolsResponse_nextToken :: Lens' DescribeIpv6PoolsResponse (Maybe Text)
describeIpv6PoolsResponse_httpStatus :: Lens' DescribeIpv6PoolsResponse Int

Creating a Request

data DescribeIpv6Pools Source #

See: newDescribeIpv6Pools smart constructor.

Constructors

DescribeIpv6Pools'

Fields

dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters :: Maybe [Filter]
One or more filters.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token for the next page of results.
poolIds :: Maybe [Text]
The IDs of the IPv6 address pools.

Instances

Instances details

ToHeaders DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods toHeaders :: DescribeIpv6Pools -> [Header] #
ToPath DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods toPath :: DescribeIpv6Pools -> ByteString #
ToQuery DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods toQuery :: DescribeIpv6Pools -> QueryString #
AWSPager DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods page :: DescribeIpv6Pools -> AWSResponse DescribeIpv6Pools -> Maybe DescribeIpv6Pools #
AWSRequest DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Associated Types type AWSResponse DescribeIpv6Pools # Methods request :: (Service -> Service) -> DescribeIpv6Pools -> Request DescribeIpv6Pools # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeIpv6Pools -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeIpv6Pools))) #
Generic DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Associated Types type Rep DescribeIpv6Pools :: Type -> Type # Methods from :: DescribeIpv6Pools -> Rep DescribeIpv6Pools x # to :: Rep DescribeIpv6Pools x -> DescribeIpv6Pools #
Read DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods readsPrec :: Int -> ReadS DescribeIpv6Pools # readList :: ReadS [DescribeIpv6Pools] # readPrec :: ReadPrec DescribeIpv6Pools # readListPrec :: ReadPrec [DescribeIpv6Pools] #
Show DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods showsPrec :: Int -> DescribeIpv6Pools -> ShowS # show :: DescribeIpv6Pools -> String # showList :: [DescribeIpv6Pools] -> ShowS #
NFData DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods rnf :: DescribeIpv6Pools -> () #
Eq DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods (==) :: DescribeIpv6Pools -> DescribeIpv6Pools -> Bool # (/=) :: DescribeIpv6Pools -> DescribeIpv6Pools -> Bool #
Hashable DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods hashWithSalt :: Int -> DescribeIpv6Pools -> Int # hash :: DescribeIpv6Pools -> Int #
type AWSResponse DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools type AWSResponse DescribeIpv6Pools = DescribeIpv6PoolsResponse
type Rep DescribeIpv6Pools Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools type Rep DescribeIpv6Pools = D1 ('MetaData "DescribeIpv6Pools" "Amazonka.EC2.DescribeIpv6Pools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeIpv6Pools'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "poolIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeIpv6Pools :: DescribeIpv6Pools Source #

Create a value of DescribeIpv6Pools 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:dryRun:DescribeIpv6Pools', describeIpv6Pools_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribeIpv6Pools', describeIpv6Pools_filters - One or more filters.

tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

$sel:maxResults:DescribeIpv6Pools', describeIpv6Pools_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeIpv6Pools, describeIpv6Pools_nextToken - The token for the next page of results.

$sel:poolIds:DescribeIpv6Pools', describeIpv6Pools_poolIds - The IDs of the IPv6 address pools.

Request Lenses

describeIpv6Pools_dryRun :: Lens' DescribeIpv6Pools (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeIpv6Pools_filters :: Lens' DescribeIpv6Pools (Maybe [Filter]) Source #

One or more filters.

tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

describeIpv6Pools_maxResults :: Lens' DescribeIpv6Pools (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeIpv6Pools_nextToken :: Lens' DescribeIpv6Pools (Maybe Text) Source #

The token for the next page of results.

describeIpv6Pools_poolIds :: Lens' DescribeIpv6Pools (Maybe [Text]) Source #

The IDs of the IPv6 address pools.

Destructuring the Response

data DescribeIpv6PoolsResponse Source #

See: newDescribeIpv6PoolsResponse smart constructor.

Constructors

DescribeIpv6PoolsResponse'
Fields ipv6Pools :: Maybe [Ipv6Pool] Information about the IPv6 address pools. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Associated Types type Rep DescribeIpv6PoolsResponse :: Type -> Type # Methods from :: DescribeIpv6PoolsResponse -> Rep DescribeIpv6PoolsResponse x # to :: Rep DescribeIpv6PoolsResponse x -> DescribeIpv6PoolsResponse #
Read DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods readsPrec :: Int -> ReadS DescribeIpv6PoolsResponse # readList :: ReadS [DescribeIpv6PoolsResponse] # readPrec :: ReadPrec DescribeIpv6PoolsResponse # readListPrec :: ReadPrec [DescribeIpv6PoolsResponse] #
Show DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods showsPrec :: Int -> DescribeIpv6PoolsResponse -> ShowS # show :: DescribeIpv6PoolsResponse -> String # showList :: [DescribeIpv6PoolsResponse] -> ShowS #
NFData DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods rnf :: DescribeIpv6PoolsResponse -> () #
Eq DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools Methods (==) :: DescribeIpv6PoolsResponse -> DescribeIpv6PoolsResponse -> Bool # (/=) :: DescribeIpv6PoolsResponse -> DescribeIpv6PoolsResponse -> Bool #
type Rep DescribeIpv6PoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeIpv6Pools type Rep DescribeIpv6PoolsResponse = D1 ('MetaData "DescribeIpv6PoolsResponse" "Amazonka.EC2.DescribeIpv6Pools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeIpv6PoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6Pools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Ipv6Pool])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeIpv6PoolsResponse Source #

Arguments

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

Create a value of DescribeIpv6PoolsResponse 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:ipv6Pools:DescribeIpv6PoolsResponse', describeIpv6PoolsResponse_ipv6Pools - Information about the IPv6 address pools.

DescribeIpv6Pools, describeIpv6PoolsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeIpv6PoolsResponse', describeIpv6PoolsResponse_httpStatus - The response's http status code.

Response Lenses

describeIpv6PoolsResponse_ipv6Pools :: Lens' DescribeIpv6PoolsResponse (Maybe [Ipv6Pool]) Source #

Information about the IPv6 address pools.

describeIpv6PoolsResponse_nextToken :: Lens' DescribeIpv6PoolsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeIpv6PoolsResponse_httpStatus :: Lens' DescribeIpv6PoolsResponse Int Source #

The response's http status code.