Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class GetJobCommandProtected

Retrieves the specified Amazon Braket job.

Example

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

import { BraketClient, GetJobCommand } from "@aws-sdk/client-braket"; // ES Modules import
// const { BraketClient, GetJobCommand } = require("@aws-sdk/client-braket"); // CommonJS import
const client = new BraketClient(config);
const input = { // GetJobRequest
jobArn: "STRING_VALUE", // required
additionalAttributeNames: [ // HybridJobAdditionalAttributeNamesList
"STRING_VALUE",
],
};
const command = new GetJobCommand(input);
const response = await client.send(command);
// { // GetJobResponse
// status: "STRING_VALUE", // required
// jobArn: "STRING_VALUE", // required
// roleArn: "STRING_VALUE", // required
// failureReason: "STRING_VALUE",
// jobName: "STRING_VALUE", // required
// hyperParameters: { // HyperParameters
// "<keys>": "STRING_VALUE",
// },
// inputDataConfig: [ // InputConfigList
// { // InputFileConfig
// channelName: "STRING_VALUE", // required
// contentType: "STRING_VALUE",
// dataSource: { // DataSource
// s3DataSource: { // S3DataSource
// s3Uri: "STRING_VALUE", // required
// },
// },
// },
// ],
// outputDataConfig: { // JobOutputDataConfig
// kmsKeyId: "STRING_VALUE",
// s3Path: "STRING_VALUE", // required
// },
// stoppingCondition: { // JobStoppingCondition
// maxRuntimeInSeconds: Number("int"),
// },
// checkpointConfig: { // JobCheckpointConfig
// localPath: "STRING_VALUE",
// s3Uri: "STRING_VALUE", // required
// },
// algorithmSpecification: { // AlgorithmSpecification
// scriptModeConfig: { // ScriptModeConfig
// entryPoint: "STRING_VALUE", // required
// s3Uri: "STRING_VALUE", // required
// compressionType: "STRING_VALUE",
// },
// containerImage: { // ContainerImage
// uri: "STRING_VALUE", // required
// },
// },
// instanceConfig: { // InstanceConfig
// instanceType: "STRING_VALUE", // required
// volumeSizeInGb: Number("int"), // required
// instanceCount: Number("int"),
// },
// createdAt: new Date("TIMESTAMP"), // required
// startedAt: new Date("TIMESTAMP"),
// endedAt: new Date("TIMESTAMP"),
// billableDuration: Number("int"),
// deviceConfig: { // DeviceConfig
// device: "STRING_VALUE", // required
// },
// events: [ // JobEvents
// { // JobEventDetails
// eventType: "STRING_VALUE",
// timeOfEvent: new Date("TIMESTAMP"),
// message: "STRING_VALUE",
// },
// ],
// tags: { // TagsMap
// "<keys>": "STRING_VALUE",
// },
// queueInfo: { // HybridJobQueueInfo
// queue: "STRING_VALUE", // required
// position: "STRING_VALUE", // required
// message: "STRING_VALUE",
// },
// };

Param

GetJobCommandInput

Returns

GetJobCommandOutput

See

Throws

AccessDeniedException (client fault)

You do not have sufficient access to perform this action.

Throws

InternalServiceException (server fault)

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

Throws

ResourceNotFoundException (client fault)

The specified resource was not found.

Throws

ThrottlingException (client fault)

The throttling rate limit is met.

Throws

ValidationException (client fault)

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

Throws

BraketServiceException

Base exception class for all service exceptions from Braket service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods