Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetBatchJobExecutionCommandProtected

Gets the details of a specific batch job execution for a specific application.

Example

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

import { M2Client, GetBatchJobExecutionCommand } from "@aws-sdk/client-m2"; // ES Modules import
// const { M2Client, GetBatchJobExecutionCommand } = require("@aws-sdk/client-m2"); // CommonJS import
const client = new M2Client(config);
const input = { // GetBatchJobExecutionRequest
applicationId: "STRING_VALUE", // required
executionId: "STRING_VALUE", // required
};
const command = new GetBatchJobExecutionCommand(input);
const response = await client.send(command);
// { // GetBatchJobExecutionResponse
// executionId: "STRING_VALUE", // required
// applicationId: "STRING_VALUE", // required
// jobId: "STRING_VALUE",
// jobName: "STRING_VALUE",
// jobUser: "STRING_VALUE",
// jobType: "STRING_VALUE",
// status: "STRING_VALUE", // required
// startTime: new Date("TIMESTAMP"), // required
// endTime: new Date("TIMESTAMP"),
// statusReason: "STRING_VALUE",
// returnCode: "STRING_VALUE",
// batchJobIdentifier: { // BatchJobIdentifier Union: only one key present
// fileBatchJobIdentifier: { // FileBatchJobIdentifier
// fileName: "STRING_VALUE", // required
// folderPath: "STRING_VALUE",
// },
// scriptBatchJobIdentifier: { // ScriptBatchJobIdentifier
// scriptName: "STRING_VALUE", // required
// },
// },
// };

Param

GetBatchJobExecutionCommandInput

Returns

GetBatchJobExecutionCommandOutput

See

Throws

AccessDeniedException (client fault)

The account or role doesn't have the right permissions to make the request.

Throws

InternalServerException (server fault)

An unexpected error occurred during the processing of the request.

Throws

ResourceNotFoundException (client fault)

The specified resource was not found.

Throws

ThrottlingException (client fault)

The number of requests made exceeds the limit.

Throws

ValidationException (client fault)

One or more parameters provided in the request is not valid.

Throws

M2ServiceException

Base exception class for all service exceptions from M2 service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods