Struct aws_sdk_personalizeevents::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Personalize Events
Client for invoking operations on Amazon Personalize Events. Each operation on Amazon Personalize Events 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_personalizeevents::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_personalizeevents::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 PutActionInteractions
operation has
a Client::put_action_interactions
, 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.put_action_interactions()
.tracking_id("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 put_action_interactions(&self) -> PutActionInteractionsFluentBuilder
pub fn put_action_interactions(&self) -> PutActionInteractionsFluentBuilder
Constructs a fluent builder for the PutActionInteractions
operation.
- The fluent builder is configurable:
tracking_id(impl Into<String>)
/set_tracking_id(Option<String>)
:
required: trueThe ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an action interaction event tracker for you. For more information, see Action interaction event tracker ID.
action_interactions(ActionInteraction)
/set_action_interactions(Option<Vec::<ActionInteraction>>)
:
required: trueA list of action interaction events from the session.
- On success, responds with
PutActionInteractionsOutput
- On failure, responds with
SdkError<PutActionInteractionsError>
source§impl Client
impl Client
sourcepub fn put_actions(&self) -> PutActionsFluentBuilder
pub fn put_actions(&self) -> PutActionsFluentBuilder
Constructs a fluent builder for the PutActions
operation.
- The fluent builder is configurable:
dataset_arn(impl Into<String>)
/set_dataset_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.
actions(Action)
/set_actions(Option<Vec::<Action>>)
:
required: trueA list of action data.
- On success, responds with
PutActionsOutput
- On failure, responds with
SdkError<PutActionsError>
source§impl Client
impl Client
sourcepub fn put_events(&self) -> PutEventsFluentBuilder
pub fn put_events(&self) -> PutEventsFluentBuilder
Constructs a fluent builder for the PutEvents
operation.
- The fluent builder is configurable:
tracking_id(impl Into<String>)
/set_tracking_id(Option<String>)
:
required: trueThe tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe user associated with the event.
session_id(impl Into<String>)
/set_session_id(Option<String>)
:
required: trueThe session ID associated with the user’s visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording item interaction events.
event_list(Event)
/set_event_list(Option<Vec::<Event>>)
:
required: trueA list of event data from the session.
- On success, responds with
PutEventsOutput
- On failure, responds with
SdkError<PutEventsError>
source§impl Client
impl Client
sourcepub fn put_items(&self) -> PutItemsFluentBuilder
pub fn put_items(&self) -> PutItemsFluentBuilder
Constructs a fluent builder for the PutItems
operation.
- The fluent builder is configurable:
dataset_arn(impl Into<String>)
/set_dataset_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.
items(Item)
/set_items(Option<Vec::<Item>>)
:
required: trueA list of item data.
- On success, responds with
PutItemsOutput
- On failure, responds with
SdkError<PutItemsError>
source§impl Client
impl Client
sourcepub fn put_users(&self) -> PutUsersFluentBuilder
pub fn put_users(&self) -> PutUsersFluentBuilder
Constructs a fluent builder for the PutUsers
operation.
- The fluent builder is configurable:
dataset_arn(impl Into<String>)
/set_dataset_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.
users(User)
/set_users(Option<Vec::<User>>)
:
required: trueA list of user data.
- On success, responds with
PutUsersOutput
- On failure, responds with
SdkError<PutUsersError>
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