Struct Client 

pub struct Client { /* private fields */ }

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 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_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

impl Client

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: true
    

    The unique identifier assigned to this job when it was created.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The thing name associated with the device the job execution is running on.

    
    
  • include_job_document(bool) / set_include_job_document(Option<bool>):
    required: false
    

    Optional. Unless set to false, the response contains the job document. The default is true.

    
    
  • execution_number(i64) / set_execution_number(Option<i64>):
    required: false
    

    Optional. 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>

impl Client

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: true
    

    The 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>

impl Client

pub fn start_command_execution(&self) -> StartCommandExecutionFluentBuilder

Constructs a fluent builder for the StartCommandExecution operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the device where the command execution is occurring.

    
    
  • command_arn(impl Into<String>) / set_command_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

    
    
  • parameters(impl Into<String>, CommandParameterValue) / set_parameters(Option<HashMap::<String, CommandParameterValue>>):
    required: false
    

    A list of parameters that are required by the StartCommandExecution API when performing the command on a device.

    
    
  • execution_timeout_seconds(i64) / set_execution_timeout_seconds(Option<i64>):
    required: false
    

    Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    
    
• On success, responds with StartCommandExecutionOutput with field(s):
  • execution_id(Option<String>):

    A unique identifier for the command execution.

• On failure, responds with SdkError<StartCommandExecutionError>

impl Client

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: true
    

    The name of the thing associated with the device.

    
    
  • status_details(impl Into<String>, impl Into<String>) / set_status_details(Option<HashMap::<String, String>>):
    required: false
    

    A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    The maximum length of the value in the name/value pair is 1,024 characters.

    
    
  • step_timeout_in_minutes(i64) / set_step_timeout_in_minutes(Option<i64>):
    required: false
    

    Specifies 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 to IN_PROGRESS, and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (CreateJob using field timeoutConfig).

    Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).

    
    
• On success, responds with StartNextPendingJobExecutionOutput with field(s):
  • execution(Option<JobExecution>):

    A JobExecution object.

• On failure, responds with SdkError<StartNextPendingJobExecutionError>

impl Client

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: true
    

    The unique identifier assigned to this job when it was created.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing associated with the device.

    
    
  • status(JobExecutionStatus) / set_status(Option<JobExecutionStatus>):
    required: true
    

    The 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: false
    

    Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

    The maximum length of the value in the name/value pair is 1,024 characters.

    
    
  • step_timeout_in_minutes(i64) / set_step_timeout_in_minutes(Option<i64>):
    required: false
    

    Specifies 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 to IN_PROGRESS, and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (CreateJob using field timeoutConfig).

    Valid values for this parameter range from 1 to 10080 (1 minute to 7 days). A value of -1 is also valid and will cancel the current step timer (created by an earlier use of UpdateJobExecutionRequest).

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    Optional. 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: false
    

    Optional. 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: false
    

    Optional. When set to true, the response contains the job document. The default is false.

    
    
  • execution_number(i64) / set_execution_number(Option<i64>):
    required: false
    

    Optional. 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>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.