IoT Jobs is a service that allows you to define a set of jobs — remote operations\nthat are sent to and executed on one or more devices connected to Amazon Web Services IoT Core. For example,\nyou can define a job that instructs a set of devices to download and install application or\nfirmware updates, reboot, rotate certificates, or perform remote troubleshooting\noperations.
\nFind the endpoint address for actions in the IoT jobs data plane by running this\nCLI command:
\n\naws iot describe-endpoint --endpoint-type iot:Jobs\n
The service name used by Amazon Web Services\nSignature Version 4 to sign requests is:\niot-jobs-data.
\nTo create a job, you make a job document which is a description of the remote\noperations to be performed, and you specify a list of targets that should perform the\noperations. The targets can be individual things, thing groups or both.
\nIoT Jobs sends a message to inform the targets that a job is available. The target\nstarts the execution of the job by downloading the job document, performing the operations\nit specifies, and reporting its progress to Amazon Web Services IoT Core. The Jobs service provides commands\nto track the progress of a job on a specific target and for all the targets of the\njob
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-iot-jobs-data-plane`\n- `yarn add @aws-sdk/client-iot-jobs-data-plane`\n- `pnpm add @aws-sdk/client-iot-jobs-data-plane`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `IoTJobsDataPlaneClient` and\nthe commands you need, for example `GetPendingJobExecutionsCommand`:\n\n```js\n// ES5 example\nconst { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } = require(\"@aws-sdk/client-iot-jobs-data-plane\");\n```\n\n```ts\n// ES6+ example\nimport { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } from \"@aws-sdk/client-iot-jobs-data-plane\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new IoTJobsDataPlaneClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new GetPendingJobExecutionsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`IoTJobsDataPlane` extends `IoTJobsDataPlaneClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`IoTJobsDataPlaneClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { IoTJobsDataPlane } from \"@aws-sdk/client-iot-jobs-data-plane\";\n\nconst client = new IoTJobsDataPlane({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.getPendingJobExecutions(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .getPendingJobExecutions(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.getPendingJobExecutions(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-iot-jobs-data-plane` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n