import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListSentimentDetectionJobsRequest, ListSentimentDetectionJobsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link ListSentimentDetectionJobsCommand}. */ export interface ListSentimentDetectionJobsCommandInput extends ListSentimentDetectionJobsRequest { } /** * @public * * The output of {@link ListSentimentDetectionJobsCommand}. */ export interface ListSentimentDetectionJobsCommandOutput extends ListSentimentDetectionJobsResponse, __MetadataBearer { } declare const ListSentimentDetectionJobsCommand_base: { new (input: ListSentimentDetectionJobsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [ListSentimentDetectionJobsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets a list of sentiment detection jobs that you have submitted.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, ListSentimentDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, ListSentimentDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import * // import type { ComprehendClientConfig } from "@aws-sdk/client-comprehend"; * const config = {}; // type is ComprehendClientConfig * const client = new ComprehendClient(config); * const input = { // ListSentimentDetectionJobsRequest * Filter: { // SentimentDetectionJobFilter * JobName: "STRING_VALUE", * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED", * SubmitTimeBefore: new Date("TIMESTAMP"), * SubmitTimeAfter: new Date("TIMESTAMP"), * }, * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * }; * const command = new ListSentimentDetectionJobsCommand(input); * const response = await client.send(command); * // { // ListSentimentDetectionJobsResponse * // SentimentDetectionJobPropertiesList: [ // SentimentDetectionJobPropertiesList * // { // SentimentDetectionJobProperties * // JobId: "STRING_VALUE", * // JobArn: "STRING_VALUE", * // JobName: "STRING_VALUE", * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED", * // Message: "STRING_VALUE", * // SubmitTime: new Date("TIMESTAMP"), * // EndTime: new Date("TIMESTAMP"), * // InputDataConfig: { // InputDataConfig * // S3Uri: "STRING_VALUE", // required * // InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE", * // DocumentReaderConfig: { // DocumentReaderConfig * // DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required * // DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION", * // FeatureTypes: [ // ListOfDocumentReadFeatureTypes * // "TABLES" || "FORMS", * // ], * // }, * // }, * // OutputDataConfig: { // OutputDataConfig * // S3Uri: "STRING_VALUE", // required * // KmsKeyId: "STRING_VALUE", * // }, * // LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", * // DataAccessRoleArn: "STRING_VALUE", * // VolumeKmsKeyId: "STRING_VALUE", * // VpcConfig: { // VpcConfig * // SecurityGroupIds: [ // SecurityGroupIds // required * // "STRING_VALUE", * // ], * // Subnets: [ // Subnets // required * // "STRING_VALUE", * // ], * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param ListSentimentDetectionJobsCommandInput - {@link ListSentimentDetectionJobsCommandInput} * @returns {@link ListSentimentDetectionJobsCommandOutput} * @see {@link ListSentimentDetectionJobsCommandInput} for command's `input` shape. * @see {@link ListSentimentDetectionJobsCommandOutput} for command's `response` shape. * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. * * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link InvalidFilterException} (client fault) *

The filter specified for the operation is invalid. Specify a different * filter.

* * @throws {@link InvalidRequestException} (client fault) *

The request is invalid.

* * @throws {@link TooManyRequestsException} (client fault) *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class ListSentimentDetectionJobsCommand extends ListSentimentDetectionJobsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListSentimentDetectionJobsRequest; output: ListSentimentDetectionJobsResponse; }; sdk: { input: ListSentimentDetectionJobsCommandInput; output: ListSentimentDetectionJobsCommandOutput; }; }; }