EC2 / Client / modify_capacity_reservation

modify_capacity_reservation

EC2.Client.modify_capacity_reservation(**kwargs)

Modifies a Capacity Reservation’s capacity, instance eligibility, and the conditions under which it is to be released. You can’t modify a Capacity Reservation’s instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. 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. For more information, see Modify an active Capacity Reservation.

The allowed modifications depend on the state of the Capacity Reservation:

  • assessing or scheduled state - You can modify the tags only.

  • pending state - You can’t modify the Capacity Reservation in any way.

  • active state but still within the commitment duration - You can’t decrease the instance count or set an end date that is within the commitment duration. All other modifications are allowed.

  • active state with no commitment duration or elapsed commitment duration - All modifications are allowed.

  • expired, cancelled, unsupported, or failed state - You can’t modify the Capacity Reservation in any way.

For a future-dated Capacity Reservation that has not yet been delivered, pushing out the start date requires a quote generated by CreateCapacityReservationDateChangeQuote. For more information, see Modify an active Capacity Reservation in the Amazon EC2 User Guide.

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',
    InstanceMatchCriteria='open'|'targeted',
    AcceptModificationTerms=True|False,
    StartDate=datetime(2015, 1, 1),
    QuoteId='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.

  • InstanceMatchCriteria (string) –

    The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

    To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

  • AcceptModificationTerms (boolean) – Indicates that you accept the modification terms of the quote identified by QuoteId. To apply a quoted modification, set this parameter to true.

  • StartDate (datetime) – The new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). Applies to future-dated Capacity Reservations only. Requires a quote from CreateCapacityReservationDateChangeQuote; pass the quote ID in QuoteId with AcceptModificationTerms set to true.

  • QuoteId (string) – The ID of the quote that describes the modification you want to apply. Generate a quote by using CreateCapacityReservationDateChangeQuote. The quote must be in the active state, and each quote can be used only once.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False,
    'AdjustmentStatus': 'requested'|'applied'|'rejected',
    'AdjustmentDetails': {
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'CommitmentEndDate': datetime(2015, 1, 1),
        'EndDateType': 'string',
        'CommitmentDuration': 123
    }
}

Response Structure

  • (dict) –

    • Return (boolean) –

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

    • AdjustmentStatus (string) –

      The status of the requested modification. For a description of each possible value, see the adjustmentStatus field of the CapacityReservation data type.

    • AdjustmentDetails (dict) –

      The configuration that the Capacity Reservation will have after the adjustment is applied.

      • StartDate (datetime) –

        The start date that the Capacity Reservation will have after the adjustment.

      • EndDate (datetime) –

        The end date that the Capacity Reservation will have after the adjustment.

      • CommitmentEndDate (datetime) –

        The date and time at which the commitment duration will expire after the adjustment.

      • EndDateType (string) –

        Indicates the way in which the Capacity Reservation will end after the adjustment. Possible values are:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

        • limited - The Capacity Reservation expires automatically at the date and time given by endDate.

      • CommitmentDuration (integer) –

        The commitment duration, in seconds, that the Capacity Reservation will have after the adjustment.