Struct aws_sdk_appconfigdata::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS AppConfig Data
Client for invoking operations on AWS AppConfig Data. Each operation on AWS AppConfig Data 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_appconfigdata::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_appconfigdata::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 GetLatestConfiguration
operation has
a Client::get_latest_configuration
, 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_latest_configuration()
.configuration_token("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_latest_configuration(&self) -> GetLatestConfigurationFluentBuilder
pub fn get_latest_configuration(&self) -> GetLatestConfigurationFluentBuilder
Constructs a fluent builder for the GetLatestConfiguration
operation.
- The fluent builder is configurable:
configuration_token(impl Into<String>)
/set_configuration_token(Option<String>)
:
required: trueToken describing the current state of the configuration session. To obtain a token, first call the
StartConfigurationSession
API. Note that every call toGetLatestConfiguration
will return a newConfigurationToken
(NextPollConfigurationToken
in the response) and must be provided to subsequentGetLatestConfiguration
API calls.This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a
GetLatestConfiguration
call uses an expired token, the system returnsBadRequestException
.
- On success, responds with
GetLatestConfigurationOutput
with field(s):next_poll_configuration_token(Option<String>)
:The latest token describing the current state of the configuration session. This must be provided to the next call to
GetLatestConfiguration.
This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a
GetLatestConfiguration
call uses an expired token, the system returnsBadRequestException
.next_poll_interval_in_seconds(i32)
:The amount of time the client should wait before polling for configuration updates again. Use
RequiredMinimumPollIntervalInSeconds
to set the desired poll interval.content_type(Option<String>)
:A standard MIME type describing the format of the configuration content.
configuration(Option<Blob>)
:The data of the configuration. This may be empty if the client already has the latest version of configuration.
version_label(Option<String>)
:The user-defined label for the AppConfig hosted configuration version. This attribute doesn’t apply if the configuration is not from an AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.
- On failure, responds with
SdkError<GetLatestConfigurationError>
source§impl Client
impl Client
sourcepub fn start_configuration_session(
&self
) -> StartConfigurationSessionFluentBuilder
pub fn start_configuration_session( &self ) -> StartConfigurationSessionFluentBuilder
Constructs a fluent builder for the StartConfigurationSession
operation.
- The fluent builder is configurable:
application_identifier(impl Into<String>)
/set_application_identifier(Option<String>)
:
required: trueThe application ID or the application name.
environment_identifier(impl Into<String>)
/set_environment_identifier(Option<String>)
:
required: trueThe environment ID or the environment name.
configuration_profile_identifier(impl Into<String>)
/set_configuration_profile_identifier(Option<String>)
:
required: trueThe configuration profile ID or the configuration profile name.
required_minimum_poll_interval_in_seconds(i32)
/set_required_minimum_poll_interval_in_seconds(Option<i32>)
:
required: falseSets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that established the session can’t call
GetLatestConfiguration
more frequently than every 60 seconds.
- On success, responds with
StartConfigurationSessionOutput
with field(s):initial_configuration_token(Option<String>)
:Token encapsulating state about the configuration session. Provide this token to the
GetLatestConfiguration
API to retrieve configuration data.This token should only be used once in your first call to
GetLatestConfiguration
. You must use the new token in theGetLatestConfiguration
response (NextPollConfigurationToken
) in each subsequent call toGetLatestConfiguration
.The
InitialConfigurationToken
andNextPollConfigurationToken
should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If aGetLatestConfiguration
call uses an expired token, the system returnsBadRequestException
.
- On failure, responds with
SdkError<StartConfigurationSessionError>
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