@aws-sdk/client-iot-jobs-data-plane 3.696.0 → 3.699.0

package/dist-types/IoTJobsDataPlane.d.ts

@@ -1,6 +1,7 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
 import { DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput } from "./commands/DescribeJobExecutionCommand";
 import { GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput } from "./commands/GetPendingJobExecutionsCommand";
+import { StartCommandExecutionCommandInput, StartCommandExecutionCommandOutput } from "./commands/StartCommandExecutionCommand";
 import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput } from "./commands/StartNextPendingJobExecutionCommand";
 import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "./commands/UpdateJobExecutionCommand";
 import { IoTJobsDataPlaneClient } from "./IoTJobsDataPlaneClient";
@@ -17,6 +18,12 @@ export interface IoTJobsDataPlane {
     getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, options?: __HttpHandlerOptions): Promise<GetPendingJobExecutionsCommandOutput>;
     getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void): void;
     getPendingJobExecutions(args: GetPendingJobExecutionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPendingJobExecutionsCommandOutput) => void): void;
+    /**
+     * @see {@link StartCommandExecutionCommand}
+     */
+    startCommandExecution(args: StartCommandExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartCommandExecutionCommandOutput>;
+    startCommandExecution(args: StartCommandExecutionCommandInput, cb: (err: any, data?: StartCommandExecutionCommandOutput) => void): void;
+    startCommandExecution(args: StartCommandExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCommandExecutionCommandOutput) => void): void;
     /**
      * @see {@link StartNextPendingJobExecutionCommand}
      */
