modify_capacity_reservation

modify_capacity_reservation(**kwargs)

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.

See also: AWS API Documentation

Request Syntax

response = client.modify_capacity_reservation(
    CapacityReservationId='string',
    InstanceCount=123,
    EndDate=datetime(2015, 1, 1),
    EndDateType='unlimited'|'limited',
    Accept=True|False,
    DryRun=True|False,
    AdditionalInfo='string'
)

Parameters

• CapacityReservationId (string) --

  [REQUIRED]

  The ID of the Capacity Reservation.

• InstanceCount (integer) -- The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.
• EndDate (datetime) --

  The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

  The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

  You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .

• EndDateType (string) --

  Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited .
  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited .
• Accept (boolean) -- Reserved. Capacity Reservations you have created are accepted by default.
• DryRun (boolean) -- 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 .
• AdditionalInfo (string) -- Reserved for future use.

Return type

dict

Returns

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) --

  • Return (boolean) --

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