aws_sdk_workspaces/operation/terminate_workspaces/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::terminate_workspaces::_terminate_workspaces_output::TerminateWorkspacesOutputBuilder;
3
4pub use crate::operation::terminate_workspaces::_terminate_workspaces_input::TerminateWorkspacesInputBuilder;
5
6impl crate::operation::terminate_workspaces::builders::TerminateWorkspacesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::terminate_workspaces::TerminateWorkspacesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.terminate_workspaces();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `TerminateWorkspaces`.
24///
25/// <p>Terminates the specified WorkSpaces.</p><important>
26/// <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 ServicesSupport before terminating the WorkSpace.</p>
27/// </important>
28/// <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p>
29/// <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>
30/// <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>
31/// <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>
32/// </note>
33#[derive(::std::clone::Clone, ::std::fmt::Debug)]
34pub struct TerminateWorkspacesFluentBuilder {
35    handle: ::std::sync::Arc<crate::client::Handle>,
36    inner: crate::operation::terminate_workspaces::builders::TerminateWorkspacesInputBuilder,
37    config_override: ::std::option::Option<crate::config::Builder>,
38}
39impl
40    crate::client::customize::internal::CustomizableSend<
41        crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
42        crate::operation::terminate_workspaces::TerminateWorkspacesError,
43    > for TerminateWorkspacesFluentBuilder
44{
45    fn send(
46        self,
47        config_override: crate::config::Builder,
48    ) -> crate::client::customize::internal::BoxFuture<
49        crate::client::customize::internal::SendResult<
50            crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
51            crate::operation::terminate_workspaces::TerminateWorkspacesError,
52        >,
53    > {
54        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
55    }
56}
57impl TerminateWorkspacesFluentBuilder {
58    /// Creates a new `TerminateWorkspacesFluentBuilder`.
59    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
60        Self {
61            handle,
62            inner: ::std::default::Default::default(),
63            config_override: ::std::option::Option::None,
64        }
65    }
66    /// Access the TerminateWorkspaces as a reference.
67    pub fn as_input(&self) -> &crate::operation::terminate_workspaces::builders::TerminateWorkspacesInputBuilder {
68        &self.inner
69    }
70    /// Sends the request and returns the response.
71    ///
72    /// If an error occurs, an `SdkError` will be returned with additional details that
73    /// can be matched against.
74    ///
75    /// By default, any retryable failures will be retried twice. Retry behavior
76    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
77    /// set when configuring the client.
78    pub async fn send(
79        self,
80    ) -> ::std::result::Result<
81        crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
82        ::aws_smithy_runtime_api::client::result::SdkError<
83            crate::operation::terminate_workspaces::TerminateWorkspacesError,
84            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
85        >,
86    > {
87        let input = self
88            .inner
89            .build()
90            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
91        let runtime_plugins = crate::operation::terminate_workspaces::TerminateWorkspaces::operation_runtime_plugins(
92            self.handle.runtime_plugins.clone(),
93            &self.handle.conf,
94            self.config_override,
95        );
96        crate::operation::terminate_workspaces::TerminateWorkspaces::orchestrate(&runtime_plugins, input).await
97    }
98
99    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
100    pub fn customize(
101        self,
102    ) -> crate::client::customize::CustomizableOperation<
103        crate::operation::terminate_workspaces::TerminateWorkspacesOutput,
104        crate::operation::terminate_workspaces::TerminateWorkspacesError,
105        Self,
106    > {
107        crate::client::customize::CustomizableOperation::new(self)
108    }
109    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
110        self.set_config_override(::std::option::Option::Some(config_override.into()));
111        self
112    }
113
114    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
115        self.config_override = config_override;
116        self
117    }
118    ///
119    /// Appends an item to `TerminateWorkspaceRequests`.
120    ///
121    /// To override the contents of this collection use [`set_terminate_workspace_requests`](Self::set_terminate_workspace_requests).
122    ///
123    /// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
124    pub fn terminate_workspace_requests(mut self, input: crate::types::TerminateRequest) -> Self {
125        self.inner = self.inner.terminate_workspace_requests(input);
126        self
127    }
128    /// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
129    pub fn set_terminate_workspace_requests(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TerminateRequest>>) -> Self {
130        self.inner = self.inner.set_terminate_workspace_requests(input);
131        self
132    }
133    /// <p>The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.</p>
134    pub fn get_terminate_workspace_requests(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TerminateRequest>> {
135        self.inner.get_terminate_workspace_requests()
136    }
137}
aws_sdk_workspaces/operation/terminate_workspaces/builders.rs

aws_sdk_workspaces/operation/terminate_workspaces/
builders.rs
