@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
105 lines (104 loc) • 4.1 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { ListJobsRequest, ListJobsResponse } from "../models/models_2";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link ListJobsCommand}.
*/
export interface ListJobsCommandInput extends ListJobsRequest {
}
/**
* @public
*
* The output of {@link ListJobsCommand}.
*/
export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBearer {
}
declare const ListJobsCommand_base: {
new (input: ListJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (...[input]: [] | [ListJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListJobsCommandInput, ListJobsCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Lists jobs.</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">ListJobs</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, ListJobsCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, ListJobsCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // ListJobsRequest
* status: "IN_PROGRESS" || "CANCELED" || "COMPLETED" || "DELETION_IN_PROGRESS" || "SCHEDULED",
* targetSelection: "CONTINUOUS" || "SNAPSHOT",
* maxResults: Number("int"),
* nextToken: "STRING_VALUE",
* thingGroupName: "STRING_VALUE",
* thingGroupId: "STRING_VALUE",
* namespaceId: "STRING_VALUE",
* };
* const command = new ListJobsCommand(input);
* const response = await client.send(command);
* // { // ListJobsResponse
* // jobs: [ // JobSummaryList
* // { // JobSummary
* // jobArn: "STRING_VALUE",
* // jobId: "STRING_VALUE",
* // thingGroupId: "STRING_VALUE",
* // targetSelection: "CONTINUOUS" || "SNAPSHOT",
* // status: "IN_PROGRESS" || "CANCELED" || "COMPLETED" || "DELETION_IN_PROGRESS" || "SCHEDULED",
* // createdAt: new Date("TIMESTAMP"),
* // lastUpdatedAt: new Date("TIMESTAMP"),
* // completedAt: new Date("TIMESTAMP"),
* // isConcurrent: true || false,
* // },
* // ],
* // nextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListJobsCommandInput - {@link ListJobsCommandInput}
* @returns {@link ListJobsCommandOutput}
* @see {@link ListJobsCommandInput} for command's `input` shape.
* @see {@link ListJobsCommandOutput} for command's `response` shape.
* @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource does not exist.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is temporarily unavailable.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The rate exceeds the limit.</p>
*
* @throws {@link IoTServiceException}
* <p>Base exception class for all service exceptions from IoT service.</p>
*
*
* @public
*/
export declare class ListJobsCommand extends ListJobsCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: ListJobsRequest;
output: ListJobsResponse;
};
sdk: {
input: ListJobsCommandInput;
output: ListJobsCommandOutput;
};
};
}