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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

This operation returns paginated results.

Synopsis

data DescribeIpams = DescribeIpams' {
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- ipamIds :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeIpams :: DescribeIpams
describeIpams_dryRun :: Lens' DescribeIpams (Maybe Bool)
describeIpams_filters :: Lens' DescribeIpams (Maybe [Filter])
describeIpams_ipamIds :: Lens' DescribeIpams (Maybe [Text])
describeIpams_maxResults :: Lens' DescribeIpams (Maybe Natural)
describeIpams_nextToken :: Lens' DescribeIpams (Maybe Text)
data DescribeIpamsResponse = DescribeIpamsResponse' {
- ipams :: Maybe [Ipam]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeIpamsResponse :: Int -> DescribeIpamsResponse
describeIpamsResponse_ipams :: Lens' DescribeIpamsResponse (Maybe [Ipam])
describeIpamsResponse_nextToken :: Lens' DescribeIpamsResponse (Maybe Text)
describeIpamsResponse_httpStatus :: Lens' DescribeIpamsResponse Int

Creating a Request

data DescribeIpams Source #

See: newDescribeIpams smart constructor.

Constructors

DescribeIpams'

Fields

dryRun :: Maybe Bool
A check for 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 for the request. For more information about filtering, see Filtering CLI output.
ipamIds :: Maybe [Text]
The IDs of the IPAMs you want information on.
maxResults :: Maybe Natural
The maximum number of results to return in the request.
nextToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

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

newDescribeIpams :: DescribeIpams Source #

Create a value of DescribeIpams 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:DescribeIpams', describeIpams_dryRun - A check for 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:DescribeIpams', describeIpams_filters - One or more filters for the request. For more information about filtering, see Filtering CLI output.

$sel:ipamIds:DescribeIpams', describeIpams_ipamIds - The IDs of the IPAMs you want information on.

$sel:maxResults:DescribeIpams', describeIpams_maxResults - The maximum number of results to return in the request.

DescribeIpams, describeIpams_nextToken - The token for the next page of results.

Request Lenses

describeIpams_dryRun :: Lens' DescribeIpams (Maybe Bool) Source #

A check for 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.

describeIpams_filters :: Lens' DescribeIpams (Maybe [Filter]) Source #

One or more filters for the request. For more information about filtering, see Filtering CLI output.

describeIpams_ipamIds :: Lens' DescribeIpams (Maybe [Text]) Source #

The IDs of the IPAMs you want information on.

describeIpams_maxResults :: Lens' DescribeIpams (Maybe Natural) Source #

The maximum number of results to return in the request.

describeIpams_nextToken :: Lens' DescribeIpams (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeIpamsResponse Source #

See: newDescribeIpamsResponse smart constructor.

Constructors

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

newDescribeIpamsResponse Source #

Arguments

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

Create a value of DescribeIpamsResponse 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:ipams:DescribeIpamsResponse', describeIpamsResponse_ipams - Information about the IPAMs.

DescribeIpams, describeIpamsResponse_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:DescribeIpamsResponse', describeIpamsResponse_httpStatus - The response's http status code.

Response Lenses

describeIpamsResponse_ipams :: Lens' DescribeIpamsResponse (Maybe [Ipam]) Source #

Information about the IPAMs.

describeIpamsResponse_nextToken :: Lens' DescribeIpamsResponse (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.

describeIpamsResponse_httpStatus :: Lens' DescribeIpamsResponse Int Source #

The response's http status code.