Struct Client 

pub struct Client { /* private fields */ }

Client for Braket

Client for invoking operations on Braket. Each operation on Braket is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_braket::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_braket::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelJob operation has a Client::cancel_job, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_job()
    .job_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn cancel_job(&self) -> CancelJobFluentBuilder

Constructs a fluent builder for the CancelJob operation.

• The fluent builder is configurable:
  • job_arn(impl Into<String>) / set_job_arn(Option<String>):
    required: true
    

    The ARN of the Amazon Braket hybrid job to cancel.

    
    
• On success, responds with CancelJobOutput with field(s):
  • job_arn(String):

    The ARN of the Amazon Braket job.

  • cancellation_status(CancellationStatus):

    The status of the hybrid job.

• On failure, responds with SdkError<CancelJobError>

impl Client

pub fn cancel_quantum_task(&self) -> CancelQuantumTaskFluentBuilder

Constructs a fluent builder for the CancelQuantumTask operation.

• The fluent builder is configurable:
  • quantum_task_arn(impl Into<String>) / set_quantum_task_arn(Option<String>):
    required: true
    

    The ARN of the quantum task to cancel.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    The client token associated with the cancellation request.

    
    
• On success, responds with CancelQuantumTaskOutput with field(s):
  • quantum_task_arn(String):

    The ARN of the quantum task.

  • cancellation_status(CancellationStatus):

    The status of the quantum task.

• On failure, responds with SdkError<CancelQuantumTaskError>

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

Constructs a fluent builder for the CreateJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    The client token associated with this request that guarantees that the request is idempotent.

    
    
  • algorithm_specification(AlgorithmSpecification) / set_algorithm_specification(Option<AlgorithmSpecification>):
    required: true
    

    Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

    
    
  • input_data_config(InputFileConfig) / set_input_data_config(Option<Vec::<InputFileConfig>>):
    required: false
    

    A list of parameters that specify the name and type of input data and where it is located.

    
    
  • output_data_config(JobOutputDataConfig) / set_output_data_config(Option<JobOutputDataConfig>):
    required: true
    

    The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.

    
    
  • checkpoint_config(JobCheckpointConfig) / set_checkpoint_config(Option<JobCheckpointConfig>):
    required: false
    

    Information about the output locations for hybrid job checkpoint data.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: true
    

    The name of the Amazon Braket hybrid job.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and hybrid job details to the users’ s3 buckets.

    
    
  • stopping_condition(JobStoppingCondition) / set_stopping_condition(Option<JobStoppingCondition>):
    required: false
    

    The user-defined criteria that specifies when a hybrid job stops running.

    
    
  • instance_config(InstanceConfig) / set_instance_config(Option<InstanceConfig>):
    required: true
    

    Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

    
    
  • hyper_parameters(impl Into<String>, impl Into<String>) / set_hyper_parameters(Option<HashMap::<String, String>>):
    required: false
    

    Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.

    Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

    
    
  • device_config(DeviceConfig) / set_device_config(Option<DeviceConfig>):
    required: true
    

    The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags to be added to the hybrid job you’re creating.

    
    
  • associations(Association) / set_associations(Option<Vec::<Association>>):
    required: false
    

    The list of Amazon Braket resources associated with the hybrid job.

    
    
• On success, responds with CreateJobOutput with field(s):
  • job_arn(String):

    The ARN of the Amazon Braket hybrid job created.

• On failure, responds with SdkError<CreateJobError>

impl Client

pub fn create_quantum_task(&self) -> CreateQuantumTaskFluentBuilder

Constructs a fluent builder for the CreateQuantumTask operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: true
    

    The client token associated with the request.

    
    
  • device_arn(impl Into<String>) / set_device_arn(Option<String>):
    required: true
    

    The ARN of the device to run the quantum task on.

    
    
  • device_parameters(impl Into<String>) / set_device_parameters(Option<String>):
    required: false
    

    The parameters for the device to run the quantum task on.

    
    
  • shots(i64) / set_shots(Option<i64>):
    required: true
    

    The number of shots to use for the quantum task.

    
    
  • output_s3_bucket(impl Into<String>) / set_output_s3_bucket(Option<String>):
    required: true
    

    The S3 bucket to store quantum task result files in.

    
    
  • output_s3_key_prefix(impl Into<String>) / set_output_s3_key_prefix(Option<String>):
    required: true
    

    The key prefix for the location in the S3 bucket to store quantum task results in.

    
    
  • action(impl Into<String>) / set_action(Option<String>):
    required: true
    

    The action associated with the quantum task.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags to be added to the quantum task you’re creating.

    
    
  • job_token(impl Into<String>) / set_job_token(Option<String>):
    required: false
    

    The token for an Amazon Braket hybrid job that associates it with the quantum task.

    
    
  • associations(Association) / set_associations(Option<Vec::<Association>>):
    required: false
    

    The list of Amazon Braket resources associated with the quantum task.

    
    
