reboot_instances `async` ¶

reboot_instances(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    instance_ids: Optional[InstanceIdStringList] = None,
    dry_run: Optional[Boolean] = None,
) -> None

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.

Parameters:

instance_ids (Optional[InstanceIdStringList], default: None ) –

The instance IDs.
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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To reboot an EC2 instance This example reboots the specified EC2 instance.

>>> await client.reboot_instances(instance_ids=['i-1234567890abcdef5'])

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def reboot_instances(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    instance_ids: Optional[
        "capo_ec2.types.instance_id_string_list.InstanceIdStringList"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> None:
    """<p>Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.</p> <p>If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.</p> <p>For more information about troubleshooting, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html">Troubleshoot an unreachable instance</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        instance_ids: <p>The instance IDs.</p>
        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>

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

    Examples:
        To reboot an EC2 instance
        This example reboots the specified EC2 instance.

        >>> await client.reboot_instances(instance_ids=['i-1234567890abcdef5'])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.reboot_instances_request.RebootInstancesRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.reboot_instances

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.reboot_instances.async_reboot_instances(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RebootInstances")
    )
    input_: capo_ec2.types.reboot_instances_request.RebootInstancesRequest = {}
    if instance_ids is not None:
        input_["instance_ids"] = instance_ids
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

reboot_instances async ¶

reboot_instances `async` ¶