Struct aws_sdk_machinelearning::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Machine Learning

Client for invoking operations on Amazon Machine Learning. Each operation on Amazon Machine Learning 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_machinelearning::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_machinelearning::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 AddTags operation has a Client::add_tags, 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.add_tags()
    .resource_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.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Struct aws_sdk_machinelearning::ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn add_tags(&self) -> AddTagsFluentBuilder

impl Client

pub fn create_batch_prediction(&self) -> CreateBatchPredictionFluentBuilder

impl Client

pub fn create_data_source_from_rds( &self ) -> CreateDataSourceFromRDSFluentBuilder

impl Client

pub fn create_data_source_from_redshift( &self ) -> CreateDataSourceFromRedshiftFluentBuilder

impl Client

pub fn create_data_source_from_s3(&self) -> CreateDataSourceFromS3FluentBuilder

impl Client

pub fn create_evaluation(&self) -> CreateEvaluationFluentBuilder

impl Client

pub fn create_ml_model(&self) -> CreateMLModelFluentBuilder

impl Client

pub fn create_realtime_endpoint(&self) -> CreateRealtimeEndpointFluentBuilder

impl Client

pub fn delete_batch_prediction(&self) -> DeleteBatchPredictionFluentBuilder

impl Client

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

impl Client

pub fn delete_evaluation(&self) -> DeleteEvaluationFluentBuilder

impl Client

pub fn delete_ml_model(&self) -> DeleteMLModelFluentBuilder

impl Client

pub fn delete_realtime_endpoint(&self) -> DeleteRealtimeEndpointFluentBuilder

impl Client

pub fn delete_tags(&self) -> DeleteTagsFluentBuilder

impl Client

pub fn describe_batch_predictions( &self ) -> DescribeBatchPredictionsFluentBuilder

impl Client

pub fn describe_data_sources(&self) -> DescribeDataSourcesFluentBuilder

impl Client

pub fn describe_evaluations(&self) -> DescribeEvaluationsFluentBuilder

impl Client

pub fn describe_ml_models(&self) -> DescribeMLModelsFluentBuilder

impl Client

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

impl Client

pub fn get_batch_prediction(&self) -> GetBatchPredictionFluentBuilder

impl Client

pub fn get_data_source(&self) -> GetDataSourceFluentBuilder

impl Client

pub fn get_evaluation(&self) -> GetEvaluationFluentBuilder

impl Client

pub fn get_ml_model(&self) -> GetMLModelFluentBuilder

impl Client

pub fn predict(&self) -> PredictFluentBuilder

impl Client

pub fn update_batch_prediction(&self) -> UpdateBatchPredictionFluentBuilder

impl Client

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

impl Client

pub fn update_evaluation(&self) -> UpdateEvaluationFluentBuilder

impl Client

pub fn update_ml_model(&self) -> UpdateMLModelFluentBuilder

impl Client

pub fn from_conf(conf: Config) -> Self

§Panics

pub fn config(&self) -> &Config

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

§Panics

Trait Implementations§

impl Clone for Client

fn clone(&self) -> Client

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

impl Debug for Client

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

impl Waiters for Client

fn wait_until_batch_prediction_available( &self ) -> BatchPredictionAvailableFluentBuilder

fn wait_until_data_source_available(&self) -> DataSourceAvailableFluentBuilder

fn wait_until_evaluation_available(&self) -> EvaluationAvailableFluentBuilder

fn wait_until_ml_model_available(&self) -> MlModelAvailableFluentBuilder

Auto Trait Implementations§

Struct aws_sdk_machinelearning::Client

§Constructing a `Client`

§Using the `Client`

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,