94 releases (50 stable)

new 1.51.0 Dec 4, 2024
1.50.0 Nov 21, 2024
1.48.0 Oct 31, 2024
1.36.0 Jul 22, 2024
0.0.0 May 8, 2021

#2529 in Network programming

Download history 228/week @ 2024-08-12 14/week @ 2024-08-19 108/week @ 2024-08-26 117/week @ 2024-09-02 103/week @ 2024-09-09 142/week @ 2024-09-16 183/week @ 2024-09-23 139/week @ 2024-09-30 157/week @ 2024-10-07 33/week @ 2024-10-14 99/week @ 2024-10-21 124/week @ 2024-10-28 216/week @ 2024-11-04 5/week @ 2024-11-11 143/week @ 2024-11-18 15/week @ 2024-11-25

386 downloads per month

Apache-2.0

650KB
10K SLoC

aws-sdk-iotjobsdataplane

IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to Amazon Web Services IoT Core. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

Find the endpoint address for actions in the IoT jobs data plane by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Jobs

The service name used by Amazon Web Services Signature Version 4 to sign requests is: iot-jobs-data.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to Amazon Web Services IoT Core. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-iotjobsdataplane to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-iotjobsdataplane = "1.51.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_iotjobsdataplane as iotjobsdataplane;

#[::tokio::main]
async fn main() -> Result<(), iotjobsdataplane::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_iotjobsdataplane::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

License

This project is licensed under the Apache-2.0 License.

Dependencies

~8–20MB
~286K SLoC