Skip to content

reboot_instances

Operation

reboot_instances

reboot_instances(request: RebootInstancesInput | RebootInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RebootInstancesInputDict]) -> RebootInstancesOutput

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:

Name Type Description Default
request RebootInstancesInput | RebootInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RebootInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RebootInstancesOutput

An instance of RebootInstancesOutput.

reboot_instances async

reboot_instances(request: RebootInstancesInput | RebootInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RebootInstancesInputDict]) -> RebootInstancesOutput

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:

Name Type Description Default
request RebootInstancesInput | RebootInstancesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RebootInstancesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RebootInstancesOutput

An instance of RebootInstancesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

RebootInstancesInputDict

Bases: TypedDict

Dictionary form of RebootInstancesInput.

Attributes

dry_run instance-attribute
dry_run: bool | 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.

instance_ids instance-attribute
instance_ids: Required[Sequence[str]]

The instance IDs.

RebootInstancesInput dataclass

Bases: _SerdeShape

Dataclass for RebootInstancesInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | 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.

instance_ids class-attribute instance-attribute
instance_ids: list[str] | None = ...

The instance IDs.

Output

RebootInstancesOutput dataclass

Bases: _SerdeShape

Dataclass for RebootInstancesOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.