Struct aws_sdk_sagemakera2iruntime::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Augmented AI Runtime
Client for invoking operations on Amazon Augmented AI Runtime. Each operation on Amazon Augmented AI Runtime 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_sagemakera2iruntime::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_sagemakera2iruntime::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 DeleteHumanLoop
operation has
a Client::delete_human_loop
, 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.delete_human_loop()
.human_loop_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 delete_human_loop(&self) -> DeleteHumanLoopFluentBuilder
pub fn delete_human_loop(&self) -> DeleteHumanLoopFluentBuilder
Constructs a fluent builder for the DeleteHumanLoop
operation.
- The fluent builder is configurable:
human_loop_name(impl Into<String>)
/set_human_loop_name(Option<String>)
:
required: trueThe name of the human loop that you want to delete.
- On success, responds with
DeleteHumanLoopOutput
- On failure, responds with
SdkError<DeleteHumanLoopError>
source§impl Client
impl Client
sourcepub fn describe_human_loop(&self) -> DescribeHumanLoopFluentBuilder
pub fn describe_human_loop(&self) -> DescribeHumanLoopFluentBuilder
Constructs a fluent builder for the DescribeHumanLoop
operation.
- The fluent builder is configurable:
human_loop_name(impl Into<String>)
/set_human_loop_name(Option<String>)
:
required: trueThe name of the human loop that you want information about.
- On success, responds with
DescribeHumanLoopOutput
with field(s):creation_time(Option<DateTime>)
:The creation time when Amazon Augmented AI created the human loop.
failure_reason(Option<String>)
:The reason why a human loop failed. The failure reason is returned when the status of the human loop is
Failed
.failure_code(Option<String>)
:A failure code that identifies the type of failure.
Possible values:
ValidationError
,Expired
,InternalError
human_loop_status(Option<HumanLoopStatus>)
:The status of the human loop.
human_loop_name(Option<String>)
:The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).
human_loop_arn(Option<String>)
:The Amazon Resource Name (ARN) of the human loop.
flow_definition_arn(Option<String>)
:The Amazon Resource Name (ARN) of the flow definition.
human_loop_output(Option<HumanLoopOutput>)
:An object that contains information about the output of the human loop.
- On failure, responds with
SdkError<DescribeHumanLoopError>
source§impl Client
impl Client
sourcepub fn list_human_loops(&self) -> ListHumanLoopsFluentBuilder
pub fn list_human_loops(&self) -> ListHumanLoopsFluentBuilder
Constructs a fluent builder for the ListHumanLoops
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
creation_time_after(DateTime)
/set_creation_time_after(Option<DateTime>)
:
required: false(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example,
2020-02-24
.creation_time_before(DateTime)
/set_creation_time_before(Option<DateTime>)
:
required: false(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example,
2020-02-24
.flow_definition_arn(impl Into<String>)
/set_flow_definition_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of a flow definition.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:
required: falseOptional. The order for displaying results. Valid values:
Ascending
andDescending
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token to display the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe total number of items to return. If the total number of available items is more than the value specified in
MaxResults
, then aNextToken
is returned in the output. You can use this token to display the next page of results.
- On success, responds with
ListHumanLoopsOutput
with field(s):human_loop_summaries(Option<Vec::<HumanLoopSummary>>)
:An array of objects that contain information about the human loops.
next_token(Option<String>)
:A token to display the next page of results.
- On failure, responds with
SdkError<ListHumanLoopsError>
source§impl Client
impl Client
sourcepub fn start_human_loop(&self) -> StartHumanLoopFluentBuilder
pub fn start_human_loop(&self) -> StartHumanLoopFluentBuilder
Constructs a fluent builder for the StartHumanLoop
operation.
- The fluent builder is configurable:
human_loop_name(impl Into<String>)
/set_human_loop_name(Option<String>)
:
required: trueThe name of the human loop.
flow_definition_arn(impl Into<String>)
/set_flow_definition_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the flow definition associated with this human loop.
human_loop_input(HumanLoopInput)
/set_human_loop_input(Option<HumanLoopInput>)
:
required: trueAn object that contains information about the human loop.
data_attributes(HumanLoopDataAttributes)
/set_data_attributes(Option<HumanLoopDataAttributes>)
:
required: falseAttributes of the specified data. Use
DataAttributes
to specify if your data is free of personally identifiable information and/or free of adult content.
- On success, responds with
StartHumanLoopOutput
with field(s):human_loop_arn(Option<String>)
:The Amazon Resource Name (ARN) of the human loop.
- On failure, responds with
SdkError<StartHumanLoopError>
source§impl Client
impl Client
sourcepub fn stop_human_loop(&self) -> StopHumanLoopFluentBuilder
pub fn stop_human_loop(&self) -> StopHumanLoopFluentBuilder
Constructs a fluent builder for the StopHumanLoop
operation.
- The fluent builder is configurable:
human_loop_name(impl Into<String>)
/set_human_loop_name(Option<String>)
:
required: trueThe name of the human loop that you want to stop.
- On success, responds with
StopHumanLoopOutput
- On failure, responds with
SdkError<StopHumanLoopError>
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