Struct aws_sdk_iotjobsdataplane::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Jobs Data Plane
Client for invoking operations on AWS IoT Jobs Data Plane. Each operation on AWS IoT Jobs Data Plane 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_iotjobsdataplane::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_iotjobsdataplane::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 DescribeJobExecution
operation has
a Client::describe_job_execution
, 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.describe_job_execution()
.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.
Implementations§
source§impl Client
impl Client
sourcepub fn describe_job_execution(&self) -> DescribeJobExecutionFluentBuilder
pub fn describe_job_execution(&self) -> DescribeJobExecutionFluentBuilder
Constructs a fluent builder for the DescribeJobExecution
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe unique identifier assigned to this job when it was created.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe thing name associated with the device the job execution is running on.
include_job_document(bool)
/set_include_job_document(Option<bool>)
:
required: falseOptional. When set to true, the response contains the job document. The default is false.
execution_number(i64)
/set_execution_number(Option<i64>)
:
required: falseOptional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
- On success, responds with
DescribeJobExecutionOutput
with field(s):execution(Option<JobExecution>)
:Contains data about a job execution.
- On failure, responds with
SdkError<DescribeJobExecutionError>
source§impl Client
impl Client
sourcepub fn get_pending_job_executions(&self) -> GetPendingJobExecutionsFluentBuilder
pub fn get_pending_job_executions(&self) -> GetPendingJobExecutionsFluentBuilder
Constructs a fluent builder for the GetPendingJobExecutions
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing that is executing the job.
- On success, responds with
GetPendingJobExecutionsOutput
with field(s):in_progress_jobs(Option<Vec::<JobExecutionSummary>>)
:A list of JobExecutionSummary objects with status IN_PROGRESS.
queued_jobs(Option<Vec::<JobExecutionSummary>>)
:A list of JobExecutionSummary objects with status QUEUED.
- On failure, responds with
SdkError<GetPendingJobExecutionsError>
source§impl Client
impl Client
sourcepub fn start_next_pending_job_execution(
&self
) -> StartNextPendingJobExecutionFluentBuilder
pub fn start_next_pending_job_execution( &self ) -> StartNextPendingJobExecutionFluentBuilder
Constructs a fluent builder for the StartNextPendingJobExecution
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing associated with the device.
status_details(impl Into<String>, impl Into<String>)
/set_status_details(Option<HashMap::<String, String>>)
:
required: falseA collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
step_timeout_in_minutes(i64)
/set_step_timeout_in_minutes(Option<i64>)
:
required: falseSpecifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling
UpdateJobExecution
, setting the status toIN_PROGRESS
and specifying a new timeout value in fieldstepTimeoutInMinutes
) the job execution status will be automatically set toTIMED_OUT
. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using fieldtimeoutConfig
).
- On success, responds with
StartNextPendingJobExecutionOutput
with field(s):execution(Option<JobExecution>)
:A JobExecution object.
- On failure, responds with
SdkError<StartNextPendingJobExecutionError>
source§impl Client
impl Client
sourcepub fn update_job_execution(&self) -> UpdateJobExecutionFluentBuilder
pub fn update_job_execution(&self) -> UpdateJobExecutionFluentBuilder
Constructs a fluent builder for the UpdateJobExecution
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe unique identifier assigned to this job when it was created.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing associated with the device.
status(JobExecutionStatus)
/set_status(Option<JobExecutionStatus>)
:
required: trueThe new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
status_details(impl Into<String>, impl Into<String>)
/set_status_details(Option<HashMap::<String, String>>)
:
required: falseOptional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
step_timeout_in_minutes(i64)
/set_step_timeout_in_minutes(Option<i64>)
:
required: falseSpecifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling
UpdateJobExecution
, setting the status toIN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set toTIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using fieldtimeoutConfig
).expected_version(i64)
/set_expected_version(Option<i64>)
:
required: falseOptional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
include_job_execution_state(bool)
/set_include_job_execution_state(Option<bool>)
:
required: falseOptional. When included and set to true, the response contains the JobExecutionState data. The default is false.
include_job_document(bool)
/set_include_job_document(Option<bool>)
:
required: falseOptional. When set to true, the response contains the job document. The default is false.
execution_number(i64)
/set_execution_number(Option<i64>)
:
required: falseOptional. A number that identifies a particular job execution on a particular device.
- On success, responds with
UpdateJobExecutionOutput
with field(s):execution_state(Option<JobExecutionState>)
:A JobExecutionState object.
job_document(Option<String>)
:The contents of the Job Documents.
- On failure, responds with
SdkError<UpdateJobExecutionError>
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