Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Braket.Lens

Contents

Operations
Types

Description

Synopsis

Operations

CancelJob

cancelJob_jobArn :: Lens' CancelJob Text Source #

The ARN of the Amazon Braket job to cancel.

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #

The response's http status code.

cancelJobResponse_cancellationStatus :: Lens' CancelJobResponse CancellationStatus Source #

The status of the job cancellation request.

cancelJobResponse_jobArn :: Lens' CancelJobResponse Text Source #

The ARN of the Amazon Braket job.

CancelQuantumTask

cancelQuantumTask_clientToken :: Lens' CancelQuantumTask Text Source #

The client token associated with the request.

cancelQuantumTask_quantumTaskArn :: Lens' CancelQuantumTask Text Source #

The ARN of the task to cancel.

cancelQuantumTaskResponse_httpStatus :: Lens' CancelQuantumTaskResponse Int Source #

The response's http status code.

cancelQuantumTaskResponse_cancellationStatus :: Lens' CancelQuantumTaskResponse CancellationStatus Source #

The status of the cancellation request.

cancelQuantumTaskResponse_quantumTaskArn :: Lens' CancelQuantumTaskResponse Text Source #

The ARN of the task.

CreateJob

createJob_checkpointConfig :: Lens' CreateJob (Maybe JobCheckpointConfig) Source #

Information about the output locations for job checkpoint data.

createJob_hyperParameters :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

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.

createJob_inputDataConfig :: Lens' CreateJob (Maybe [InputFileConfig]) Source #

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

createJob_stoppingCondition :: Lens' CreateJob (Maybe JobStoppingCondition) Source #

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

createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

createJob_algorithmSpecification :: Lens' CreateJob AlgorithmSpecification Source #

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.

createJob_clientToken :: Lens' CreateJob Text Source #

A unique token that guarantees that the call to this API is idempotent.

createJob_deviceConfig :: Lens' CreateJob DeviceConfig Source #

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

createJob_instanceConfig :: Lens' CreateJob InstanceConfig Source #

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

createJob_jobName :: Lens' CreateJob Text Source #

The name of the Amazon Braket job.

createJob_outputDataConfig :: Lens' CreateJob JobOutputDataConfig Source #

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

createJob_roleArn :: Lens' CreateJob Text Source #

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.

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.

createJobResponse_jobArn :: Lens' CreateJobResponse Text Source #

The ARN of the Amazon Braket job created.

CreateQuantumTask

createQuantumTask_deviceParameters :: Lens' CreateQuantumTask (Maybe Text) Source #

The parameters for the device to run the task on.

createQuantumTask_jobToken :: Lens' CreateQuantumTask (Maybe Text) Source #

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

createQuantumTask_tags :: Lens' CreateQuantumTask (Maybe (HashMap Text Text)) Source #

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

createQuantumTask_action :: Lens' CreateQuantumTask Text Source #

The action associated with the task.

createQuantumTask_clientToken :: Lens' CreateQuantumTask Text Source #

The client token associated with the request.

createQuantumTask_deviceArn :: Lens' CreateQuantumTask Text Source #

The ARN of the device to run the task on.

createQuantumTask_outputS3Bucket :: Lens' CreateQuantumTask Text Source #

The S3 bucket to store task result files in.

createQuantumTask_outputS3KeyPrefix :: Lens' CreateQuantumTask Text Source #

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

createQuantumTask_shots :: Lens' CreateQuantumTask Natural Source #

The number of shots to use for the task.

createQuantumTaskResponse_httpStatus :: Lens' CreateQuantumTaskResponse Int Source #

The response's http status code.

createQuantumTaskResponse_quantumTaskArn :: Lens' CreateQuantumTaskResponse Text Source #

The ARN of the task created by the request.

GetDevice

getDevice_deviceArn :: Lens' GetDevice Text Source #

The ARN of the device to retrieve.

getDeviceResponse_httpStatus :: Lens' GetDeviceResponse Int Source #

The response's http status code.

getDeviceResponse_deviceArn :: Lens' GetDeviceResponse Text Source #

The ARN of the device.

getDeviceResponse_deviceCapabilities :: Lens' GetDeviceResponse Text Source #

Details about the capabilities of the device.

getDeviceResponse_deviceName :: Lens' GetDeviceResponse Text Source #

The name of the device.

getDeviceResponse_deviceStatus :: Lens' GetDeviceResponse DeviceStatus Source #

The status of the device.

getDeviceResponse_deviceType :: Lens' GetDeviceResponse DeviceType Source #

The type of the device.

getDeviceResponse_providerName :: Lens' GetDeviceResponse Text Source #

The name of the partner company for the device.

GetJob

getJob_jobArn :: Lens' GetJob Text Source #

The ARN of the job to retrieve.

