Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class SearchJobsCommandProtected

Searches for Amazon Braket jobs that match the specified filter values.

Example

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

import { BraketClient, SearchJobsCommand } from "@aws-sdk/client-braket"; // ES Modules import
// const { BraketClient, SearchJobsCommand } = require("@aws-sdk/client-braket"); // CommonJS import
const client = new BraketClient(config);
const input = { // SearchJobsRequest
nextToken: "STRING_VALUE",
maxResults: Number("int"),
filters: [ // SearchJobsFilterList // required
{ // SearchJobsFilter
name: "STRING_VALUE", // required
values: [ // String256List // required
"STRING_VALUE",
],
operator: "STRING_VALUE", // required
},
],
};
const command = new SearchJobsCommand(input);
const response = await client.send(command);
// { // SearchJobsResponse
// jobs: [ // JobSummaryList // required
// { // JobSummary
// status: "STRING_VALUE", // required
// jobArn: "STRING_VALUE", // required
// jobName: "STRING_VALUE", // required
// device: "STRING_VALUE", // required
// createdAt: new Date("TIMESTAMP"), // required
// startedAt: new Date("TIMESTAMP"),
// endedAt: new Date("TIMESTAMP"),
// tags: { // TagsMap
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// nextToken: "STRING_VALUE",
// };

Param

SearchJobsCommandInput

Returns

SearchJobsCommandOutput

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

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