Braket
This page documents function available when using the Braket
module, created with @service Braket
.
Index
Main.Braket.cancel_quantum_task
Main.Braket.create_quantum_task
Main.Braket.get_device
Main.Braket.get_quantum_task
Main.Braket.list_tags_for_resource
Main.Braket.search_devices
Main.Braket.search_quantum_tasks
Main.Braket.tag_resource
Main.Braket.untag_resource
Documentation
Main.Braket.cancel_quantum_task
— Methodcancel_quantum_task(client_token, quantum_task_arn)
cancel_quantum_task(client_token, quantum_task_arn, params::Dict{String,<:Any})
Cancels the specified task.
Arguments
client_token
: The client token associated with the request.quantum_task_arn
: The ARN of the task to cancel.
Main.Braket.create_quantum_task
— Methodcreate_quantum_task(action, client_token, device_arn, output_s3_bucket, output_s3_key_prefix, shots)
create_quantum_task(action, client_token, device_arn, output_s3_bucket, output_s3_key_prefix, shots, params::Dict{String,<:Any})
Creates a quantum task.
Arguments
action
: The action associated with the task.client_token
: The client token associated with the request.device_arn
: The ARN of the device to run the task on.output_s3_bucket
: The S3 bucket to store task result files in.output_s3_key_prefix
: The key prefix for the location in the S3 bucket to store task results in.shots
: The number of shots to use for the task.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"deviceParameters"
: The parameters for the device to run the task on."tags"
: Tags to be added to the quantum task you're creating.
Main.Braket.get_device
— Methodget_device(device_arn)
get_device(device_arn, params::Dict{String,<:Any})
Retrieves the devices available in Amazon Braket.
Arguments
device_arn
: The ARN of the device to retrieve.
Main.Braket.get_quantum_task
— Methodget_quantum_task(quantum_task_arn)
get_quantum_task(quantum_task_arn, params::Dict{String,<:Any})
Retrieves the specified quantum task.
Arguments
quantum_task_arn
: the ARN of the task to retrieve.
Main.Braket.list_tags_for_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Shows the tags associated with this resource.
Arguments
resource_arn
: Specify the resourceArn for the resource whose tags to display.
Main.Braket.search_devices
— Methodsearch_devices(filters)
search_devices(filters, params::Dict{String,<:Any})
Searches for devices using the specified filters.
Arguments
filters
: The filter values to use to search for a device.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: The maximum number of results to return in the response."nextToken"
: 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.
Main.Braket.search_quantum_tasks
— Methodsearch_quantum_tasks(filters)
search_quantum_tasks(filters, params::Dict{String,<:Any})
Searches for tasks that match the specified filter values.
Arguments
filters
: Array of SearchQuantumTasksFilter objects.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"maxResults"
: Maximum number of results to return in the response."nextToken"
: 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.
Main.Braket.tag_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Add a tag to the specified resource.
Arguments
resource_arn
: Specify the resourceArn of the resource to which a tag will be added.tags
: Specify the tags to add to the resource.
Main.Braket.untag_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Remove tags from a resource.
Arguments
resource_arn
: Specify the resourceArn for the resource from which to remove the tags.tag_keys
: pecify the keys for the tags to remove from the resource.