@aws-sdk/client-iot-jobs-data-plane 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -17,18 +17,22 @@ export declare class CertificateValidationException extends __BaseException {
  */
 export interface DescribeJobExecutionRequest {
     /**
+     * @public
      * <p>The unique identifier assigned to this job when it was created.</p>
      */
     jobId: string | undefined;
     /**
+     * @public
      * <p>The thing name associated with the device the job execution is running on.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
      */
     includeJobDocument?: boolean;
     /**
+     * @public
      * <p>Optional. A number that identifies a particular job execution on a particular device. If not specified,
      *          the latest job execution is returned.</p>
      */
@@ -58,50 +62,61 @@ export type JobExecutionStatus = (typeof JobExecutionStatus)[keyof typeof JobExe
  */
 export interface JobExecution {
     /**
+     * @public
      * <p>The unique identifier you assigned to this job when it was created.</p>
      */
     jobId?: string;
     /**
+     * @public
      * <p>The name of the thing that is executing the job.</p>
      */
     thingName?: string;
     /**
+     * @public
      * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
      *          "REJECTED", or "REMOVED".</p>
      */
     status?: JobExecutionStatus | string;
     /**
+     * @public
      * <p>A collection of name/value pairs that describe the status of the job execution.</p>
      */
     statusDetails?: Record<string, string>;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
      */
     queuedAt?: number;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution was started.</p>
      */
     startedAt?: number;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution was last updated. </p>
      */
     lastUpdatedAt?: number;
     /**
+     * @public
      * <p>The estimated number of seconds that remain before the job execution status will be
      *            changed to <code>TIMED_OUT</code>.</p>
      */
     approximateSecondsBeforeTimedOut?: number;
     /**
+     * @public
      * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
      *          device.</p>
      */
     versionNumber?: number;
     /**
+     * @public
      * <p>A number that identifies a particular job execution on a particular device. It can be used later in
      *          commands that return or update job execution information.</p>
      */
     executionNumber?: number;
     /**
+     * @public
      * <p>The content of the job document.</p>
      */
     jobDocument?: string;
@@ -111,6 +126,7 @@ export interface JobExecution {
  */
 export interface DescribeJobExecutionResponse {
     /**
+     * @public
      * <p>Contains data about a job execution.</p>
      */
     execution?: JobExecution;
@@ -171,6 +187,7 @@ export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>The payload associated with the exception.</p>
      */
     payload?: Uint8Array;
@@ -184,6 +201,7 @@ export declare class ThrottlingException extends __BaseException {
  */
 export interface GetPendingJobExecutionsRequest {
     /**
+     * @public
      * <p>The name of the thing that is executing the job.</p>
      */
     thingName: string | undefined;
@@ -194,27 +212,33 @@ export interface GetPendingJobExecutionsRequest {
  */
 export interface JobExecutionSummary {
     /**
+     * @public
      * <p>The unique identifier you assigned to this job when it was created.</p>
      */
     jobId?: string;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution was enqueued.</p>
      */
     queuedAt?: number;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution started.</p>
      */
     startedAt?: number;
     /**
+     * @public
      * <p>The time, in milliseconds since the epoch, when the job execution was last updated.</p>
      */
     lastUpdatedAt?: number;
     /**
+     * @public
      * <p>The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives
      *          an update from a device.</p>
      */
     versionNumber?: number;
     /**
+     * @public
      * <p>A number that identifies a particular job execution on a particular device.</p>
      */
     executionNumber?: number;
@@ -224,10 +248,12 @@ export interface JobExecutionSummary {
  */
 export interface GetPendingJobExecutionsResponse {
     /**
+     * @public
      * <p>A list of JobExecutionSummary objects with status IN_PROGRESS.</p>
      */
     inProgressJobs?: JobExecutionSummary[];
     /**
+     * @public
      * <p>A list of JobExecutionSummary objects with status QUEUED.</p>
      */
     queuedJobs?: JobExecutionSummary[];
@@ -251,15 +277,18 @@ export declare class InvalidStateTransitionException extends __BaseException {
  */
 export interface StartNextPendingJobExecutionRequest {
     /**
+     * @public
      * <p>The name of the thing associated with the device.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>A collection of name/value pairs that describe the status of the job execution. If not specified, the
      *          statusDetails are unchanged.</p>
      */
     statusDetails?: Record<string, string>;
     /**
+     * @public
      * <p>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 <code>UpdateJobExecution</code>, setting the status to
@@ -275,6 +304,7 @@ export interface StartNextPendingJobExecutionRequest {
  */
 export interface StartNextPendingJobExecutionResponse {
     /**
+     * @public
      * <p>A JobExecution object.</p>
      */
     execution?: JobExecution;
@@ -284,24 +314,29 @@ export interface StartNextPendingJobExecutionResponse {
  */
 export interface UpdateJobExecutionRequest {
     /**
+     * @public
      * <p>The unique identifier assigned to this job when it was created.</p>
      */
     jobId: string | undefined;
     /**
+     * @public
      * <p>The name of the thing associated with the device.</p>
      */
     thingName: string | undefined;
     /**
+     * @public
      * <p>The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified
      *          on every update.</p>
      */
     status: JobExecutionStatus | string | undefined;
     /**
+     * @public
      * <p> Optional. A collection of name/value pairs that describe the status of the job execution. If not
      *          specified, the statusDetails are unchanged.</p>
      */
     statusDetails?: Record<string, string>;
     /**
+     * @public
      * <p>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 <code>UpdateJobExecution</code>, setting the status to
@@ -312,6 +347,7 @@ export interface UpdateJobExecutionRequest {
      */
     stepTimeoutInMinutes?: number;
     /**
+     * @public
      * <p>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
@@ -320,15 +356,18 @@ export interface UpdateJobExecutionRequest {
      */
     expectedVersion?: number;
     /**
+     * @public
      * <p>Optional. When included and set to true, the response contains the JobExecutionState data. The default is
      *          false.</p>
      */
     includeJobExecutionState?: boolean;
     /**
+     * @public
      * <p>Optional. When set to true, the response contains the job document. The default is false.</p>
      */
     includeJobDocument?: boolean;
     /**
+     * @public
      * <p>Optional. A number that identifies a particular job execution on a particular device.</p>
      */
     executionNumber?: number;
@@ -339,15 +378,18 @@ export interface UpdateJobExecutionRequest {
  */
 export interface JobExecutionState {
     /**
+     * @public
      * <p>The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
      *          "REJECTED", or "REMOVED".</p>
      */
     status?: JobExecutionStatus | string;
     /**
+     * @public
      * <p>A collection of name/value pairs that describe the status of the job execution.</p>
      */
     statusDetails?: Record<string, string>;
     /**
+     * @public
      * <p>The version of the job execution. Job execution versions are incremented each time they are updated by a
      *          device.</p>
      */
@@ -358,10 +400,12 @@ export interface JobExecutionState {
  */
 export interface UpdateJobExecutionResponse {
     /**
+     * @public
      * <p>A JobExecutionState object.</p>
      */
     executionState?: JobExecutionState;
     /**
+     * @public
      * <p>The contents of the Job Documents.</p>
      */
     jobDocument?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iot-jobs-data-plane",
   "description": "AWS SDK for JavaScript Iot Jobs Data Plane Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",