Skip to content

Commit e947a9a

Browse files
author
AWS
committed
Braket Update: Adds ExperimentalCapabilities field to CreateQuantumTask request and GetQuantumTask response objects. Enables use of experimental software capabilities when creating quantum tasks.
1 parent d92962d commit e947a9a

File tree

2 files changed

+46
-8
lines changed

2 files changed

+46
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Braket",
4+
"contributor": "",
5+
"description": "Adds ExperimentalCapabilities field to CreateQuantumTask request and GetQuantumTask response objects. Enables use of experimental software capabilities when creating quantum tasks."
6+
}

services/braket/src/main/resources/codegen-resources/service-2.json

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,8 @@
110110
{"shape":"InternalServiceException"},
111111
{"shape":"ValidationException"}
112112
],
113-
"documentation":"<p>Retrieves the devices available in Amazon Braket.</p> <note> <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p> </note>"
113+
"documentation":"<p>Retrieves the devices available in Amazon Braket.</p> <note> <p>For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.</p> </note>",
114+
"readonly":true
114115
},
115116
"GetJob":{
116117
"name":"GetJob",
@@ -128,7 +129,8 @@
128129
{"shape":"InternalServiceException"},
129130
{"shape":"ValidationException"}
130131
],
131-
"documentation":"<p>Retrieves the specified Amazon Braket hybrid job.</p>"
132+
"documentation":"<p>Retrieves the specified Amazon Braket hybrid job.</p>",
133+
"readonly":true
132134
},
133135
"GetQuantumTask":{
134136
"name":"GetQuantumTask",
@@ -146,7 +148,8 @@
146148
{"shape":"InternalServiceException"},
147149
{"shape":"ValidationException"}
148150
],
149-
"documentation":"<p>Retrieves the specified quantum task.</p>"
151+
"documentation":"<p>Retrieves the specified quantum task.</p>",
152+
"readonly":true
150153
},
151154
"ListTagsForResource":{
152155
"name":"ListTagsForResource",
@@ -162,7 +165,8 @@
162165
{"shape":"InternalServiceException"},
163166
{"shape":"ValidationException"}
164167
],
165-
"documentation":"<p>Shows the tags associated with this resource.</p>"
168+
"documentation":"<p>Shows the tags associated with this resource.</p>",
169+
"readonly":true
166170
},
167171
"SearchDevices":{
168172
"name":"SearchDevices",
@@ -179,7 +183,8 @@
179183
{"shape":"InternalServiceException"},
180184
{"shape":"ValidationException"}
181185
],
182-
"documentation":"<p>Searches for devices using the specified filters.</p>"
186+
"documentation":"<p>Searches for devices using the specified filters.</p>",
187+
"readonly":true
183188
},
184189
"SearchJobs":{
185190
"name":"SearchJobs",
@@ -213,7 +218,8 @@
213218
{"shape":"InternalServiceException"},
214219
{"shape":"ValidationException"}
215220
],
216-
"documentation":"<p>Searches for tasks that match the specified filter values.</p>"
221+
"documentation":"<p>Searches for tasks that match the specified filter values.</p>",
222+
"readonly":true
217223
},
218224
"TagResource":{
219225
"name":"TagResource",
@@ -272,11 +278,11 @@
272278
},
273279
"programCount":{
274280
"shape":"Long",
275-
"documentation":"<p>The number of programs in a program set. This is only available for a Program Set.</p>"
281+
"documentation":"<p>The number of programs in a program set. This is only available for a program set.</p>"
276282
},
277283
"executableCount":{
278284
"shape":"Long",
279-
"documentation":"<p>The number of executables in a program set. This is only available for a Program Set.</p>"
285+
"documentation":"<p>The number of executables in a program set. This is only available for a program set.</p>"
280286
}
281287
},
282288
"documentation":"<p>Contains metadata about the quantum task action, including the action type and program statistics.</p>"
@@ -576,6 +582,10 @@
576582
"associations":{
577583
"shape":"CreateQuantumTaskRequestAssociationsList",
578584
"documentation":"<p>The list of Amazon Braket resources associated with the quantum task.</p>"
585+
},
586+
"experimentalCapabilities":{
587+
"shape":"ExperimentalCapabilities",
588+
"documentation":"<p>Enable experimental capabilities for the quantum task.</p>"
579589
}
580590
}
581591
},
@@ -744,6 +754,24 @@
744754
"SIMULATOR"
745755
]
746756
},
757+
"ExperimentalCapabilities":{
758+
"type":"structure",
759+
"members":{
760+
"enabled":{
761+
"shape":"ExperimentalCapabilitiesEnablementType",
762+
"documentation":"<p>Enabled experimental capabilities.</p>"
763+
}
764+
},
765+
"documentation":"<p>Enabled experimental capabilities for quantum hardware. Note that the use of these features may impact device capabilities and performance beyond its standard specifications.</p>",
766+
"union":true
767+
},
768+
"ExperimentalCapabilitiesEnablementType":{
769+
"type":"string",
770+
"enum":[
771+
"ALL",
772+
"NONE"
773+
]
774+
},
747775
"GetDeviceRequest":{
748776
"type":"structure",
749777
"required":["deviceArn"],
@@ -1016,6 +1044,10 @@
10161044
"actionMetadata":{
10171045
"shape":"ActionMetadata",
10181046
"documentation":"<p>Metadata about the action performed by the quantum task, including information about the type of action and program counts.</p>"
1047+
},
1048+
"experimentalCapabilities":{
1049+
"shape":"ExperimentalCapabilities",
1050+
"documentation":"<p>Enabled experimental capabilities for the quantum task, if any.</p>"
10191051
}
10201052
}
10211053
},

0 commit comments

Comments
 (0)