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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

This operation returns paginated results.

Creating a Request

data DescribeByoipCidrs Source #

See: newDescribeByoipCidrs smart constructor.

Constructors

DescribeByoipCidrs'

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.
nextToken :: Maybe Text
The token for the next page of results.
maxResults :: 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.

Instances

Instances details

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

newDescribeByoipCidrs Source #

Arguments

:: Natural	`$sel:maxResults:DescribeByoipCidrs'`
-> DescribeByoipCidrs

Create a value of DescribeByoipCidrs 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:DescribeByoipCidrs', describeByoipCidrs_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.

DescribeByoipCidrs, describeByoipCidrs_nextToken - The token for the next page of results.

$sel:maxResults:DescribeByoipCidrs', describeByoipCidrs_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.

Request Lenses

describeByoipCidrs_dryRun :: Lens' DescribeByoipCidrs (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.

describeByoipCidrs_nextToken :: Lens' DescribeByoipCidrs (Maybe Text) Source #

The token for the next page of results.

describeByoipCidrs_maxResults :: Lens' DescribeByoipCidrs 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.

Destructuring the Response

data DescribeByoipCidrsResponse Source #

See: newDescribeByoipCidrsResponse smart constructor.

Constructors

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

newDescribeByoipCidrsResponse Source #

Arguments

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

Create a value of DescribeByoipCidrsResponse 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:byoipCidrs:DescribeByoipCidrsResponse', describeByoipCidrsResponse_byoipCidrs - Information about your address ranges.

DescribeByoipCidrs, describeByoipCidrsResponse_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:DescribeByoipCidrsResponse', describeByoipCidrsResponse_httpStatus - The response's http status code.

Response Lenses

describeByoipCidrsResponse_byoipCidrs :: Lens' DescribeByoipCidrsResponse (Maybe [ByoipCidr]) Source #

Information about your address ranges.

describeByoipCidrsResponse_nextToken :: Lens' DescribeByoipCidrsResponse (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.

describeByoipCidrsResponse_httpStatus :: Lens' DescribeByoipCidrsResponse Int Source #

The response's http status code.