- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetImportJobCommand
Retrieves the started import job.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, GetImportJobCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, GetImportJobCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // GetImportJobRequest
importJobId: "STRING_VALUE", // required
knowledgeBaseId: "STRING_VALUE", // required
};
const command = new GetImportJobCommand(input);
const response = await client.send(command);
// { // GetImportJobResponse
// importJob: { // ImportJobData
// importJobId: "STRING_VALUE", // required
// knowledgeBaseId: "STRING_VALUE", // required
// uploadId: "STRING_VALUE", // required
// knowledgeBaseArn: "STRING_VALUE", // required
// importJobType: "STRING_VALUE", // required
// status: "STRING_VALUE", // required
// url: "STRING_VALUE", // required
// failedRecordReport: "STRING_VALUE",
// urlExpiry: new Date("TIMESTAMP"), // 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",
// },
// },
// },
// },
// };
GetImportJobCommand Input
See GetImportJobCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
importJobId Required | string | undefined | The identifier of the import job to retrieve. |
knowledgeBaseId Required | string | undefined | The identifier of the knowledge base that the import job belongs to. |
GetImportJobCommand Output
See GetImportJobCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
importJob | ImportJobData | undefined | The import job. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
ResourceNotFoundException | client | The specified resource does not exist. |
ValidationException | client | The input fails to satisfy the constraints specified by a service. |
QConnectServiceException | Base exception class for all service exceptions from QConnect service. |