View Source AWS.Braket (aws-elixir v1.0.9)

The Amazon Braket API Reference provides information about the operations and structures supported by Amazon Braket.

To learn about the permissions required to call an Amazon Braket API action, see Actions, resources, and condition keys for Amazon Braket. Amazon Braket Python SDK and the AWS Command Line Interface can be used to make discovery and creation of API calls easier. For more information about Amazon Braket features, see What is Amazon Braket? and important terms and concepts in the Amazon Braket Developer Guide.

in-this-guide

In this guide:

*

*

  • CommonParameters

  • CommonErrors

available-languages-for-aws-sdk

Available languages for AWS SDK:

.NET C++

Java JavaScript

PHP Python (Boto)

* Ruby

code-examples-from-the-amazon-braket-tutorials-github-repository

Code examples from the Amazon Braket Tutorials GitHub repository:

Link to this section Summary

Functions

Cancels an Amazon Braket hybrid job.

Creates an Amazon Braket hybrid job.

Retrieves the devices available in Amazon Braket.

Retrieves the specified Amazon Braket hybrid job.

Shows the tags associated with this resource.

Searches for devices using the specified filters.

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

Searches for tasks that match the specified filter values.

Add a tag to the specified resource.

Link to this section Functions

Link to this function

cancel_job(client, job_arn, input, options \\ [])

View Source

Cancels an Amazon Braket hybrid job.

Link to this function

cancel_quantum_task(client, quantum_task_arn, input, options \\ [])

View Source

Cancels the specified task.

Link to this function

create_job(client, input, options \\ [])

View Source

Creates an Amazon Braket hybrid job.

Link to this function

create_quantum_task(client, input, options \\ [])

View Source

Creates a quantum task.

Link to this function

get_device(client, device_arn, options \\ [])

View Source

Retrieves the devices available in Amazon Braket.

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.

Link to this function

get_job(client, job_arn, additional_attribute_names \\ nil, options \\ [])

View Source

Retrieves the specified Amazon Braket hybrid job.

Link to this function

get_quantum_task(client, quantum_task_arn, additional_attribute_names \\ nil, options \\ [])

View Source

Retrieves the specified quantum task.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Shows the tags associated with this resource.

Link to this function

search_devices(client, input, options \\ [])

View Source

Searches for devices using the specified filters.

Link to this function

search_jobs(client, input, options \\ [])

View Source

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

Link to this function

search_quantum_tasks(client, input, options \\ [])

View Source

Searches for tasks that match the specified filter values.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Add a tag to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Remove tags from a resource.