ListImportJobsCommand

Suggest an Edit

Lists information about import jobs.

Example Syntax

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

import { QConnectClient, ListImportJobsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListImportJobsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListImportJobsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  knowledgeBaseId: "STRING_VALUE", // required
};
const command = new ListImportJobsCommand(input);
const response = await client.send(command);
// { // ListImportJobsResponse
//   importJobSummaries: [ // ImportJobList // required
//     { // ImportJobSummary
//       importJobId: "STRING_VALUE", // required
//       knowledgeBaseId: "STRING_VALUE", // required
//       uploadId: "STRING_VALUE", // required
//       knowledgeBaseArn: "STRING_VALUE", // required
//       importJobType: "STRING_VALUE", // required
//       status: "STRING_VALUE", // required
//       createdTime: new Date("TIMESTAMP"), // required
//       lastModifiedTime: new Date("TIMESTAMP"), // required
//       metadata: { // ContentMetadata
//         "<keys>": "STRING_VALUE",
//       },
//       externalSourceConfiguration: { // ExternalSourceConfiguration
//         source: "STRING_VALUE", // required
//         configuration: { // Configuration Union: only one key present
//           connectConfiguration: { // ConnectConfiguration
//             instanceId: "STRING_VALUE",
//           },
//         },
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListImportJobsCommand Input

See ListImportJobsCommandInput for more details

Parameter
Type
Description
knowledgeBaseId
Required
string | undefined

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

maxResults
number | undefined

The maximum number of results to return per page.

nextToken
string | undefined

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListImportJobsCommand Output

See ListImportJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
importJobSummaries
Required
ImportJobSummary[] | undefined

Summary information about the import jobs.

nextToken
string | undefined

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.