amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.CancelCapacityReservation

Description

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

Synopsis

Creating a Request

data CancelCapacityReservation Source #

See: newCancelCapacityReservation smart constructor.

Constructors

CancelCapacityReservation' 

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.

  • capacityReservationId :: Text

    The ID of the Capacity Reservation to be cancelled.

Instances

Instances details
ToHeaders CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

ToPath CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

ToQuery CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

AWSRequest CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Generic CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Associated Types

type Rep CancelCapacityReservation :: Type -> Type #

Read CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Show CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

NFData CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Eq CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Hashable CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

type AWSResponse CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

type Rep CancelCapacityReservation Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

type Rep CancelCapacityReservation = D1 ('MetaData "CancelCapacityReservation" "Amazonka.EC2.CancelCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CancelCapacityReservation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "capacityReservationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelCapacityReservation Source #

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

CancelCapacityReservation, cancelCapacityReservation_capacityReservationId - The ID of the Capacity Reservation to be cancelled.

Request Lenses

cancelCapacityReservation_dryRun :: Lens' CancelCapacityReservation (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.

cancelCapacityReservation_capacityReservationId :: Lens' CancelCapacityReservation Text Source #

The ID of the Capacity Reservation to be cancelled.

Destructuring the Response

data CancelCapacityReservationResponse Source #

See: newCancelCapacityReservationResponse smart constructor.

Constructors

CancelCapacityReservationResponse' 

Fields

Instances

Instances details
Generic CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Associated Types

type Rep CancelCapacityReservationResponse :: Type -> Type #

Read CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Show CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

NFData CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

Eq CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

type Rep CancelCapacityReservationResponse Source # 
Instance details

Defined in Amazonka.EC2.CancelCapacityReservation

type Rep CancelCapacityReservationResponse = D1 ('MetaData "CancelCapacityReservationResponse" "Amazonka.EC2.CancelCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CancelCapacityReservationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "return'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelCapacityReservationResponse Source #

Create a value of CancelCapacityReservationResponse 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:return':CancelCapacityReservationResponse', cancelCapacityReservationResponse_return - Returns true if the request succeeds; otherwise, it returns an error.

$sel:httpStatus:CancelCapacityReservationResponse', cancelCapacityReservationResponse_httpStatus - The response's http status code.

Response Lenses

cancelCapacityReservationResponse_return :: Lens' CancelCapacityReservationResponse (Maybe Bool) Source #

Returns true if the request succeeds; otherwise, it returns an error.