braket.d.ts
12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Braket extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Braket.Types.ClientConfiguration)
config: Config & Braket.Types.ClientConfiguration;
/**
* Cancels the specified task.
*/
cancelQuantumTask(params: Braket.Types.CancelQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.CancelQuantumTaskResponse) => void): Request<Braket.Types.CancelQuantumTaskResponse, AWSError>;
/**
* Cancels the specified task.
*/
cancelQuantumTask(callback?: (err: AWSError, data: Braket.Types.CancelQuantumTaskResponse) => void): Request<Braket.Types.CancelQuantumTaskResponse, AWSError>;
/**
* Creates a quantum task.
*/
createQuantumTask(params: Braket.Types.CreateQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.CreateQuantumTaskResponse) => void): Request<Braket.Types.CreateQuantumTaskResponse, AWSError>;
/**
* Creates a quantum task.
*/
createQuantumTask(callback?: (err: AWSError, data: Braket.Types.CreateQuantumTaskResponse) => void): Request<Braket.Types.CreateQuantumTaskResponse, AWSError>;
/**
* Retrieves the devices available in Amazon Braket.
*/
getDevice(params: Braket.Types.GetDeviceRequest, callback?: (err: AWSError, data: Braket.Types.GetDeviceResponse) => void): Request<Braket.Types.GetDeviceResponse, AWSError>;
/**
* Retrieves the devices available in Amazon Braket.
*/
getDevice(callback?: (err: AWSError, data: Braket.Types.GetDeviceResponse) => void): Request<Braket.Types.GetDeviceResponse, AWSError>;
/**
* Retrieves the specified quantum task.
*/
getQuantumTask(params: Braket.Types.GetQuantumTaskRequest, callback?: (err: AWSError, data: Braket.Types.GetQuantumTaskResponse) => void): Request<Braket.Types.GetQuantumTaskResponse, AWSError>;
/**
* Retrieves the specified quantum task.
*/
getQuantumTask(callback?: (err: AWSError, data: Braket.Types.GetQuantumTaskResponse) => void): Request<Braket.Types.GetQuantumTaskResponse, AWSError>;
/**
* Searches for devices using the specified filters.
*/
searchDevices(params: Braket.Types.SearchDevicesRequest, callback?: (err: AWSError, data: Braket.Types.SearchDevicesResponse) => void): Request<Braket.Types.SearchDevicesResponse, AWSError>;
/**
* Searches for devices using the specified filters.
*/
searchDevices(callback?: (err: AWSError, data: Braket.Types.SearchDevicesResponse) => void): Request<Braket.Types.SearchDevicesResponse, AWSError>;
/**
* Searches for tasks that match the specified filter values.
*/
searchQuantumTasks(params: Braket.Types.SearchQuantumTasksRequest, callback?: (err: AWSError, data: Braket.Types.SearchQuantumTasksResponse) => void): Request<Braket.Types.SearchQuantumTasksResponse, AWSError>;
/**
* Searches for tasks that match the specified filter values.
*/
searchQuantumTasks(callback?: (err: AWSError, data: Braket.Types.SearchQuantumTasksResponse) => void): Request<Braket.Types.SearchQuantumTasksResponse, AWSError>;
}
declare namespace Braket {
export interface CancelQuantumTaskRequest {
/**
* The client token associated with the request.
*/
clientToken: String64;
/**
* The ARN of the task to cancel.
*/
quantumTaskArn: QuantumTaskArn;
}
export interface CancelQuantumTaskResponse {
/**
* The status of the cancellation request.
*/
cancellationStatus: CancellationStatus;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
}
export type CancellationStatus = "CANCELLED"|"CANCELLING"|string;
export interface CreateQuantumTaskRequest {
/**
* The action associated with the task.
*/
action: JsonValue;
/**
* The client token associated with the request.
*/
clientToken: String64;
/**
* The ARN of the device to run the task on.
*/
deviceArn: DeviceArn;
/**
* The parameters for the device to run the task on.
*/
deviceParameters?: CreateQuantumTaskRequestdeviceParametersJsonValue;
/**
* The S3 bucket to store task result files in.
*/
outputS3Bucket: CreateQuantumTaskRequestoutputS3BucketString;
/**
* The key prefix for the location in the S3 bucket to store task results in.
*/
outputS3KeyPrefix: CreateQuantumTaskRequestoutputS3KeyPrefixString;
/**
* The number of shots to use for the task.
*/
shots: CreateQuantumTaskRequestshotsLong;
}
export type CreateQuantumTaskRequestdeviceParametersJsonValue = string;
export type CreateQuantumTaskRequestoutputS3BucketString = string;
export type CreateQuantumTaskRequestoutputS3KeyPrefixString = string;
export type CreateQuantumTaskRequestshotsLong = number;
export interface CreateQuantumTaskResponse {
/**
* The ARN of the task created by the request.
*/
quantumTaskArn: QuantumTaskArn;
}
export type DeviceArn = string;
export type DeviceStatus = "OFFLINE"|"ONLINE"|string;
export interface DeviceSummary {
/**
* The ARN of the device.
*/
deviceArn: DeviceArn;
/**
* The name of the device.
*/
deviceName: String;
/**
* The status of the device.
*/
deviceStatus: DeviceStatus;
/**
* The type of the device.
*/
deviceType: DeviceType;
/**
* The provider of the device.
*/
providerName: String;
}
export type DeviceSummaryList = DeviceSummary[];
export type DeviceType = "QPU"|"SIMULATOR"|string;
export interface GetDeviceRequest {
/**
* The ARN of the device to retrieve.
*/
deviceArn: DeviceArn;
}
export interface GetDeviceResponse {
/**
* The ARN of the device.
*/
deviceArn: DeviceArn;
/**
* Details about the capabilities of the device.
*/
deviceCapabilities: JsonValue;
/**
* The name of the device.
*/
deviceName: String;
/**
* The status of the device.
*/
deviceStatus: DeviceStatus;
/**
* The type of the device.
*/
deviceType: DeviceType;
/**
* The name of the partner company for the device.
*/
providerName: String;
}
export interface GetQuantumTaskRequest {
/**
* the ARN of the task to retrieve.
*/
quantumTaskArn: QuantumTaskArn;
}
export interface GetQuantumTaskResponse {
/**
* The time at which the task was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* The ARN of the device the task was run on.
*/
deviceArn: DeviceArn;
/**
* The parameters for the device on which the task ran.
*/
deviceParameters: JsonValue;
/**
* The time at which the task ended.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* The reason that a task failed.
*/
failureReason?: String;
/**
* The S3 bucket where task results are stored.
*/
outputS3Bucket: String;
/**
* The folder in the S3 bucket where task results are stored.
*/
outputS3Directory: String;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
/**
* The number of shots used in the task.
*/
shots: Long;
/**
* The status of the task.
*/
status: QuantumTaskStatus;
}
export type JsonValue = string;
export type Long = number;
export type QuantumTaskArn = string;
export type QuantumTaskStatus = "CANCELLED"|"CANCELLING"|"COMPLETED"|"CREATED"|"FAILED"|"QUEUED"|"RUNNING"|string;
export interface QuantumTaskSummary {
/**
* The time at which the task was created.
*/
createdAt: SyntheticTimestamp_date_time;
/**
* The ARN of the device the task ran on.
*/
deviceArn: DeviceArn;
/**
* The time at which the task finished.
*/
endedAt?: SyntheticTimestamp_date_time;
/**
* The S3 bucket where the task result file is stored..
*/
outputS3Bucket: String;
/**
* The folder in the S3 bucket where the task result file is stored.
*/
outputS3Directory: String;
/**
* The ARN of the task.
*/
quantumTaskArn: QuantumTaskArn;
/**
* The shots used for the task.
*/
shots: Long;
/**
* The status of the task.
*/
status: QuantumTaskStatus;
}
export type QuantumTaskSummaryList = QuantumTaskSummary[];
export interface SearchDevicesFilter {
/**
* The name to use to filter results.
*/
name: SearchDevicesFilternameString;
/**
* The values to use to filter results.
*/
values: SearchDevicesFiltervaluesString256List;
}
export type SearchDevicesFilternameString = string;
export type SearchDevicesFiltervaluesString256List = String256[];
export interface SearchDevicesRequest {
/**
* The filter values to use to search for a device.
*/
filters: SearchDevicesRequestfiltersSearchDevicesFilterList;
/**
* The maximum number of results to return in the response.
*/
maxResults?: SearchDevicesRequestmaxResultsInteger;
/**
* A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.
*/
nextToken?: String;
}
export type SearchDevicesRequestfiltersSearchDevicesFilterList = SearchDevicesFilter[];
export type SearchDevicesRequestmaxResultsInteger = number;
export interface SearchDevicesResponse {
/**
* An array of DeviceSummary objects for devices that match the specified filter values.
*/
devices: DeviceSummaryList;
/**
* A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
*/
nextToken?: String;
}
export interface SearchQuantumTasksFilter {
/**
* The name of the device used for the task.
*/
name: String64;
/**
* An operator to use in the filter.
*/
operator: SearchQuantumTasksFilterOperator;
/**
* The values to use for the filter.
*/
values: SearchQuantumTasksFiltervaluesString256List;
}
export type SearchQuantumTasksFilterOperator = "BETWEEN"|"EQUAL"|"GT"|"GTE"|"LT"|"LTE"|string;
export type SearchQuantumTasksFiltervaluesString256List = String256[];
export interface SearchQuantumTasksRequest {
/**
* Array of SearchQuantumTasksFilter objects.
*/
filters: SearchQuantumTasksRequestfiltersSearchQuantumTasksFilterList;
/**
* Maximum number of results to return in the response.
*/
maxResults?: SearchQuantumTasksRequestmaxResultsInteger;
/**
* A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.
*/
nextToken?: String;
}
export type SearchQuantumTasksRequestfiltersSearchQuantumTasksFilterList = SearchQuantumTasksFilter[];
export type SearchQuantumTasksRequestmaxResultsInteger = number;
export interface SearchQuantumTasksResponse {
/**
* A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.
*/
nextToken?: String;
/**
* An array of QuantumTaskSummary objects for tasks that match the specified filters.
*/
quantumTasks: QuantumTaskSummaryList;
}
export type String = string;
export type String256 = string;
export type String64 = string;
export type SyntheticTimestamp_date_time = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-09-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Braket client.
*/
export import Types = Braket;
}
export = Braket;