getJobResponse_billableDuration :: Lens' GetJobResponse (Maybe Int) Source #

The billable time the Amazon Braket job used to complete.

getJobResponse_checkpointConfig :: Lens' GetJobResponse (Maybe JobCheckpointConfig) Source #

Information about the output locations for job checkpoint data.

getJobResponse_deviceConfig :: Lens' GetJobResponse (Maybe DeviceConfig) Source #

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

getJobResponse_endedAt :: Lens' GetJobResponse (Maybe UTCTime) Source #

The date and time that the Amazon Braket job ended.

getJobResponse_events :: Lens' GetJobResponse (Maybe [JobEventDetails]) Source #

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

getJobResponse_failureReason :: Lens' GetJobResponse (Maybe Text) Source #

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

getJobResponse_hyperParameters :: Lens' GetJobResponse (Maybe (HashMap Text Text)) Source #

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.

getJobResponse_inputDataConfig :: Lens' GetJobResponse (Maybe [InputFileConfig]) Source #

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

getJobResponse_startedAt :: Lens' GetJobResponse (Maybe UTCTime) Source #

The date and time that the Amazon Braket job was started.

getJobResponse_stoppingCondition :: Lens' GetJobResponse (Maybe JobStoppingCondition) Source #

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

getJobResponse_tags :: Lens' GetJobResponse (Maybe (HashMap Text Text)) Source #

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

getJobResponse_httpStatus :: Lens' GetJobResponse Int Source #

The response's http status code.

getJobResponse_algorithmSpecification :: Lens' GetJobResponse AlgorithmSpecification Source #

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.

getJobResponse_createdAt :: Lens' GetJobResponse UTCTime Source #

The date and time that the Amazon Braket job was created.

getJobResponse_instanceConfig :: Lens' GetJobResponse InstanceConfig Source #

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

getJobResponse_jobArn :: Lens' GetJobResponse Text Source #

The ARN of the Amazon Braket job.

getJobResponse_jobName :: Lens' GetJobResponse Text Source #

The name of the Amazon Braket job.

getJobResponse_outputDataConfig :: Lens' GetJobResponse JobOutputDataConfig Source #

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

getJobResponse_roleArn :: Lens' GetJobResponse Text Source #

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.

getJobResponse_status :: Lens' GetJobResponse JobPrimaryStatus Source #

The status of the Amazon Braket job.

GetQuantumTask

getQuantumTask_quantumTaskArn :: Lens' GetQuantumTask Text Source #

the ARN of the task to retrieve.

getQuantumTaskResponse_endedAt :: Lens' GetQuantumTaskResponse (Maybe UTCTime) Source #

The time at which the task ended.

getQuantumTaskResponse_failureReason :: Lens' GetQuantumTaskResponse (Maybe Text) Source #

The reason that a task failed.

getQuantumTaskResponse_jobArn :: Lens' GetQuantumTaskResponse (Maybe Text) Source #

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

getQuantumTaskResponse_tags :: Lens' GetQuantumTaskResponse (Maybe (HashMap Text Text)) Source #

The tags that belong to this task.

getQuantumTaskResponse_httpStatus :: Lens' GetQuantumTaskResponse Int Source #

The response's http status code.

getQuantumTaskResponse_createdAt :: Lens' GetQuantumTaskResponse UTCTime Source #

The time at which the task was created.

getQuantumTaskResponse_deviceArn :: Lens' GetQuantumTaskResponse Text Source #

The ARN of the device the task was run on.

getQuantumTaskResponse_deviceParameters :: Lens' GetQuantumTaskResponse Text Source #

The parameters for the device on which the task ran.

getQuantumTaskResponse_outputS3Bucket :: Lens' GetQuantumTaskResponse Text Source #

The S3 bucket where task results are stored.

getQuantumTaskResponse_outputS3Directory :: Lens' GetQuantumTaskResponse Text Source #

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

getQuantumTaskResponse_quantumTaskArn :: Lens' GetQuantumTaskResponse Text Source #

The ARN of the task.

getQuantumTaskResponse_shots :: Lens' GetQuantumTaskResponse Integer Source #

The number of shots used in the task.

getQuantumTaskResponse_status :: Lens' GetQuantumTaskResponse QuantumTaskStatus Source #

The status of the task.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

Specify the resourceArn for the resource whose tags to display.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

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

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

SearchDevices

searchDevices_maxResults :: Lens' SearchDevices (Maybe Natural) Source #

The maximum number of results to return in the response.

searchDevices_nextToken :: Lens' SearchDevices (Maybe Text) Source #

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.

searchDevices_filters :: Lens' SearchDevices [SearchDevicesFilter] Source #

The filter values to use to search for a device.

searchDevicesResponse_nextToken :: Lens' SearchDevicesResponse (Maybe Text) Source #

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.

