Skip to content

modify_instance_credit_specification

modify_instance_credit_specification(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    client_token: Optional[String] = None,
    instance_credit_specifications: Optional[
        InstanceCreditSpecificationListRequest
    ] = None,
) -> ModifyInstanceCreditSpecificationResult

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Parameters:

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

    Checks whether you have the required permissions for the operation, 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.

  • client_token (Optional[String], default: None ) –

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

  • instance_credit_specifications (Optional[InstanceCreditSpecificationListRequest], default: None ) –

    Information about the credit option for CPU usage.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def modify_instance_credit_specification(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    instance_credit_specifications: Optional[
        "capo_ec2.types.instance_credit_specification_list_request.InstanceCreditSpecificationListRequest"
    ] = None,
) -> "capo_ec2.types.modify_instance_credit_specification_result.ModifyInstanceCreditSpecificationResult":
    """<p>Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are <code>standard</code> and <code>unlimited</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html">Burstable performance instances</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the operation, 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>
        client_token: <p>A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>.</p>
        instance_credit_specifications: <p>Information about the credit option for CPU usage.</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_credit_specification_request.ModifyInstanceCreditSpecificationRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_instance_credit_specification_result.ModifyInstanceCreditSpecificationResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_instance_credit_specification

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyInstanceCreditSpecification")
    )
    input_: capo_ec2.types.modify_instance_credit_specification_request.ModifyInstanceCreditSpecificationRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if client_token is not None:
        input_["client_token"] = client_token
    if instance_credit_specifications is not None:
        input_["instance_credit_specifications"] = instance_credit_specifications

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