@aws-sdk/client-iot-jobs-data-plane 3.36.0 → 3.36.1

package/dist-types/ts3.4/IoTJobsDataPlaneClient.d.ts

@@ -13,134 +13,59 @@ import { UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput } from
 export declare type ServiceInputTypes = DescribeJobExecutionCommandInput | GetPendingJobExecutionsCommandInput | StartNextPendingJobExecutionCommandInput | UpdateJobExecutionCommandInput;
 export declare type ServiceOutputTypes = DescribeJobExecutionCommandOutput | GetPendingJobExecutionsCommandOutput | StartNextPendingJobExecutionCommandOutput | UpdateJobExecutionCommandOutput;
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
-    /**
-     * The HTTP handler to use. Fetch in browser and Https in Nodejs.
-     */
+    
     requestHandler?: __HttpHandler;
-    /**
-     * A constructor for a class implementing the {@link __Hash} interface
-     * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
-     * @internal
-     */
+    
     sha256?: __HashConstructor;
-    /**
-     * The function that will be used to convert strings into HTTP endpoints.
-     * @internal
-     */
+    
     urlParser?: __UrlParser;
-    /**
-     * A function that can calculate the length of a request body.
-     * @internal
-     */
+    
     bodyLengthChecker?: (body: any) => number | undefined;
-    /**
-     * A function that converts a stream into an array of bytes.
-     * @internal
-     */
+    
     streamCollector?: __StreamCollector;
-    /**
-     * The function that will be used to convert a base64-encoded string to a byte array.
-     * @internal
-     */
+    
     base64Decoder?: __Decoder;
-    /**
-     * The function that will be used to convert binary data to a base64-encoded string.
-     * @internal
-     */
+    
     base64Encoder?: __Encoder;
-    /**
-     * The function that will be used to convert a UTF8-encoded string to a byte array.
-     * @internal
-     */
+    
     utf8Decoder?: __Decoder;
-    /**
-     * The function that will be used to convert binary data to a UTF-8 encoded string.
-     * @internal
-     */
+    
     utf8Encoder?: __Encoder;
-    /**
-     * The runtime environment.
-     * @internal
-     */
+    
     runtime?: string;
-    /**
-     * Disable dyanamically changing the endpoint of the client based on the hostPrefix
-     * trait of an operation.
-     */
+    
     disableHostPrefix?: boolean;
-    /**
-     * Value for how many times a request will be made at most in case of retry.
-     */
+    
     maxAttempts?: number | __Provider<number>;
-    /**
-     * Specifies which retry algorithm to use.
-     */
+    
     retryMode?: string | __Provider<string>;
-    /**
-     * Optional logger for logging debug/info/warn/error.
-     */
+    
     logger?: __Logger;
-    /**
-     * Unique service identifier.
-     * @internal
-     */
+    
     serviceId?: string;
-    /**
-     * The AWS region to which this client will send requests
-     */
+    
     region?: string | __Provider<string>;
-    /**
-     * Default credentials provider; Not available in browser runtime.
-     * @internal
-     */
+    
     credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
-    /**
-     * Fetch related hostname, signing name or signing region with given region.
-     * @internal
-     */
+    
     regionInfoProvider?: RegionInfoProvider;
-    /**
-     * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
-     * @internal
-     */
+    
     defaultUserAgentProvider?: Provider<__UserAgent>;
 }
 declare type IoTJobsDataPlaneClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
-/**
- * The configuration interface of IoTJobsDataPlaneClient class constructor that set the region, credentials and other options.
- */
+
 export interface IoTJobsDataPlaneClientConfig extends IoTJobsDataPlaneClientConfigType {
 }
 declare type IoTJobsDataPlaneClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointsResolvedConfig & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig;
-/**
- * The resolved configuration interface of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
- */
+
 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>
- */
+
 export declare class IoTJobsDataPlaneClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, IoTJobsDataPlaneClientResolvedConfig> {
-    /**
-     * The resolved configuration of IoTJobsDataPlaneClient class. This is resolved and normalized from the {@link IoTJobsDataPlaneClientConfig | constructor configuration interface}.
-     */
+    
     readonly config: IoTJobsDataPlaneClientResolvedConfig;
     constructor(configuration: IoTJobsDataPlaneClientConfig);
-    /**
-     * Destroy underlying resources, like sockets. It's usually not necessary to do this.
-     * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
-     * Otherwise, sockets might stay open for quite a long time before the server terminates them.
-     */
+    
     destroy(): void;
 }
 export {};

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

