aws_sdk_ec2/client/terminate_instances.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`TerminateInstances`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`instance_ids(impl Into<String>)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::instance_ids) / [`set_instance_ids(Option<Vec::<String>>)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::set_instance_ids):<br>required: **true**<br><p>The IDs of the instances.</p> <p>Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.</p><br>
7 /// - [`force(bool)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::set_force):<br>required: **false**<br><p>Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.</p><br>
8 /// - [`skip_os_shutdown(bool)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::skip_os_shutdown) / [`set_skip_os_shutdown(Option<bool>)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::set_skip_os_shutdown):<br>required: **false**<br><p>Specifies whether to bypass the graceful OS shutdown process when the instance is terminated.</p> <p>Default: <code>false</code></p><br>
9 /// - [`dry_run(bool)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
10 /// - On success, responds with [`TerminateInstancesOutput`](crate::operation::terminate_instances::TerminateInstancesOutput) with field(s):
11 /// - [`terminating_instances(Option<Vec::<InstanceStateChange>>)`](crate::operation::terminate_instances::TerminateInstancesOutput::terminating_instances): <p>Information about the terminated instances.</p>
12 /// - On failure, responds with [`SdkError<TerminateInstancesError>`](crate::operation::terminate_instances::TerminateInstancesError)
13 pub fn terminate_instances(&self) -> crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder {
14 crate::operation::terminate_instances::builders::TerminateInstancesFluentBuilder::new(self.handle.clone())
15 }
16}