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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified customer-owned address pools or all of your customer-owned address pools.

This operation returns paginated results.

Synopsis

data DescribeCoipPools = DescribeCoipPools' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- poolIds :: Maybe [Text]
}
newDescribeCoipPools :: DescribeCoipPools
describeCoipPools_dryRun :: Lens' DescribeCoipPools (Maybe Bool)
describeCoipPools_filters :: Lens' DescribeCoipPools (Maybe [Filter])
describeCoipPools_maxResults :: Lens' DescribeCoipPools (Maybe Natural)
describeCoipPools_nextToken :: Lens' DescribeCoipPools (Maybe Text)
describeCoipPools_poolIds :: Lens' DescribeCoipPools (Maybe [Text])
data DescribeCoipPoolsResponse = DescribeCoipPoolsResponse' {
- coipPools :: Maybe [CoipPool]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeCoipPoolsResponse :: Int -> DescribeCoipPoolsResponse
describeCoipPoolsResponse_coipPools :: Lens' DescribeCoipPoolsResponse (Maybe [CoipPool])
describeCoipPoolsResponse_nextToken :: Lens' DescribeCoipPoolsResponse (Maybe Text)
describeCoipPoolsResponse_httpStatus :: Lens' DescribeCoipPoolsResponse Int

Creating a Request

data DescribeCoipPools Source #

See: newDescribeCoipPools smart constructor.

Constructors

DescribeCoipPools'

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.
- coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
- coip-pool.pool-id - The ID of the address pool.
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 address pools.

Instances

Instances details

ToHeaders DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods toHeaders :: DescribeCoipPools -> [Header] #
ToPath DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods toPath :: DescribeCoipPools -> ByteString #
ToQuery DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods toQuery :: DescribeCoipPools -> QueryString #
AWSPager DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods page :: DescribeCoipPools -> AWSResponse DescribeCoipPools -> Maybe DescribeCoipPools #
AWSRequest DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Associated Types type AWSResponse DescribeCoipPools # Methods request :: (Service -> Service) -> DescribeCoipPools -> Request DescribeCoipPools # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCoipPools -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCoipPools))) #
Generic DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Associated Types type Rep DescribeCoipPools :: Type -> Type # Methods from :: DescribeCoipPools -> Rep DescribeCoipPools x # to :: Rep DescribeCoipPools x -> DescribeCoipPools #
Read DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods readsPrec :: Int -> ReadS DescribeCoipPools # readList :: ReadS [DescribeCoipPools] # readPrec :: ReadPrec DescribeCoipPools # readListPrec :: ReadPrec [DescribeCoipPools] #
Show DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods showsPrec :: Int -> DescribeCoipPools -> ShowS # show :: DescribeCoipPools -> String # showList :: [DescribeCoipPools] -> ShowS #
NFData DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods rnf :: DescribeCoipPools -> () #
Eq DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods (==) :: DescribeCoipPools -> DescribeCoipPools -> Bool # (/=) :: DescribeCoipPools -> DescribeCoipPools -> Bool #
Hashable DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods hashWithSalt :: Int -> DescribeCoipPools -> Int # hash :: DescribeCoipPools -> Int #
type AWSResponse DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools type AWSResponse DescribeCoipPools = DescribeCoipPoolsResponse
type Rep DescribeCoipPools Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools type Rep DescribeCoipPools = D1 ('MetaData "DescribeCoipPools" "Amazonka.EC2.DescribeCoipPools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeCoipPools'" '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]))))))

newDescribeCoipPools :: DescribeCoipPools Source #

Create a value of DescribeCoipPools 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:DescribeCoipPools', describeCoipPools_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:DescribeCoipPools', describeCoipPools_filters - One or more filters.

coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.

$sel:maxResults:DescribeCoipPools', describeCoipPools_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.

DescribeCoipPools, describeCoipPools_nextToken - The token for the next page of results.

$sel:poolIds:DescribeCoipPools', describeCoipPools_poolIds - The IDs of the address pools.

Request Lenses

describeCoipPools_dryRun :: Lens' DescribeCoipPools (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.

describeCoipPools_filters :: Lens' DescribeCoipPools (Maybe [Filter]) Source #

One or more filters.

coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.

describeCoipPools_maxResults :: Lens' DescribeCoipPools (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.

describeCoipPools_nextToken :: Lens' DescribeCoipPools (Maybe Text) Source #

The token for the next page of results.

describeCoipPools_poolIds :: Lens' DescribeCoipPools (Maybe [Text]) Source #

The IDs of the address pools.

Destructuring the Response

data DescribeCoipPoolsResponse Source #

See: newDescribeCoipPoolsResponse smart constructor.

Constructors

DescribeCoipPoolsResponse'
Fields coipPools :: Maybe [CoipPool] Information about the 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 DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Associated Types type Rep DescribeCoipPoolsResponse :: Type -> Type # Methods from :: DescribeCoipPoolsResponse -> Rep DescribeCoipPoolsResponse x # to :: Rep DescribeCoipPoolsResponse x -> DescribeCoipPoolsResponse #
Read DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods readsPrec :: Int -> ReadS DescribeCoipPoolsResponse # readList :: ReadS [DescribeCoipPoolsResponse] # readPrec :: ReadPrec DescribeCoipPoolsResponse # readListPrec :: ReadPrec [DescribeCoipPoolsResponse] #
Show DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods showsPrec :: Int -> DescribeCoipPoolsResponse -> ShowS # show :: DescribeCoipPoolsResponse -> String # showList :: [DescribeCoipPoolsResponse] -> ShowS #
NFData DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods rnf :: DescribeCoipPoolsResponse -> () #
Eq DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools Methods (==) :: DescribeCoipPoolsResponse -> DescribeCoipPoolsResponse -> Bool # (/=) :: DescribeCoipPoolsResponse -> DescribeCoipPoolsResponse -> Bool #
type Rep DescribeCoipPoolsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeCoipPools type Rep DescribeCoipPoolsResponse = D1 ('MetaData "DescribeCoipPoolsResponse" "Amazonka.EC2.DescribeCoipPools" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeCoipPoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "coipPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CoipPool])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCoipPoolsResponse Source #

Arguments

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

Create a value of DescribeCoipPoolsResponse 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:coipPools:DescribeCoipPoolsResponse', describeCoipPoolsResponse_coipPools - Information about the address pools.

DescribeCoipPools, describeCoipPoolsResponse_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:DescribeCoipPoolsResponse', describeCoipPoolsResponse_httpStatus - The response's http status code.

Response Lenses

describeCoipPoolsResponse_coipPools :: Lens' DescribeCoipPoolsResponse (Maybe [CoipPool]) Source #

Information about the address pools.

describeCoipPoolsResponse_nextToken :: Lens' DescribeCoipPoolsResponse (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.

describeCoipPoolsResponse_httpStatus :: Lens' DescribeCoipPoolsResponse Int Source #

The response's http status code.