• On success, responds with CreateQuantumTaskOutput with field(s):
  • quantum_task_arn(String):

    The ARN of the quantum task created by the request.

• On failure, responds with SdkError<CreateQuantumTaskError>

impl Client

pub fn get_device(&self) -> GetDeviceFluentBuilder

Constructs a fluent builder for the GetDevice operation.

• The fluent builder is configurable:
  • device_arn(impl Into<String>) / set_device_arn(Option<String>):
    required: true
    

    The ARN of the device to retrieve.

    
    
• On success, responds with GetDeviceOutput with field(s):
  • device_arn(String):

    The ARN of the device.

  • device_name(String):

    The name of the device.

  • provider_name(String):

    The name of the partner company for the device.

  • device_type(DeviceType):

    The type of the device.

  • device_status(DeviceStatus):

    The status of the device.

  • device_capabilities(String):

    Details about the capabilities of the device.

  • device_queue_info(Option<Vec::<DeviceQueueInfo>>):

    The number of quantum tasks and hybrid jobs currently queued on the device.

• On failure, responds with SdkError<GetDeviceError>

impl Client

pub fn get_job(&self) -> GetJobFluentBuilder

Constructs a fluent builder for the GetJob operation.

• The fluent builder is configurable:
  • job_arn(impl Into<String>) / set_job_arn(Option<String>):
    required: true
    

    The ARN of the hybrid job to retrieve.

    
    
  • additional_attribute_names(HybridJobAdditionalAttributeName) / set_additional_attribute_names(Option<Vec::<HybridJobAdditionalAttributeName>>):
    required: false
    

    A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

    
    
• On success, responds with GetJobOutput with field(s):
  • status(JobPrimaryStatus):

    The status of the Amazon Braket hybrid job.

  • job_arn(String):

    The ARN of the Amazon Braket hybrid job.

  • role_arn(String):

    The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output results and other hybrid job details to the s3 buckets of a user.

  • failure_reason(Option<String>):

    A description of the reason why an Amazon Braket hybrid job failed, if it failed.

  • job_name(String):

    The name of the Amazon Braket hybrid job.

  • hyper_parameters(Option<HashMap::<String, String>>):

    Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

  • input_data_config(Option<Vec::<InputFileConfig>>):

    A list of parameters that specify the name and type of input data and where it is located.

  • output_data_config(Option<JobOutputDataConfig>):

    The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.

  • stopping_condition(Option<JobStoppingCondition>):

    The user-defined criteria that specifies when to stop a running hybrid job.

  • checkpoint_config(Option<JobCheckpointConfig>):

    Information about the output locations for hybrid job checkpoint data.

  • algorithm_specification(Option<AlgorithmSpecification>):

    Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

  • instance_config(Option<InstanceConfig>):

    The resource instances to use while running the hybrid job on Amazon Braket.

  • created_at(DateTime):

    The time at which the Amazon Braket hybrid job was created.

  • started_at(Option<DateTime>):

    The time at which the Amazon Braket hybrid job was started.

  • ended_at(Option<DateTime>):

    The time at which the Amazon Braket hybrid job ended.

  • billable_duration(Option<i32>):

    The billable time for which the Amazon Braket hybrid job used to complete.

  • device_config(Option<DeviceConfig>):

    The primary device used by the Amazon Braket hybrid job.

  • events(Option<Vec::<JobEventDetails>>):

    Details about the time and type of events occurred related to the Amazon Braket hybrid job.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with this hybrid job.

  • queue_info(Option<HybridJobQueueInfo>):

    Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames“ field in the GetJob API request.

  • associations(Option<Vec::<Association>>):

    The list of Amazon Braket resources associated with the hybrid job.

• On failure, responds with SdkError<GetJobError>

impl Client

pub fn get_quantum_task(&self) -> GetQuantumTaskFluentBuilder

