1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::terminate_workspaces::_terminate_workspaces_output::TerminateWorkspacesOutputBuilder;
pub use crate::operation::terminate_workspaces::_terminate_workspaces_input::TerminateWorkspacesInputBuilder;
impl TerminateWorkspacesInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
::aws_smithy_http::result::SdkError<
crate::operation::terminate_workspaces::TerminateWorkspacesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.terminate_workspaces();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `TerminateWorkspaces`.
///
/// <p>Terminates the specified WorkSpaces.</p> <important>
/// <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.</p>
/// </important>
/// <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
/// <p>This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html"> DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.</p> <note>
/// <p>Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the <a href="http://aws.amazon.com/directoryservice/pricing/">Directory Service pricing terms</a>.</p>
/// <p>To delete empty directories, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html"> Delete the Directory for Your WorkSpaces</a>. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct TerminateWorkspacesFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::terminate_workspaces::builders::TerminateWorkspacesInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl TerminateWorkspacesFluentBuilder {
/// Creates a new `TerminateWorkspaces`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the TerminateWorkspaces as a reference.
pub fn as_input(&self) -> &crate::operation::terminate_workspaces::builders::TerminateWorkspacesInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
::aws_smithy_http::result::SdkError<
crate::operation::terminate_workspaces::TerminateWorkspacesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self.inner.build().map_err(::aws_smithy_http::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::terminate_workspaces::TerminateWorkspaces::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::terminate_workspaces::TerminateWorkspaces::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being
/// sent.
// TODO(enableNewSmithyRuntimeCleanup): Remove `async` and `Result` once we switch to orchestrator
pub async fn customize(
self,
) -> ::std::result::Result<
crate::client::customize::orchestrator::CustomizableOperation<
crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
crate::operation::terminate_workspaces::TerminateWorkspacesError,
>,
::aws_smithy_http::result::SdkError<crate::operation::terminate_workspaces::TerminateWorkspacesError>,
> {
::std::result::Result::Ok(crate::client::customize::orchestrator::CustomizableOperation {
customizable_send: ::std::boxed::Box::new(move |config_override| {
::std::boxed::Box::pin(async { self.config_override(config_override).send().await })
}),
config_override: None,
interceptors: vec![],
runtime_plugins: vec![],
})
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Appends an item to `TerminateWorkspaceRequests`.
///
/// To override the contents of this collection use [`set_terminate_workspace_requests`](Self::set_terminate_workspace_requests).
///
/// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
pub fn terminate_workspace_requests(mut self, input: crate::types::TerminateRequest) -> Self {
self.inner = self.inner.terminate_workspace_requests(input);
self
}
/// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
pub fn set_terminate_workspace_requests(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TerminateRequest>>) -> Self {
self.inner = self.inner.set_terminate_workspace_requests(input);
self
}
/// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
pub fn get_terminate_workspace_requests(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TerminateRequest>> {
self.inner.get_terminate_workspace_requests()
}
}