@@ -31,17 +38,27 @@ export interface IoTJobsDataPlane {
     updateJobExecution(args: UpdateJobExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateJobExecutionCommandOutput) => void): void;
 }
 /**
- * <p>AWS 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 AWS IoT. 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.</p>
- *          <p> 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.</p>
- *          <p> AWS 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 AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and
- *          for all the targets of the job</p>
+ * <p>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.</p>
+ *          <p>Find the endpoint address for actions in the IoT jobs data plane by running this
+ *          CLI command:</p>
+ *          <p>
+ *             <code>aws iot describe-endpoint --endpoint-type iot:Jobs</code>
+ *          </p>
+ *          <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
+ *             Signature Version 4</a> to sign requests is:
+ *          <i>iot-jobs-data</i>.</p>
+ *          <p> 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.</p>
+ *          <p> 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</p>
  * @public
  */
 export declare class IoTJobsDataPlane extends IoTJobsDataPlaneClient implements IoTJobsDataPlane {

package/dist-types/IoTJobsDataPlaneClient.d.ts

@@ -9,6 +9,7 @@ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalc
 import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
 import { DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput } from "./commands/DescribeJobExecutionCommand";
 import { GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput } from "./commands/GetPendingJobExecutionsCommand";
+import { StartCommandExecutionCommandInput, StartCommandExecutionCommandOutput } from "./commands/StartCommandExecutionCommand";
 import { StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput } from "./commands/StartNextPendingJobExecutionCommand";
 import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from "./commands/UpdateJobExecutionCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
@@ -17,11 +18,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = DescribeJobExecutionCommandInput | GetPendingJobExecutionsCommandInput | StartNextPendingJobExecutionCommandInput | UpdateJobExecutionCommandInput;
+export type ServiceInputTypes = DescribeJobExecutionCommandInput | GetPendingJobExecutionsCommandInput | StartCommandExecutionCommandInput | StartNextPendingJobExecutionCommandInput | UpdateJobExecutionCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = DescribeJobExecutionCommandOutput | GetPendingJobExecutionsCommandOutput | StartNextPendingJobExecutionCommandOutput | UpdateJobExecutionCommandOutput;
+export type ServiceOutputTypes = DescribeJobExecutionCommandOutput | GetPendingJobExecutionsCommandOutput | StartCommandExecutionCommandOutput | StartNextPendingJobExecutionCommandOutput | UpdateJobExecutionCommandOutput;
 /**
  * @public
  */
@@ -155,17 +156,27 @@ export type IoTJobsDataPlaneClientResolvedConfigType = __SmithyResolvedConfigura
 export interface IoTJobsDataPlaneClientResolvedConfig extends IoTJobsDataPlaneClientResolvedConfigType {
 }
 /**
- * <p>AWS 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 AWS IoT. 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.</p>
- *          <p> 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.</p>
- *          <p> AWS 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 AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and
- *          for all the targets of the job</p>
+ * <p>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.</p>
+ *          <p>Find the endpoint address for actions in the IoT jobs data plane by running this
+ *          CLI command:</p>
+ *          <p>
+ *             <code>aws iot describe-endpoint --endpoint-type iot:Jobs</code>
+ *          </p>
+ *          <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
+ *             Signature Version 4</a> to sign requests is:
+ *          <i>iot-jobs-data</i>.</p>
+ *          <p> 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.</p>
+ *          <p> 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</p>
  * @public
  */
 export declare class IoTJobsDataPlaneClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTJobsDataPlaneClientResolvedConfig> {

package/dist-types/commands/DescribeJobExecutionCommand.d.ts

@@ -28,6 +28,7 @@ declare const DescribeJobExecutionCommand_base: {
 };
 /**
  * <p>Gets details of a job execution.</p>
+ *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeJobExecution</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -72,7 +73,7 @@ declare const DescribeJobExecutionCommand_base: {
  *  <p>The certificate is invalid.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
+ *  <p>The contents of the request were invalid.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource does not exist.</p>

package/dist-types/commands/GetPendingJobExecutionsCommand.d.ts

@@ -28,6 +28,7 @@ declare const GetPendingJobExecutionsCommand_base: {
 };
 /**
  * <p>Gets the list of all jobs for a thing that are not in a terminal status.</p>
+ *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetPendingJobExecutions</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -74,7 +75,7 @@ declare const GetPendingJobExecutionsCommand_base: {
  *  <p>The certificate is invalid.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
+ *  <p>The contents of the request were invalid.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource does not exist.</p>

package/dist-types/commands/StartCommandExecutionCommand.d.ts

@@ -0,0 +1,104 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTJobsDataPlaneClient";
+import { StartCommandExecutionRequest, StartCommandExecutionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartCommandExecutionCommand}.
+ */
+export interface StartCommandExecutionCommandInput extends StartCommandExecutionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartCommandExecutionCommand}.
+ */
+export interface StartCommandExecutionCommandOutput extends StartCommandExecutionResponse, __MetadataBearer {
+}
+declare const StartCommandExecutionCommand_base: {
+    new (input: StartCommandExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StartCommandExecutionCommandInput, StartCommandExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: StartCommandExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<StartCommandExecutionCommandInput, StartCommandExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Using the command created with the <code>CreateCommand</code> API, start a command
+ *          execution on a specific device.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { IoTJobsDataPlaneClient, StartCommandExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import
+ * // const { IoTJobsDataPlaneClient, StartCommandExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import
+ * const client = new IoTJobsDataPlaneClient(config);
+ * const input = { // StartCommandExecutionRequest
+ *   targetArn: "STRING_VALUE", // required
+ *   commandArn: "STRING_VALUE", // required
+ *   parameters: { // CommandExecutionParameterMap
+ *     "<keys>": { // CommandParameterValue
+ *       S: "STRING_VALUE",
+ *       B: true || false,
+ *       I: Number("int"),
+ *       L: Number("long"),
+ *       D: Number("double"),
+ *       BIN: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *       UL: "STRING_VALUE",
+ *     },
+ *   },
+ *   executionTimeoutSeconds: Number("long"),
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new StartCommandExecutionCommand(input);
+ * const response = await client.send(command);
+ * // { // StartCommandExecutionResponse
+ * //   executionId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param StartCommandExecutionCommandInput - {@link StartCommandExecutionCommandInput}
+ * @returns {@link StartCommandExecutionCommandOutput}
+ * @see {@link StartCommandExecutionCommandInput} for command's `input` shape.
+ * @see {@link StartCommandExecutionCommandOutput} for command's `response` shape.
+ * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for IoTJobsDataPlaneClient's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>A conflict has occurred when performing the API request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred when performing the API request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource does not exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The service quota has been exceeded for this request.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The rate exceeds the limit.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>A validation error occurred when performing the API request.</p>
+ *
+ * @throws {@link IoTJobsDataPlaneServiceException}
+ * <p>Base exception class for all service exceptions from IoTJobsDataPlane service.</p>
+ *
+ * @public
+ */
+export declare class StartCommandExecutionCommand extends StartCommandExecutionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: StartCommandExecutionRequest;
+            output: StartCommandExecutionResponse;
+        };
+        sdk: {
+            input: StartCommandExecutionCommandInput;
+            output: StartCommandExecutionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/StartNextPendingJobExecutionCommand.d.ts

@@ -27,7 +27,9 @@ declare const StartNextPendingJobExecutionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.</p>
+ * <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a
+ *          thing.</p>
+ *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartNextPendingJobExecution</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -73,7 +75,7 @@ declare const StartNextPendingJobExecutionCommand_base: {
  *  <p>The certificate is invalid.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
+ *  <p>The contents of the request were invalid.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource does not exist.</p>

package/dist-types/commands/UpdateJobExecutionCommand.d.ts

@@ -28,6 +28,7 @@ declare const UpdateJobExecutionCommand_base: {
 };
 /**
  * <p>Updates the status of a job execution.</p>
+ *          <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotjobsdataplane.html">UpdateJobExecution</a> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -72,12 +73,13 @@ declare const UpdateJobExecutionCommand_base: {
  *  <p>The certificate is invalid.</p>
  *
  * @throws {@link InvalidRequestException} (client fault)
- *  <p>The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.</p>
+ *  <p>The contents of the request were invalid.</p>
  *
  * @throws {@link InvalidStateTransitionException} (client fault)
- *  <p>An update attempted to change the job execution to a state that is invalid because of the job execution's
- *          current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this
- *          case, the body of the error message also contains the executionState field.</p>
+ *  <p>An update attempted to change the job execution to a state that is invalid because of
+ *          the job execution's current state (for example, an attempt to change a request in state
+ *          SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains
+ *          the executionState field.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource does not exist.</p>

package/dist-types/commands/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./DescribeJobExecutionCommand";
 export * from "./GetPendingJobExecutionsCommand";
+export * from "./StartCommandExecutionCommand";
 export * from "./StartNextPendingJobExecutionCommand";
 export * from "./UpdateJobExecutionCommand";

package/dist-types/index.d.ts

@@ -1,15 +1,25 @@
 /**
- * <p>AWS 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 AWS IoT. 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.</p>
- *          <p> 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.</p>
- *          <p> AWS 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 AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and
- *          for all the targets of the job</p>
+ * <p>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.</p>
+ *          <p>Find the endpoint address for actions in the IoT jobs data plane by running this
+ *          CLI command:</p>
+ *          <p>
+ *             <code>aws iot describe-endpoint --endpoint-type iot:Jobs</code>
+ *          </p>
+ *          <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services
+ *             Signature Version 4</a> to sign requests is:
+ *          <i>iot-jobs-data</i>.</p>
+ *          <p> 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.</p>
+ *          <p> 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</p>
  *
  * @packageDocumentation
  */