Constructs a fluent builder for the GetQuantumTask operation.

• The fluent builder is configurable:
  • quantum_task_arn(impl Into<String>) / set_quantum_task_arn(Option<String>):
    required: true
    

    The ARN of the quantum task to retrieve.

    
    
  • additional_attribute_names(QuantumTaskAdditionalAttributeName) / set_additional_attribute_names(Option<Vec::<QuantumTaskAdditionalAttributeName>>):
    required: false
    

    A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.

    
    
• On success, responds with GetQuantumTaskOutput with field(s):
  • quantum_task_arn(String):

    The ARN of the quantum task.

  • status(QuantumTaskStatus):

    The status of the quantum task.

  • failure_reason(Option<String>):

    The reason that a quantum task failed.

  • device_arn(String):

    The ARN of the device the quantum task was run on.

  • device_parameters(String):

    The parameters for the device on which the quantum task ran.

  • shots(i64):

    The number of shots used in the quantum task.

  • output_s3_bucket(String):

    The S3 bucket where quantum task results are stored.

  • output_s3_directory(String):

    The folder in the S3 bucket where quantum task results are stored.

  • created_at(DateTime):

    The time at which the quantum task was created.

  • ended_at(Option<DateTime>):

    The time at which the quantum task ended.

  • tags(Option<HashMap::<String, String>>):

    The tags that belong to this quantum task.

  • job_arn(Option<String>):

    The ARN of the Amazon Braket job associated with the quantum task.

  • queue_info(Option<QuantumTaskQueueInfo>):

    Queue information for the requested quantum task. Only returned if QueueInfo is specified in the additionalAttributeNames“ field in the GetQuantumTask API request.

  • associations(Option<Vec::<Association>>):

    The list of Amazon Braket resources associated with the quantum task.

  • num_successful_shots(Option<i64>):

    The number of successful shots for the quantum task. This is available after a successfully completed quantum task.

  • action_metadata(Option<ActionMetadata>):

    Metadata about the action performed by the quantum task, including information about the type of action and program counts.

• On failure, responds with SdkError<GetQuantumTaskError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Specify the resourceArn for the resource whose tags to display.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Displays the key, value pairs of tags associated with this resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn search_devices(&self) -> SearchDevicesFluentBuilder

Constructs a fluent builder for the SearchDevices operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • filters(SearchDevicesFilter) / set_filters(Option<Vec::<SearchDevicesFilter>>):
    required: true
    

    Array of SearchDevicesFilter objects to use when searching for devices.

    
    
• On success, responds with SearchDevicesOutput with field(s):
  • devices(Vec::<DeviceSummary>):

    An array of DeviceSummary objects for devices that match the specified filter values.

  • next_token(Option<String>):

    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 search where the previous request ended.

• On failure, responds with SdkError<SearchDevicesError>

impl Client

pub fn search_jobs(&self) -> SearchJobsFluentBuilder

Constructs a fluent builder for the SearchJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • filters(SearchJobsFilter) / set_filters(Option<Vec::<SearchJobsFilter>>):
    required: true
    

    Array of SearchJobsFilter objects to use when searching for hybrid jobs.

    
    
• On success, responds with SearchJobsOutput with field(s):
  • jobs(Vec::<JobSummary>):

    An array of JobSummary objects for devices that match the specified filter values.

  • next_token(Option<String>):

    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 search where the previous request ended.

• On failure, responds with SdkError<SearchJobsError>

impl Client

pub fn search_quantum_tasks(&self) -> SearchQuantumTasksFluentBuilder

Constructs a fluent builder for the SearchQuantumTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of results to return in the response.

    
    
  • filters(SearchQuantumTasksFilter) / set_filters(Option<Vec::<SearchQuantumTasksFilter>>):
    required: true
    

    Array of SearchQuantumTasksFilter objects to use when searching for quantum tasks.

    
    
• On success, responds with SearchQuantumTasksOutput with field(s):
  • quantum_tasks(Vec::<QuantumTaskSummary>):

    An array of QuantumTaskSummary objects for quantum tasks that match the specified filters.

  • next_token(Option<String>):

    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 search where the previous request ended.

• On failure, responds with SdkError<SearchQuantumTasksError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Specify the resourceArn of the resource to which a tag will be added.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Specify the tags to add to the resource. Tags can be specified as a key-value map.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    Specify the resourceArn for the resource from which to remove the tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Specify the keys for the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.