Struct aws_sdk_braket::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_braket::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_braket::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_braket::Client::from_conf(config);
Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the CancelJob
operation.
- The fluent builder is configurable:
job_arn(impl Into<String>)
/set_job_arn(Option<String>)
:The ARN of the Amazon Braket job to cancel.
- On success, responds with
CancelJobOutput
with field(s):job_arn(Option<String>)
:The ARN of the Amazon Braket job.
cancellation_status(Option<CancellationStatus>)
:The status of the job cancellation request.
- On failure, responds with
SdkError<CancelJobError>
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>)
:The ARN of the task to cancel.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The client token associated with the request.
- On success, responds with
CancelQuantumTaskOutput
with field(s):quantum_task_arn(Option<String>)
:The ARN of the task.
cancellation_status(Option<CancellationStatus>)
:The status of the cancellation request.
- On failure, responds with
SdkError<CancelQuantumTaskError>
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique token that guarantees that the call to this API is idempotent.
algorithm_specification(AlgorithmSpecification)
/set_algorithm_specification(Option<AlgorithmSpecification>)
: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(Vec<InputFileConfig>)
/set_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(JobOutputDataConfig)
/set_output_data_config(Option<JobOutputDataConfig>)
:The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
checkpoint_config(JobCheckpointConfig)
/set_checkpoint_config(Option<JobCheckpointConfig>)
:Information about the output locations for job checkpoint data.
job_name(impl Into<String>)
/set_job_name(Option<String>)
:The name of the Amazon Braket job.
role_arn(impl Into<String>)
/set_role_arn(Option<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 resources to the users’ s3 buckets.
stopping_condition(JobStoppingCondition)
/set_stopping_condition(Option<JobStoppingCondition>)
:The user-defined criteria that specifies when a job stops running.
instance_config(InstanceConfig)
/set_instance_config(Option<InstanceConfig>)
:Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
hyper_parameters(HashMap<String, String>)
/set_hyper_parameters(Option<HashMap<String, String>>)
:Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
device_config(DeviceConfig)
/set_device_config(Option<DeviceConfig>)
:The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
- On success, responds with
CreateJobOutput
with field(s):job_arn(Option<String>)
:The ARN of the Amazon Braket job created.
- On failure, responds with
SdkError<CreateJobError>
Constructs a fluent builder for the CreateQuantumTask
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:The client token associated with the request.
device_arn(impl Into<String>)
/set_device_arn(Option<String>)
:The ARN of the device to run the task on.
device_parameters(impl Into<String>)
/set_device_parameters(Option<String>)
:The parameters for the device to run the task on.
shots(i64)
/set_shots(Option<i64>)
:The number of shots to use for the task.
output_s3_bucket(impl Into<String>)
/set_output_s3_bucket(Option<String>)
:The S3 bucket to store task result files in.
output_s3_key_prefix(impl Into<String>)
/set_output_s3_key_prefix(Option<String>)
:The key prefix for the location in the S3 bucket to store task results in.
action(impl Into<String>)
/set_action(Option<String>)
:The action associated with the task.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Tags to be added to the quantum task you’re creating.
job_token(impl Into<String>)
/set_job_token(Option<String>)
:The token for an Amazon Braket job that associates it with the quantum task.
- On success, responds with
CreateQuantumTaskOutput
with field(s):quantum_task_arn(Option<String>)
:The ARN of the task created by the request.
- On failure, responds with
SdkError<CreateQuantumTaskError>
Constructs a fluent builder for the GetDevice
operation.
- The fluent builder is configurable:
device_arn(impl Into<String>)
/set_device_arn(Option<String>)
:The ARN of the device to retrieve.
- On success, responds with
GetDeviceOutput
with field(s):device_arn(Option<String>)
:The ARN of the device.
device_name(Option<String>)
:The name of the device.
provider_name(Option<String>)
:The name of the partner company for the device.
device_type(Option<DeviceType>)
:The type of the device.
device_status(Option<DeviceStatus>)
:The status of the device.
device_capabilities(Option<String>)
:Details about the capabilities of the device.
- On failure, responds with
SdkError<GetDeviceError>
Constructs a fluent builder for the GetJob
operation.
- The fluent builder is configurable:
job_arn(impl Into<String>)
/set_job_arn(Option<String>)
:The ARN of the job to retrieve.
- On success, responds with
GetJobOutput
with field(s):status(Option<JobPrimaryStatus>)
:The status of the Amazon Braket job.
job_arn(Option<String>)
:The ARN of the Amazon Braket job.
role_arn(Option<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 resources to the s3 buckets of a user.
failure_reason(Option<String>)
:A description of the reason why an Amazon Braket job failed, if it failed.
job_name(Option<String>)
:The name of the Amazon Braket job.
hyper_parameters(Option<HashMap<String, String>>)
:Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string 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 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 job running.
checkpoint_config(Option<JobCheckpointConfig>)
:Information about the output locations for job checkpoint data.
algorithm_specification(Option<AlgorithmSpecification>)
:Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
instance_config(Option<InstanceConfig>)
:The resource instances to use while running the hybrid job on Amazon Braket.
created_at(Option<DateTime>)
:The date and time that the Amazon Braket job was created.
started_at(Option<DateTime>)
:The date and time that the Amazon Braket job was started.
ended_at(Option<DateTime>)
:The date and time that the Amazon Braket job ended.
billable_duration(Option<i32>)
:The billable time the Amazon Braket job used to complete.
device_config(Option<DeviceConfig>)
:The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
events(Option<Vec<JobEventDetails>>)
:Details about the type and time events occurred related to the Amazon Braket job.
tags(Option<HashMap<String, String>>)
:A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
- On failure, responds with
SdkError<GetJobError>
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>)
:the ARN of the task to retrieve.
- On success, responds with
GetQuantumTaskOutput
with field(s):quantum_task_arn(Option<String>)
:The ARN of the task.
status(Option<QuantumTaskStatus>)
:The status of the task.
failure_reason(Option<String>)
:The reason that a task failed.
device_arn(Option<String>)
:The ARN of the device the task was run on.
device_parameters(Option<String>)
:The parameters for the device on which the task ran.
shots(Option<i64>)
:The number of shots used in the task.
output_s3_bucket(Option<String>)
:The S3 bucket where task results are stored.
output_s3_directory(Option<String>)
:The folder in the S3 bucket where task results are stored.
created_at(Option<DateTime>)
:The time at which the task was created.
ended_at(Option<DateTime>)
:The time at which the task ended.
tags(Option<HashMap<String, String>>)
:The tags that belong to this task.
job_arn(Option<String>)
:The ARN of the Amazon Braket job associated with the quantum task.
- On failure, responds with
SdkError<GetQuantumTaskError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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>
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>)
: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.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in the response.
filters(Vec<SearchDevicesFilter>)
/set_filters(Option<Vec<SearchDevicesFilter>>)
:The filter values to use to search for a device.
- On success, responds with
SearchDevicesOutput
with field(s):devices(Option<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 results where the previous request ended.
- On failure, responds with
SdkError<SearchDevicesError>
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>)
:A token used for pagination of results returned in the response. Use the token returned from the previous request to continue results where the previous request ended.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return in the response.
filters(Vec<SearchJobsFilter>)
/set_filters(Option<Vec<SearchJobsFilter>>)
:The filter values to use when searching for a job.
- On success, responds with
SearchJobsOutput
with field(s):jobs(Option<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 results where the previous request ended.
- On failure, responds with
SdkError<SearchJobsError>
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>)
: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.
max_results(i32)
/set_max_results(Option<i32>)
:Maximum number of results to return in the response.
filters(Vec<SearchQuantumTasksFilter>)
/set_filters(Option<Vec<SearchQuantumTasksFilter>>)
:Array of
SearchQuantumTasksFilter
objects.
- On success, responds with
SearchQuantumTasksOutput
with field(s):quantum_tasks(Option<Vec<QuantumTaskSummary>>)
:An array of
QuantumTaskSummary
objects for 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 results where the previous request ended.
- On failure, responds with
SdkError<SearchQuantumTasksError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:Specify the
resourceArn
of the resource to which a tag will be added.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Specify the tags to add to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:Specify the
resourceArn
for the resource from which to remove the tags.tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:Specify the keys for the tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more