Struct aws_sdk_pinpointsmsvoice::Client

pub struct Client { /* private fields */ }

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 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_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

impl Client

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>

impl Client

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
    ConfigurationSetName
    
  • event_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>

impl Client

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>

impl Client

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
    ConfigurationSetName
    
  • event_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>

impl Client

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 GetConfigurationSetEventDestinationsOutput with 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>

impl Client

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 ListConfigurationSetsOutput with 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>

impl Client

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 SendVoiceMessageOutput with field(s):
  • message_id(Option<String>): A unique identifier for the voice message.
• On failure, responds with SdkError<SendVoiceMessageError>

impl Client

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
    ConfigurationSetName
    
  • event_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>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.