pub struct ShutdownGateway { /* private fields */ }
Expand description
Fluent builder constructing a request to ShutdownGateway
.
Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.
The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.
If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.
After the gateway is shutdown, you cannot call any other API except StartGateway
, DescribeGatewayInformation
, and ListGateways
. For more information, see ActivateGateway
. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.
When you make a shutdown request, you will get a 200 OK
success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation
API to check the status. For more information, see ActivateGateway
.
If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway
) to no longer pay software charges associated with the gateway.
Implementations
sourceimpl ShutdownGateway
impl ShutdownGateway
sourcepub async fn send(
self
) -> Result<ShutdownGatewayOutput, SdkError<ShutdownGatewayError>>
pub async fn send(
self
) -> Result<ShutdownGatewayOutput, SdkError<ShutdownGatewayError>>
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, which can be set when configuring the client.
sourcepub fn gateway_arn(self, input: impl Into<String>) -> Self
pub fn gateway_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web Services Region.
sourcepub fn set_gateway_arn(self, input: Option<String>) -> Self
pub fn set_gateway_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
operation to return a list of gateways for your account and Amazon Web Services Region.
Trait Implementations
sourceimpl Clone for ShutdownGateway
impl Clone for ShutdownGateway
sourcefn clone(&self) -> ShutdownGateway
fn clone(&self) -> ShutdownGateway
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ShutdownGateway
impl Send for ShutdownGateway
impl Sync for ShutdownGateway
impl Unpin for ShutdownGateway
impl !UnwindSafe for ShutdownGateway
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more