Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Elastic Transcoder

Client for invoking operations on Amazon Elastic Transcoder. Each operation on Amazon Elastic Transcoder 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_elastictranscoder::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_elastictranscoder::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 CancelJob operation has a Client::cancel_job, 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.cancel_job()
    .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 ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn cancel_job(&self) -> CancelJobFluentBuilder

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

impl Client

pub fn create_pipeline(&self) -> CreatePipelineFluentBuilder

impl Client

pub fn create_preset(&self) -> CreatePresetFluentBuilder

impl Client

pub fn delete_pipeline(&self) -> DeletePipelineFluentBuilder

impl Client

pub fn delete_preset(&self) -> DeletePresetFluentBuilder

impl Client

pub fn list_jobs_by_pipeline(&self) -> ListJobsByPipelineFluentBuilder

impl Client

pub fn list_jobs_by_status(&self) -> ListJobsByStatusFluentBuilder

impl Client

pub fn list_pipelines(&self) -> ListPipelinesFluentBuilder

impl Client

pub fn list_presets(&self) -> ListPresetsFluentBuilder

impl Client

pub fn read_job(&self) -> ReadJobFluentBuilder

impl Client

pub fn read_pipeline(&self) -> ReadPipelineFluentBuilder

impl Client

pub fn read_preset(&self) -> ReadPresetFluentBuilder

impl Client

pub fn test_role(&self) -> TestRoleFluentBuilder

impl Client

pub fn update_pipeline(&self) -> UpdatePipelineFluentBuilder

impl Client

pub fn update_pipeline_notifications( &self, ) -> UpdatePipelineNotificationsFluentBuilder

impl Client

pub fn update_pipeline_status(&self) -> UpdatePipelineStatusFluentBuilder

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_job_complete(&self) -> JobCompleteFluentBuilder

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§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

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

Struct 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> CloneToUninit for T
where T: Clone,

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> Paint for T
where T: ?Sized,