searchDevicesResponse_httpStatus :: Lens' SearchDevicesResponse Int Source #

The response's http status code.

searchDevicesResponse_devices :: Lens' SearchDevicesResponse [DeviceSummary] Source #

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

SearchJobs

searchJobs_maxResults :: Lens' SearchJobs (Maybe Natural) Source #

The maximum number of results to return in the response.

searchJobs_nextToken :: Lens' SearchJobs (Maybe Text) Source #

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.

searchJobs_filters :: Lens' SearchJobs [SearchJobsFilter] Source #

The filter values to use when searching for a job.

searchJobsResponse_nextToken :: Lens' SearchJobsResponse (Maybe Text) Source #

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.

searchJobsResponse_httpStatus :: Lens' SearchJobsResponse Int Source #

The response's http status code.

searchJobsResponse_jobs :: Lens' SearchJobsResponse [JobSummary] Source #

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

SearchQuantumTasks

searchQuantumTasks_maxResults :: Lens' SearchQuantumTasks (Maybe Natural) Source #

Maximum number of results to return in the response.

searchQuantumTasks_nextToken :: Lens' SearchQuantumTasks (Maybe Text) Source #

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.

searchQuantumTasks_filters :: Lens' SearchQuantumTasks [SearchQuantumTasksFilter] Source #

Array of SearchQuantumTasksFilter objects.

searchQuantumTasksResponse_nextToken :: Lens' SearchQuantumTasksResponse (Maybe Text) Source #

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.

searchQuantumTasksResponse_httpStatus :: Lens' SearchQuantumTasksResponse Int Source #

The response's http status code.

searchQuantumTasksResponse_quantumTasks :: Lens' SearchQuantumTasksResponse [QuantumTaskSummary] Source #

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

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Specify the tags to add to the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

Types

AlgorithmSpecification

algorithmSpecification_containerImage :: Lens' AlgorithmSpecification (Maybe ContainerImage) Source #

The container image used to create an Amazon Braket job.

algorithmSpecification_scriptModeConfig :: Lens' AlgorithmSpecification (Maybe ScriptModeConfig) Source #

Configures the paths to the Python scripts used for entry and training.

ContainerImage

containerImage_uri :: Lens' ContainerImage Text Source #

The URI locating the container image.

DataSource

dataSource_s3DataSource :: Lens' DataSource S3DataSource Source #

Information about the data stored in Amazon S3 used by the Amazon Braket job.

DeviceConfig

deviceConfig_device :: Lens' DeviceConfig Text Source #

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

DeviceSummary

deviceSummary_deviceArn :: Lens' DeviceSummary Text Source #

The ARN of the device.

deviceSummary_deviceName :: Lens' DeviceSummary Text Source #

The name of the device.

deviceSummary_deviceStatus :: Lens' DeviceSummary DeviceStatus Source #

The status of the device.

deviceSummary_deviceType :: Lens' DeviceSummary DeviceType Source #

The type of the device.

deviceSummary_providerName :: Lens' DeviceSummary Text Source #

The provider of the device.

InputFileConfig

inputFileConfig_contentType :: Lens' InputFileConfig (Maybe Text) Source #

The MIME type of the data.

inputFileConfig_channelName :: Lens' InputFileConfig Text Source #

A named input source that an Amazon Braket job can consume.

inputFileConfig_dataSource :: Lens' InputFileConfig DataSource Source #

The location of the channel data.

InstanceConfig

instanceConfig_instanceCount :: Lens' InstanceConfig (Maybe Natural) Source #

Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.

instanceConfig_instanceType :: Lens' InstanceConfig InstanceType Source #

Configures the type resource instances to use while running an Amazon Braket hybrid job.

instanceConfig_volumeSizeInGb :: Lens' InstanceConfig Natural Source #

The size of the storage volume, in GB, that user wants to provision.

JobCheckpointConfig

jobCheckpointConfig_localPath :: Lens' JobCheckpointConfig (Maybe Text) Source #

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

jobCheckpointConfig_s3Uri :: Lens' JobCheckpointConfig Text Source #

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

JobEventDetails

jobEventDetails_eventType :: Lens' JobEventDetails (Maybe JobEventType) Source #

The type of event that occurred related to the Amazon Braket job.

jobEventDetails_message :: Lens' JobEventDetails (Maybe Text) Source #

A message describing the event that occurred related to the Amazon Braket job.

jobEventDetails_timeOfEvent :: Lens' JobEventDetails (Maybe UTCTime) Source #

TThe type of event that occurred related to the Amazon Braket job.

JobOutputDataConfig

jobOutputDataConfig_kmsKeyId :: Lens' JobOutputDataConfig (Maybe Text) Source #

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.

jobOutputDataConfig_s3Path :: Lens' JobOutputDataConfig Text Source #

Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.