Struct aws_sdk_route53recoverycluster::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Route53 Recovery Cluster
Client for invoking operations on Route53 Recovery Cluster. Each operation on Route53 Recovery Cluster is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_route53recoverycluster::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_route53recoverycluster::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the GetRoutingControlState
operation has
a Client::get_routing_control_state
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.get_routing_control_state()
.routing_control_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn get_routing_control_state(&self) -> GetRoutingControlStateFluentBuilder
pub fn get_routing_control_state(&self) -> GetRoutingControlStateFluentBuilder
Constructs a fluent builder for the GetRoutingControlState
operation.
- The fluent builder is configurable:
routing_control_arn(impl Into<String>)
/set_routing_control_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the routing control that you want to get the state for.
- On success, responds with
GetRoutingControlStateOutput
with field(s):routing_control_arn(String)
:The Amazon Resource Name (ARN) of the response.
routing_control_state(RoutingControlState)
:The state of the routing control.
routing_control_name(Option<String>)
:The routing control name.
- On failure, responds with
SdkError<GetRoutingControlStateError>
source§impl Client
impl Client
sourcepub fn list_routing_controls(&self) -> ListRoutingControlsFluentBuilder
pub fn list_routing_controls(&self) -> ListRoutingControlsFluentBuilder
Constructs a fluent builder for the ListRoutingControls
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
control_panel_arn(impl Into<String>)
/set_control_panel_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the control panel of the routing controls to list.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of results. You receive this token from a previous call.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of routing controls objects that you want to return with this call. The default value is 500.
- On success, responds with
ListRoutingControlsOutput
with field(s):routing_controls(Vec::<RoutingControl>)
:The list of routing controls.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListRoutingControlsError>
source§impl Client
impl Client
sourcepub fn update_routing_control_state(
&self
) -> UpdateRoutingControlStateFluentBuilder
pub fn update_routing_control_state( &self ) -> UpdateRoutingControlStateFluentBuilder
Constructs a fluent builder for the UpdateRoutingControlState
operation.
- The fluent builder is configurable:
routing_control_arn(impl Into<String>)
/set_routing_control_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the routing control that you want to update the state for.
routing_control_state(RoutingControlState)
/set_routing_control_state(Option<RoutingControlState>)
:
required: trueThe state of the routing control. You can set the value to ON or OFF.
safety_rules_to_override(impl Into<String>)
/set_safety_rules_to_override(Option<Vec::<String>>)
:
required: falseThe Amazon Resource Names (ARNs) for the safety rules that you want to override when you’re updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
- On success, responds with
UpdateRoutingControlStateOutput
- On failure, responds with
SdkError<UpdateRoutingControlStateError>
source§impl Client
impl Client
sourcepub fn update_routing_control_states(
&self
) -> UpdateRoutingControlStatesFluentBuilder
pub fn update_routing_control_states( &self ) -> UpdateRoutingControlStatesFluentBuilder
Constructs a fluent builder for the UpdateRoutingControlStates
operation.
- The fluent builder is configurable:
update_routing_control_state_entries(UpdateRoutingControlStateEntry)
/set_update_routing_control_state_entries(Option<Vec::<UpdateRoutingControlStateEntry>>)
:
required: trueA set of routing control entries that you want to update.
safety_rules_to_override(impl Into<String>)
/set_safety_rules_to_override(Option<Vec::<String>>)
:
required: falseThe Amazon Resource Names (ARNs) for the safety rules that you want to override when you’re updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
- On success, responds with
UpdateRoutingControlStatesOutput
- On failure, responds with
SdkError<UpdateRoutingControlStatesError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more