ListTopicsDetectionJobsCommand

Suggest an Edit

Gets a list of the topic detection jobs that you have submitted.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, ListTopicsDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, ListTopicsDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // ListTopicsDetectionJobsRequest
  Filter: { // TopicsDetectionJobFilter
    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 ListTopicsDetectionJobsCommand(input);
const response = await client.send(command);
// { // ListTopicsDetectionJobsResponse
//   TopicsDetectionJobPropertiesList: [ // TopicsDetectionJobPropertiesList
//     { // TopicsDetectionJobProperties
//       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",
//       },
//       NumberOfTopics: Number("int"),
//       DataAccessRoleArn: "STRING_VALUE",
//       VolumeKmsKeyId: "STRING_VALUE",
//       VpcConfig: { // VpcConfig
//         SecurityGroupIds: [ // SecurityGroupIds // required
//           "STRING_VALUE",
//         ],
//         Subnets: [ // Subnets // required
//           "STRING_VALUE",
//         ],
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListTopicsDetectionJobsCommand Input

See ListTopicsDetectionJobsCommandInput for more details

Parameter
Type
Description
Filter
TopicsDetectionJobFilter | undefined

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

MaxResults
number | undefined

The maximum number of results to return in each page. The default is 100.

NextToken
string | undefined

Identifies the next page of results to return.

ListTopicsDetectionJobsCommand Output

See ListTopicsDetectionJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

Identifies the next page of results to return.

TopicsDetectionJobPropertiesList
TopicsDetectionJobProperties[] | undefined

A list containing the properties of each job that is returned.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidFilterException
client

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

InvalidRequestException
client

The request is invalid.

TooManyRequestsException
client

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

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.