@@ -6,29 +6,11 @@ export interface DescribeJobExecutionCommandInput extends DescribeJobExecutionRe
 }
 export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionResponse, __MetadataBearer {
 }
-/**
- * <p>Gets details of a job execution.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { IoTJobsDataPlaneClient, DescribeJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import
- * // const { IoTJobsDataPlaneClient, DescribeJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import
- * const client = new IoTJobsDataPlaneClient(config);
- * const command = new DescribeJobExecutionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link DescribeJobExecutionCommandInput} for command's `input` shape.
- * @see {@link DescribeJobExecutionCommandOutput} for command's `response` shape.
- * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class DescribeJobExecutionCommand extends $Command<DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
     readonly input: DescribeJobExecutionCommandInput;
     constructor(input: DescribeJobExecutionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,29 +6,11 @@ export interface GetPendingJobExecutionsCommandInput extends GetPendingJobExecut
 }
 export interface GetPendingJobExecutionsCommandOutput extends GetPendingJobExecutionsResponse, __MetadataBearer {
 }
-/**
- * <p>Gets the list of all jobs for a thing that are not in a terminal status.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import
- * // const { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import
- * const client = new IoTJobsDataPlaneClient(config);
- * const command = new GetPendingJobExecutionsCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link GetPendingJobExecutionsCommandInput} for command's `input` shape.
- * @see {@link GetPendingJobExecutionsCommandOutput} for command's `response` shape.
- * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class GetPendingJobExecutionsCommand extends $Command<GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
     readonly input: GetPendingJobExecutionsCommandInput;
     constructor(input: GetPendingJobExecutionsCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetPendingJobExecutionsCommandInput, GetPendingJobExecutionsCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,29 +6,11 @@ export interface StartNextPendingJobExecutionCommandInput extends StartNextPendi
 }
 export interface StartNextPendingJobExecutionCommandOutput extends StartNextPendingJobExecutionResponse, __MetadataBearer {
 }
-/**
- * <p>Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { IoTJobsDataPlaneClient, StartNextPendingJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import
- * // const { IoTJobsDataPlaneClient, StartNextPendingJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import
- * const client = new IoTJobsDataPlaneClient(config);
- * const command = new StartNextPendingJobExecutionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link StartNextPendingJobExecutionCommandInput} for command's `input` shape.
- * @see {@link StartNextPendingJobExecutionCommandOutput} for command's `response` shape.
- * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class StartNextPendingJobExecutionCommand extends $Command<StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
     readonly input: StartNextPendingJobExecutionCommandInput;
     constructor(input: StartNextPendingJobExecutionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartNextPendingJobExecutionCommandInput, StartNextPendingJobExecutionCommandOutput>;
     private serialize;
     private deserialize;

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

@@ -6,29 +6,11 @@ export interface UpdateJobExecutionCommandInput extends UpdateJobExecutionReques
 }
 export interface UpdateJobExecutionCommandOutput extends UpdateJobExecutionResponse, __MetadataBearer {
 }
-/**
- * <p>Updates the status of a job execution.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { IoTJobsDataPlaneClient, UpdateJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import
- * // const { IoTJobsDataPlaneClient, UpdateJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import
- * const client = new IoTJobsDataPlaneClient(config);
- * const command = new UpdateJobExecutionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateJobExecutionCommandInput} for command's `input` shape.
- * @see {@link UpdateJobExecutionCommandOutput} for command's `response` shape.
- * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateJobExecutionCommand extends $Command<UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput, IoTJobsDataPlaneClientResolvedConfig> {
     readonly input: UpdateJobExecutionCommandInput;
     constructor(input: UpdateJobExecutionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTJobsDataPlaneClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateJobExecutionCommandInput, UpdateJobExecutionCommandOutput>;
     private serialize;
     private deserialize;