pub struct Client { /* private fields */ }Expand description
Client for Amazon Pinpoint SMS and Voice Service
Client for invoking operations on Amazon Pinpoint SMS and Voice Service. Each operation on Amazon Pinpoint SMS and Voice Service 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_pinpointsmsvoice::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 Builder 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_pinpointsmsvoice::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 CreateConfigurationSet operation has
a Client::create_configuration_set, 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.create_configuration_set()
.configuration_set_name("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 create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder
pub fn create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder
Constructs a fluent builder for the CreateConfigurationSet operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: false
The name that you want to give the configuration set.
- On success, responds with
CreateConfigurationSetOutput - On failure, responds with
SdkError<CreateConfigurationSetError>
Source§impl Client
impl Client
Sourcepub fn create_configuration_set_event_destination(
&self,
) -> CreateConfigurationSetEventDestinationFluentBuilder
pub fn create_configuration_set_event_destination( &self, ) -> CreateConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the CreateConfigurationSetEventDestination operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: true
ConfigurationSetNameevent_destination(EventDestinationDefinition)/set_event_destination(Option<EventDestinationDefinition>):
required: false
An object that defines a single event destination.event_destination_name(impl Into<String>)/set_event_destination_name(Option<String>):
required: false
A name that identifies the event destination.
- On success, responds with
CreateConfigurationSetEventDestinationOutput - On failure, responds with
SdkError<CreateConfigurationSetEventDestinationError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder
pub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder
Constructs a fluent builder for the DeleteConfigurationSet operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: true
ConfigurationSetName
- On success, responds with
DeleteConfigurationSetOutput - On failure, responds with
SdkError<DeleteConfigurationSetError>
Source§impl Client
impl Client
Sourcepub fn delete_configuration_set_event_destination(
&self,
) -> DeleteConfigurationSetEventDestinationFluentBuilder
pub fn delete_configuration_set_event_destination( &self, ) -> DeleteConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the DeleteConfigurationSetEventDestination operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: true
ConfigurationSetNameevent_destination_name(impl Into<String>)/set_event_destination_name(Option<String>):
required: true
EventDestinationName
- On success, responds with
DeleteConfigurationSetEventDestinationOutput - On failure, responds with
SdkError<DeleteConfigurationSetEventDestinationError>
Source§impl Client
impl Client
Sourcepub fn get_configuration_set_event_destinations(
&self,
) -> GetConfigurationSetEventDestinationsFluentBuilder
pub fn get_configuration_set_event_destinations( &self, ) -> GetConfigurationSetEventDestinationsFluentBuilder
Constructs a fluent builder for the GetConfigurationSetEventDestinations operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: true
ConfigurationSetName
- On success, responds with
GetConfigurationSetEventDestinationsOutputwith field(s):event_destinations(Option<Vec::<EventDestination>>): An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.
- On failure, responds with
SdkError<GetConfigurationSetEventDestinationsError>
Source§impl Client
impl Client
Sourcepub fn list_configuration_sets(&self) -> ListConfigurationSetsFluentBuilder
pub fn list_configuration_sets(&self) -> ListConfigurationSetsFluentBuilder
Constructs a fluent builder for the ListConfigurationSets operation.
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):
required: false
A token returned from a previous call to the API that indicates the position in the list of results.page_size(impl Into<String>)/set_page_size(Option<String>):
required: false
Used to specify the number of items that should be returned in the response.
- On success, responds with
ListConfigurationSetsOutputwith field(s):configuration_sets(Option<Vec::<String>>): An object that contains a list of configuration sets for your account in the current region.next_token(Option<String>): A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
- On failure, responds with
SdkError<ListConfigurationSetsError>
Source§impl Client
impl Client
Sourcepub fn send_voice_message(&self) -> SendVoiceMessageFluentBuilder
pub fn send_voice_message(&self) -> SendVoiceMessageFluentBuilder
Constructs a fluent builder for the SendVoiceMessage operation.
- The fluent builder is configurable:
caller_id(impl Into<String>)/set_caller_id(Option<String>):
required: false
The phone number that appears on recipients’ devices when they receive the message.configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: false
The name of the configuration set that you want to use to send the message.content(VoiceMessageContent)/set_content(Option<VoiceMessageContent>):
required: false
An object that contains a voice message and information about the recipient that you want to send it to.destination_phone_number(impl Into<String>)/set_destination_phone_number(Option<String>):
required: false
The phone number that you want to send the voice message to.origination_phone_number(impl Into<String>)/set_origination_phone_number(Option<String>):
required: false
The phone number that Amazon Pinpoint should use to send the voice message. This isn’t necessarily the phone number that appears on recipients’ devices when they receive the message, because you can specify a CallerId parameter in the request.
- On success, responds with
SendVoiceMessageOutputwith field(s):message_id(Option<String>): A unique identifier for the voice message.
- On failure, responds with
SdkError<SendVoiceMessageError>
Source§impl Client
impl Client
Sourcepub fn update_configuration_set_event_destination(
&self,
) -> UpdateConfigurationSetEventDestinationFluentBuilder
pub fn update_configuration_set_event_destination( &self, ) -> UpdateConfigurationSetEventDestinationFluentBuilder
Constructs a fluent builder for the UpdateConfigurationSetEventDestination operation.
- The fluent builder is configurable:
configuration_set_name(impl Into<String>)/set_configuration_set_name(Option<String>):
required: true
ConfigurationSetNameevent_destination(EventDestinationDefinition)/set_event_destination(Option<EventDestinationDefinition>):
required: false
An object that defines a single event destination.event_destination_name(impl Into<String>)/set_event_destination_name(Option<String>):
required: true
EventDestinationName
- On success, responds with
UpdateConfigurationSetEventDestinationOutput - On failure, responds with
SdkError<UpdateConfigurationSetEventDestinationError>
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis 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_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo 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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);