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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.

Synopsis

Creating a Request

data ReleaseIpamPoolAllocation Source #

See: newReleaseIpamPoolAllocation smart constructor.

Constructors

ReleaseIpamPoolAllocation'

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.
ipamPoolId :: Text
The ID of the IPAM pool which contains the allocation you want to release.
cidr :: Text
The CIDR of the allocation you want to release.
ipamPoolAllocationId :: Text
The ID of the allocation.

Instances

Instances details

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

newReleaseIpamPoolAllocation Source #

Arguments

:: Text	`ReleaseIpamPoolAllocation`
-> Text	`ReleaseIpamPoolAllocation`
-> Text	`ReleaseIpamPoolAllocation`
-> ReleaseIpamPoolAllocation

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

ReleaseIpamPoolAllocation, releaseIpamPoolAllocation_ipamPoolId - The ID of the IPAM pool which contains the allocation you want to release.

ReleaseIpamPoolAllocation, releaseIpamPoolAllocation_cidr - The CIDR of the allocation you want to release.

ReleaseIpamPoolAllocation, releaseIpamPoolAllocation_ipamPoolAllocationId - The ID of the allocation.

Request Lenses

releaseIpamPoolAllocation_dryRun :: Lens' ReleaseIpamPoolAllocation (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.

releaseIpamPoolAllocation_ipamPoolId :: Lens' ReleaseIpamPoolAllocation Text Source #

The ID of the IPAM pool which contains the allocation you want to release.

releaseIpamPoolAllocation_cidr :: Lens' ReleaseIpamPoolAllocation Text Source #

The CIDR of the allocation you want to release.

releaseIpamPoolAllocation_ipamPoolAllocationId :: Lens' ReleaseIpamPoolAllocation Text Source #

The ID of the allocation.

Destructuring the Response

data ReleaseIpamPoolAllocationResponse Source #

See: newReleaseIpamPoolAllocationResponse smart constructor.

Constructors

ReleaseIpamPoolAllocationResponse'
Fields success :: Maybe Bool Indicates if the release was successful. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newReleaseIpamPoolAllocationResponse Source #

Arguments

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

Create a value of ReleaseIpamPoolAllocationResponse 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:success:ReleaseIpamPoolAllocationResponse', releaseIpamPoolAllocationResponse_success - Indicates if the release was successful.

$sel:httpStatus:ReleaseIpamPoolAllocationResponse', releaseIpamPoolAllocationResponse_httpStatus - The response's http status code.

Response Lenses

releaseIpamPoolAllocationResponse_success :: Lens' ReleaseIpamPoolAllocationResponse (Maybe Bool) Source #

Indicates if the release was successful.

releaseIpamPoolAllocationResponse_httpStatus :: Lens' ReleaseIpamPoolAllocationResponse Int Source #

The response's http status code.