Skip to content

modify_instance_capacity_reservation_attributes

modify_instance_capacity_reservation_attributes(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_id: Optional[InstanceId] = None,
    capacity_reservation_specification: Optional[
        CapacityReservationSpecification
    ] = None,
    dry_run: Optional[Boolean] = None,
) -> ModifyInstanceCapacityReservationAttributesResult

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, run in On-Demand Instance capacity, or only run in a Capacity Reservation.

Parameters:

  • instance_id (Optional[InstanceId], default: None ) –

    The ID of the instance to be modified.

  • capacity_reservation_specification (Optional[CapacityReservationSpecification], default: None ) –

    Information about the Capacity Reservation targeting option.

  • dry_run (Optional[Boolean], default: None ) –

    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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def modify_instance_capacity_reservation_attributes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    instance_id: Optional["capo_ec2.types.instance_id.InstanceId"] = None,
    capacity_reservation_specification: Optional[
        "capo_ec2.types.capacity_reservation_specification.CapacityReservationSpecification"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.modify_instance_capacity_reservation_attributes_result.ModifyInstanceCapacityReservationAttributesResult":
    """<p>Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any <code>open</code> Capacity Reservation with matching attributes, run in On-Demand Instance capacity, or only run in a Capacity Reservation.</p>

    Args:
        instance_id: <p>The ID of the instance to be modified.</p>
        capacity_reservation_specification: <p>Information about the Capacity Reservation targeting option.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_instance_capacity_reservation_attributes_request.ModifyInstanceCapacityReservationAttributesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_instance_capacity_reservation_attributes_result.ModifyInstanceCapacityReservationAttributesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_instance_capacity_reservation_attributes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_instance_capacity_reservation_attributes.modify_instance_capacity_reservation_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ModifyInstanceCapacityReservationAttributes"),
    )
    input_: capo_ec2.types.modify_instance_capacity_reservation_attributes_request.ModifyInstanceCapacityReservationAttributesRequest = {}
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if capacity_reservation_specification is not None:
        input_["capacity_reservation_specification"] = (
            capacity_reservation_specification
        )
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output