DescribeJobLogItemsCommand

Suggest an Edit

Retrieves a detailed Job log with pagination.

Example Syntax

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

import { DrsClient, DescribeJobLogItemsCommand } from "@aws-sdk/client-drs"; // ES Modules import
// const { DrsClient, DescribeJobLogItemsCommand } = require("@aws-sdk/client-drs"); // CommonJS import
const client = new DrsClient(config);
const input = { // DescribeJobLogItemsRequest
  jobID: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new DescribeJobLogItemsCommand(input);
const response = await client.send(command);
// { // DescribeJobLogItemsResponse
//   items: [ // JobLogs
//     { // JobLog
//       logDateTime: "STRING_VALUE",
//       event: "STRING_VALUE",
//       eventData: { // JobLogEventData
//         sourceServerID: "STRING_VALUE",
//         conversionServerID: "STRING_VALUE",
//         targetInstanceID: "STRING_VALUE",
//         rawError: "STRING_VALUE",
//         conversionProperties: { // ConversionProperties
//           volumeToConversionMap: { // VolumeToConversionMap
//             "<keys>": { // ConversionMap
//               "<keys>": "STRING_VALUE",
//             },
//           },
//           rootVolumeName: "STRING_VALUE",
//           forceUefi: true || false,
//           dataTimestamp: "STRING_VALUE",
//           volumeToVolumeSize: { // VolumeToSizeMap
//             "<keys>": Number("long"),
//           },
//           volumeToProductCodes: { // VolumeToProductCodes
//             "<keys>": [ // ProductCodes
//               { // ProductCode
//                 productCodeId: "STRING_VALUE",
//                 productCodeMode: "STRING_VALUE",
//               },
//             ],
//           },
//         },
//         eventResourceData: { // EventResourceData Union: only one key present
//           sourceNetworkData: { // SourceNetworkData
//             sourceNetworkID: "STRING_VALUE",
//             sourceVpc: "STRING_VALUE",
//             targetVpc: "STRING_VALUE",
//             stackName: "STRING_VALUE",
//           },
//         },
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

DescribeJobLogItemsCommand Input

See DescribeJobLogItemsCommandInput for more details

Parameter
Type
Description
jobID
Required
string | undefined

The ID of the Job for which Job log items will be retrieved.

maxResults
number | undefined

Maximum number of Job log items to retrieve.

nextToken
string | undefined

The token of the next Job log items to retrieve.

DescribeJobLogItemsCommand Output

See DescribeJobLogItemsCommandOutput for details

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

An array of Job log items.

nextToken
string | undefined

The token of the next Job log items to retrieve.

Throws

Name
Fault
Details
InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ThrottlingException
client

The request was denied due to request throttling.

UninitializedAccountException
client

The account performing the request has not been initialized.

ValidationException
client

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

DrsServiceException
Base exception class for all service exceptions from Drs service.