aws_sdk_mediaconnect/client/
deregister_gateway_instance.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 [`DeregisterGatewayInstance`](crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`force(bool)`](crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder::set_force):<br>required: **false**<br><p>Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.</p><br>
7    ///   - [`gateway_instance_arn(impl Into<String>)`](crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder::gateway_instance_arn) / [`set_gateway_instance_arn(Option<String>)`](crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder::set_gateway_instance_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.</p><br>
8    /// - On success, responds with [`DeregisterGatewayInstanceOutput`](crate::operation::deregister_gateway_instance::DeregisterGatewayInstanceOutput) with field(s):
9    ///   - [`gateway_instance_arn(Option<String>)`](crate::operation::deregister_gateway_instance::DeregisterGatewayInstanceOutput::gateway_instance_arn): <p>The ARN of the instance.</p>
10    ///   - [`instance_state(Option<InstanceState>)`](crate::operation::deregister_gateway_instance::DeregisterGatewayInstanceOutput::instance_state): <p>The status of the instance.</p>
11    /// - On failure, responds with [`SdkError<DeregisterGatewayInstanceError>`](crate::operation::deregister_gateway_instance::DeregisterGatewayInstanceError)
12    pub fn deregister_gateway_instance(&self) -> crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder {
13        crate::operation::deregister_gateway_instance::builders::DeregisterGatewayInstanceFluentBuilder::new(self.handle.clone())
14    }
15}