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 |
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- CancellationStatus
- CompressionType
- DeviceStatus
- DeviceType
- InstanceType
- JobEventType
- JobPrimaryStatus
- QuantumTaskStatus
- SearchJobsFilterOperator
- SearchQuantumTasksFilterOperator
- AlgorithmSpecification
- ContainerImage
- DataSource
- DeviceConfig
- DeviceSummary
- InputFileConfig
- InstanceConfig
- JobCheckpointConfig
- JobEventDetails
- JobOutputDataConfig
- JobStoppingCondition
- JobSummary
- QuantumTaskSummary
- S3DataSource
- ScriptModeConfig
- SearchDevicesFilter
- SearchJobsFilter
- SearchQuantumTasksFilter
Derived from API version 2019-09-01
of the AWS service descriptions, licensed under Apache 2.0.
The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.
Additional Resources:
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DeviceOfflineException :: AsError a => Fold a ServiceError
- _DeviceRetiredException :: AsError a => Fold a ServiceError
- _InternalServiceException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CancelJob = CancelJob' Text
- newCancelJob :: Text -> CancelJob
- data CancelJobResponse = CancelJobResponse' Int CancellationStatus Text
- newCancelJobResponse :: Int -> CancellationStatus -> Text -> CancelJobResponse
- data CancelQuantumTask = CancelQuantumTask' Text Text
- newCancelQuantumTask :: Text -> Text -> CancelQuantumTask
- data CancelQuantumTaskResponse = CancelQuantumTaskResponse' Int CancellationStatus Text
- newCancelQuantumTaskResponse :: Int -> CancellationStatus -> Text -> CancelQuantumTaskResponse
- data CreateJob = CreateJob' (Maybe JobCheckpointConfig) (Maybe (HashMap Text Text)) (Maybe [InputFileConfig]) (Maybe JobStoppingCondition) (Maybe (HashMap Text Text)) AlgorithmSpecification Text DeviceConfig InstanceConfig Text JobOutputDataConfig Text
- newCreateJob :: AlgorithmSpecification -> Text -> DeviceConfig -> InstanceConfig -> Text -> JobOutputDataConfig -> Text -> CreateJob
- data CreateJobResponse = CreateJobResponse' Int Text
- newCreateJobResponse :: Int -> Text -> CreateJobResponse
- data CreateQuantumTask = CreateQuantumTask' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text Natural
- newCreateQuantumTask :: Text -> Text -> Text -> Text -> Text -> Natural -> CreateQuantumTask
- data CreateQuantumTaskResponse = CreateQuantumTaskResponse' Int Text
- newCreateQuantumTaskResponse :: Int -> Text -> CreateQuantumTaskResponse
- data GetDevice = GetDevice' Text
- newGetDevice :: Text -> GetDevice
- data GetDeviceResponse = GetDeviceResponse' Int Text Text Text DeviceStatus DeviceType Text
- newGetDeviceResponse :: Int -> Text -> Text -> Text -> DeviceStatus -> DeviceType -> Text -> GetDeviceResponse
- data GetJob = GetJob' Text
- newGetJob :: Text -> GetJob
- data GetJobResponse = GetJobResponse' (Maybe Int) (Maybe JobCheckpointConfig) (Maybe DeviceConfig) (Maybe ISO8601) (Maybe [JobEventDetails]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [InputFileConfig]) (Maybe ISO8601) (Maybe JobStoppingCondition) (Maybe (HashMap Text Text)) Int AlgorithmSpecification ISO8601 InstanceConfig Text Text JobOutputDataConfig Text JobPrimaryStatus
- newGetJobResponse :: Int -> AlgorithmSpecification -> UTCTime -> InstanceConfig -> Text -> Text -> JobOutputDataConfig -> Text -> JobPrimaryStatus -> GetJobResponse
- data GetQuantumTask = GetQuantumTask' Text
- newGetQuantumTask :: Text -> GetQuantumTask
- data GetQuantumTaskResponse = GetQuantumTaskResponse' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int ISO8601 Text Text Text Text Text Integer QuantumTaskStatus
- newGetQuantumTaskResponse :: Int -> UTCTime -> Text -> Text -> Text -> Text -> Text -> Integer -> QuantumTaskStatus -> GetQuantumTaskResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data SearchDevices = SearchDevices' (Maybe Natural) (Maybe Text) [SearchDevicesFilter]
- newSearchDevices :: SearchDevices
- data SearchDevicesResponse = SearchDevicesResponse' (Maybe Text) Int [DeviceSummary]
- newSearchDevicesResponse :: Int -> SearchDevicesResponse
- data SearchJobs = SearchJobs' (Maybe Natural) (Maybe Text) [SearchJobsFilter]
- newSearchJobs :: SearchJobs
- data SearchJobsResponse = SearchJobsResponse' (Maybe Text) Int [JobSummary]
- newSearchJobsResponse :: Int -> SearchJobsResponse
- data SearchQuantumTasks = SearchQuantumTasks' (Maybe Natural) (Maybe Text) [SearchQuantumTasksFilter]
- newSearchQuantumTasks :: SearchQuantumTasks
- data SearchQuantumTasksResponse = SearchQuantumTasksResponse' (Maybe Text) Int [QuantumTaskSummary]
- newSearchQuantumTasksResponse :: Int -> SearchQuantumTasksResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- newtype CancellationStatus where
- newtype CompressionType where
- CompressionType' { }
- pattern CompressionType_GZIP :: CompressionType
- pattern CompressionType_NONE :: CompressionType
- newtype DeviceStatus where
- DeviceStatus' { }
- pattern DeviceStatus_OFFLINE :: DeviceStatus
- pattern DeviceStatus_ONLINE :: DeviceStatus
- pattern DeviceStatus_RETIRED :: DeviceStatus
- newtype DeviceType where
- DeviceType' { }
- pattern DeviceType_QPU :: DeviceType
- pattern DeviceType_SIMULATOR :: DeviceType
- newtype InstanceType where
- InstanceType' { }
- pattern InstanceType_Ml_c4_2xlarge :: InstanceType
- pattern InstanceType_Ml_c4_4xlarge :: InstanceType
- pattern InstanceType_Ml_c4_8xlarge :: InstanceType
- pattern InstanceType_Ml_c4_xlarge :: InstanceType
- pattern InstanceType_Ml_c5_18xlarge :: InstanceType
- pattern InstanceType_Ml_c5_2xlarge :: InstanceType
- pattern InstanceType_Ml_c5_4xlarge :: InstanceType
- pattern InstanceType_Ml_c5_9xlarge :: InstanceType
- pattern InstanceType_Ml_c5_xlarge :: InstanceType
- pattern InstanceType_Ml_c5n_18xlarge :: InstanceType
- pattern InstanceType_Ml_c5n_2xlarge :: InstanceType
- pattern InstanceType_Ml_c5n_4xlarge :: InstanceType
- pattern InstanceType_Ml_c5n_9xlarge :: InstanceType
- pattern InstanceType_Ml_c5n_xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_12xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_16xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_2xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_4xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_8xlarge :: InstanceType
- pattern InstanceType_Ml_g4dn_xlarge :: InstanceType
- pattern InstanceType_Ml_m4_10xlarge :: InstanceType
- pattern InstanceType_Ml_m4_16xlarge :: InstanceType
- pattern InstanceType_Ml_m4_2xlarge :: InstanceType
- pattern InstanceType_Ml_m4_4xlarge :: InstanceType
- pattern InstanceType_Ml_m4_xlarge :: InstanceType
- pattern InstanceType_Ml_m5_12xlarge :: InstanceType
- pattern InstanceType_Ml_m5_24xlarge :: InstanceType
- pattern InstanceType_Ml_m5_2xlarge :: InstanceType
- pattern InstanceType_Ml_m5_4xlarge :: InstanceType
- pattern InstanceType_Ml_m5_large :: InstanceType
- pattern InstanceType_Ml_m5_xlarge :: InstanceType
- pattern InstanceType_Ml_p2_16xlarge :: InstanceType
- pattern InstanceType_Ml_p2_8xlarge :: InstanceType
- pattern InstanceType_Ml_p2_xlarge :: InstanceType
- pattern InstanceType_Ml_p3_16xlarge :: InstanceType
- pattern InstanceType_Ml_p3_2xlarge :: InstanceType
- pattern InstanceType_Ml_p3_8xlarge :: InstanceType
- pattern InstanceType_Ml_p3dn_24xlarge :: InstanceType
- pattern InstanceType_Ml_p4d_24xlarge :: InstanceType
- newtype JobEventType where
- JobEventType' { }
- pattern JobEventType_CANCELLED :: JobEventType
- pattern JobEventType_COMPLETED :: JobEventType
- pattern JobEventType_DEPRIORITIZED_DUE_TO_INACTIVITY :: JobEventType
- pattern JobEventType_DOWNLOADING_DATA :: JobEventType
- pattern JobEventType_FAILED :: JobEventType
- pattern JobEventType_MAX_RUNTIME_EXCEEDED :: JobEventType
- pattern JobEventType_QUEUED_FOR_EXECUTION :: JobEventType
- pattern JobEventType_RUNNING :: JobEventType
- pattern JobEventType_STARTING_INSTANCE :: JobEventType
- pattern JobEventType_UPLOADING_RESULTS :: JobEventType
- pattern JobEventType_WAITING_FOR_PRIORITY :: JobEventType
- newtype JobPrimaryStatus where
- JobPrimaryStatus' { }
- pattern JobPrimaryStatus_CANCELLED :: JobPrimaryStatus
- pattern JobPrimaryStatus_CANCELLING :: JobPrimaryStatus
- pattern JobPrimaryStatus_COMPLETED :: JobPrimaryStatus
- pattern JobPrimaryStatus_FAILED :: JobPrimaryStatus
- pattern JobPrimaryStatus_QUEUED :: JobPrimaryStatus
- pattern JobPrimaryStatus_RUNNING :: JobPrimaryStatus
- newtype QuantumTaskStatus where
- QuantumTaskStatus' { }
- pattern QuantumTaskStatus_CANCELLED :: QuantumTaskStatus
- pattern QuantumTaskStatus_CANCELLING :: QuantumTaskStatus
- pattern QuantumTaskStatus_COMPLETED :: QuantumTaskStatus
- pattern QuantumTaskStatus_CREATED :: QuantumTaskStatus
- pattern QuantumTaskStatus_FAILED :: QuantumTaskStatus
- pattern QuantumTaskStatus_QUEUED :: QuantumTaskStatus
- pattern QuantumTaskStatus_RUNNING :: QuantumTaskStatus
- newtype SearchJobsFilterOperator where
- SearchJobsFilterOperator' { }
- pattern SearchJobsFilterOperator_BETWEEN :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_CONTAINS :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_EQUAL :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_GT :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_GTE :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_LT :: SearchJobsFilterOperator
- pattern SearchJobsFilterOperator_LTE :: SearchJobsFilterOperator
- newtype SearchQuantumTasksFilterOperator where
- SearchQuantumTasksFilterOperator' { }
- pattern SearchQuantumTasksFilterOperator_BETWEEN :: SearchQuantumTasksFilterOperator
- pattern SearchQuantumTasksFilterOperator_EQUAL :: SearchQuantumTasksFilterOperator
- pattern SearchQuantumTasksFilterOperator_GT :: SearchQuantumTasksFilterOperator
- pattern SearchQuantumTasksFilterOperator_GTE :: SearchQuantumTasksFilterOperator
- pattern SearchQuantumTasksFilterOperator_LT :: SearchQuantumTasksFilterOperator
- pattern SearchQuantumTasksFilterOperator_LTE :: SearchQuantumTasksFilterOperator
- data AlgorithmSpecification = AlgorithmSpecification' (Maybe ContainerImage) (Maybe ScriptModeConfig)
- newAlgorithmSpecification :: AlgorithmSpecification
- data ContainerImage = ContainerImage' Text
- newContainerImage :: Text -> ContainerImage
- data DataSource = DataSource' S3DataSource
- newDataSource :: S3DataSource -> DataSource
- data DeviceConfig = DeviceConfig' Text
- newDeviceConfig :: Text -> DeviceConfig
- data DeviceSummary = DeviceSummary' Text Text DeviceStatus DeviceType Text
- newDeviceSummary :: Text -> Text -> DeviceStatus -> DeviceType -> Text -> DeviceSummary
- data InputFileConfig = InputFileConfig' (Maybe Text) Text DataSource
- newInputFileConfig :: Text -> DataSource -> InputFileConfig
- data InstanceConfig = InstanceConfig' (Maybe Natural) InstanceType Natural
- newInstanceConfig :: InstanceType -> Natural -> InstanceConfig
- data JobCheckpointConfig = JobCheckpointConfig' (Maybe Text) Text
- newJobCheckpointConfig :: Text -> JobCheckpointConfig
- data JobEventDetails = JobEventDetails' (Maybe JobEventType) (Maybe Text) (Maybe ISO8601)
- newJobEventDetails :: JobEventDetails
- data JobOutputDataConfig = JobOutputDataConfig' (Maybe Text) Text
- newJobOutputDataConfig :: Text -> JobOutputDataConfig
- data JobStoppingCondition = JobStoppingCondition' (Maybe Natural)
- newJobStoppingCondition :: JobStoppingCondition
- data JobSummary = JobSummary' (Maybe ISO8601) (Maybe ISO8601) (Maybe (HashMap Text Text)) ISO8601 Text Text Text JobPrimaryStatus
- newJobSummary :: UTCTime -> Text -> Text -> Text -> JobPrimaryStatus -> JobSummary
- data QuantumTaskSummary = QuantumTaskSummary' (Maybe ISO8601) (Maybe (HashMap Text Text)) ISO8601 Text Text Text Text Integer QuantumTaskStatus
- newQuantumTaskSummary :: UTCTime -> Text -> Text -> Text -> Text -> Integer -> QuantumTaskStatus -> QuantumTaskSummary
- data S3DataSource = S3DataSource' Text
- newS3DataSource :: Text -> S3DataSource
- data ScriptModeConfig = ScriptModeConfig' (Maybe CompressionType) Text Text
- newScriptModeConfig :: Text -> Text -> ScriptModeConfig
- data SearchDevicesFilter = SearchDevicesFilter' Text (NonEmpty Text)
- newSearchDevicesFilter :: Text -> NonEmpty Text -> SearchDevicesFilter
- data SearchJobsFilter = SearchJobsFilter' Text SearchJobsFilterOperator (NonEmpty Text)
- newSearchJobsFilter :: Text -> SearchJobsFilterOperator -> NonEmpty Text -> SearchJobsFilter
- data SearchQuantumTasksFilter = SearchQuantumTasksFilter' Text SearchQuantumTasksFilterOperator (NonEmpty Text)
- newSearchQuantumTasksFilter :: Text -> SearchQuantumTasksFilterOperator -> NonEmpty Text -> SearchQuantumTasksFilter
Service Configuration
defaultService :: Service Source #
API version 2019-09-01
of the Amazon Braket SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Braket
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
An error occurred due to a conflict.
DeviceOfflineException
_DeviceOfflineException :: AsError a => Fold a ServiceError Source #
The specified device is currently offline.
DeviceRetiredException
_DeviceRetiredException :: AsError a => Fold a ServiceError Source #
The specified device has been retired.
InternalServiceException
_InternalServiceException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception, or failure.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because a service quota is exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The throttling rate limit is met.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelJob
See: newCancelJob
smart constructor.
Instances
Create a value of CancelJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelJob
, cancelJob_jobArn
- The ARN of the Amazon Braket job to cancel.
data CancelJobResponse Source #
See: newCancelJobResponse
smart constructor.
Instances
:: Int | |
-> CancellationStatus | |
-> Text | |
-> CancelJobResponse |
Create a value of CancelJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelJobResponse'
, cancelJobResponse_httpStatus
- The response's http status code.
$sel:cancellationStatus:CancelJobResponse'
, cancelJobResponse_cancellationStatus
- The status of the job cancellation request.
CancelJob
, cancelJobResponse_jobArn
- The ARN of the Amazon Braket job.
CancelQuantumTask
data CancelQuantumTask Source #
See: newCancelQuantumTask
smart constructor.
Instances
Create a value of CancelQuantumTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CancelQuantumTask'
, cancelQuantumTask_clientToken
- The client token associated with the request.
CancelQuantumTask
, cancelQuantumTask_quantumTaskArn
- The ARN of the task to cancel.
data CancelQuantumTaskResponse Source #
See: newCancelQuantumTaskResponse
smart constructor.
Instances
newCancelQuantumTaskResponse Source #
Create a value of CancelQuantumTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelQuantumTaskResponse'
, cancelQuantumTaskResponse_httpStatus
- The response's http status code.
$sel:cancellationStatus:CancelQuantumTaskResponse'
, cancelQuantumTaskResponse_cancellationStatus
- The status of the cancellation request.
CancelQuantumTask
, cancelQuantumTaskResponse_quantumTaskArn
- The ARN of the task.
CreateJob
See: newCreateJob
smart constructor.
Instances
:: AlgorithmSpecification | |
-> Text | |
-> DeviceConfig | |
-> InstanceConfig | |
-> Text | |
-> JobOutputDataConfig | |
-> Text | |
-> CreateJob |
Create a value of CreateJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checkpointConfig:CreateJob'
, createJob_checkpointConfig
- Information about the output locations for job checkpoint data.
$sel:hyperParameters:CreateJob'
, createJob_hyperParameters
- 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.
$sel:inputDataConfig:CreateJob'
, createJob_inputDataConfig
- A list of parameters that specify the name and type of input data and
where it is located.
$sel:stoppingCondition:CreateJob'
, createJob_stoppingCondition
- The user-defined criteria that specifies when a job stops running.
CreateJob
, createJob_tags
- A tag object that consists of a key and an optional value, used to
manage metadata for Amazon Braket resources.
$sel:algorithmSpecification:CreateJob'
, createJob_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.
$sel:clientToken:CreateJob'
, createJob_clientToken
- A unique token that guarantees that the call to this API is idempotent.
$sel:deviceConfig:CreateJob'
, createJob_deviceConfig
- The quantum processing unit (QPU) or simulator used to create an Amazon
Braket job.
$sel:instanceConfig:CreateJob'
, createJob_instanceConfig
- Configuration of the resource instances to use while running the hybrid
job on Amazon Braket.
CreateJob
, createJob_jobName
- The name of the Amazon Braket job.
$sel:outputDataConfig:CreateJob'
, createJob_outputDataConfig
- The path to the S3 location where you want to store job artifacts and
the encryption key used to store them.
$sel:roleArn:CreateJob'
, createJob_roleArn
- 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.
data CreateJobResponse Source #
See: newCreateJobResponse
smart constructor.
Instances
Create a value of CreateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateJobResponse'
, createJobResponse_httpStatus
- The response's http status code.
CreateJobResponse
, createJobResponse_jobArn
- The ARN of the Amazon Braket job created.
CreateQuantumTask
data CreateQuantumTask Source #
See: newCreateQuantumTask
smart constructor.
CreateQuantumTask' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text Natural |
Instances
Create a value of CreateQuantumTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceParameters:CreateQuantumTask'
, createQuantumTask_deviceParameters
- The parameters for the device to run the task on.
$sel:jobToken:CreateQuantumTask'
, createQuantumTask_jobToken
- The token for an Amazon Braket job that associates it with the quantum
task.
CreateQuantumTask
, createQuantumTask_tags
- Tags to be added to the quantum task you're creating.
$sel:action:CreateQuantumTask'
, createQuantumTask_action
- The action associated with the task.
$sel:clientToken:CreateQuantumTask'
, createQuantumTask_clientToken
- The client token associated with the request.
CreateQuantumTask
, createQuantumTask_deviceArn
- The ARN of the device to run the task on.
CreateQuantumTask
, createQuantumTask_outputS3Bucket
- The S3 bucket to store task result files in.
$sel:outputS3KeyPrefix:CreateQuantumTask'
, createQuantumTask_outputS3KeyPrefix
- The key prefix for the location in the S3 bucket to store task results
in.
CreateQuantumTask
, createQuantumTask_shots
- The number of shots to use for the task.
data CreateQuantumTaskResponse Source #
See: newCreateQuantumTaskResponse
smart constructor.
Instances
newCreateQuantumTaskResponse Source #
:: Int | |
-> Text | |
-> CreateQuantumTaskResponse |
Create a value of CreateQuantumTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateQuantumTaskResponse'
, createQuantumTaskResponse_httpStatus
- The response's http status code.
CreateQuantumTaskResponse
, createQuantumTaskResponse_quantumTaskArn
- The ARN of the task created by the request.
GetDevice
See: newGetDevice
smart constructor.
Instances
ToHeaders GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice | |
ToPath GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice toPath :: GetDevice -> ByteString # | |
ToQuery GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice toQuery :: GetDevice -> QueryString # | |
AWSRequest GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice type AWSResponse GetDevice # request :: (Service -> Service) -> GetDevice -> Request GetDevice # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDevice -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDevice))) # | |
Generic GetDevice Source # | |
Read GetDevice Source # | |
Show GetDevice Source # | |
NFData GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice | |
Eq GetDevice Source # | |
Hashable GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice | |
type AWSResponse GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice | |
type Rep GetDevice Source # | |
Defined in Amazonka.Braket.GetDevice |
Create a value of GetDevice
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDevice
, getDevice_deviceArn
- The ARN of the device to retrieve.
data GetDeviceResponse Source #
See: newGetDeviceResponse
smart constructor.
Instances
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> DeviceStatus | |
-> DeviceType | |
-> Text | |
-> GetDeviceResponse |
Create a value of GetDeviceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetDeviceResponse'
, getDeviceResponse_httpStatus
- The response's http status code.
GetDevice
, getDeviceResponse_deviceArn
- The ARN of the device.
$sel:deviceCapabilities:GetDeviceResponse'
, getDeviceResponse_deviceCapabilities
- Details about the capabilities of the device.
GetDeviceResponse
, getDeviceResponse_deviceName
- The name of the device.
GetDeviceResponse
, getDeviceResponse_deviceStatus
- The status of the device.
GetDeviceResponse
, getDeviceResponse_deviceType
- The type of the device.
GetDeviceResponse
, getDeviceResponse_providerName
- The name of the partner company for the device.
GetJob
See: newGetJob
smart constructor.
Instances
ToHeaders GetJob Source # | |
Defined in Amazonka.Braket.GetJob | |
ToPath GetJob Source # | |
Defined in Amazonka.Braket.GetJob toPath :: GetJob -> ByteString # | |
ToQuery GetJob Source # | |
Defined in Amazonka.Braket.GetJob toQuery :: GetJob -> QueryString # | |
AWSRequest GetJob Source # | |
Defined in Amazonka.Braket.GetJob type AWSResponse GetJob # request :: (Service -> Service) -> GetJob -> Request GetJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJob))) # | |
Generic GetJob Source # | |
Read GetJob Source # | |
Show GetJob Source # | |
NFData GetJob Source # | |
Defined in Amazonka.Braket.GetJob | |
Eq GetJob Source # | |
Hashable GetJob Source # | |
Defined in Amazonka.Braket.GetJob | |
type AWSResponse GetJob Source # | |
Defined in Amazonka.Braket.GetJob | |
type Rep GetJob Source # | |
Defined in Amazonka.Braket.GetJob |
Create a value of GetJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetJob
, getJob_jobArn
- The ARN of the job to retrieve.
data GetJobResponse Source #
See: newGetJobResponse
smart constructor.
Instances
:: Int | |
-> AlgorithmSpecification | |
-> UTCTime | |
-> InstanceConfig | |
-> Text | |
-> Text | |
-> JobOutputDataConfig | |
-> Text | |
-> JobPrimaryStatus | |
-> GetJobResponse |
Create a value of GetJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billableDuration:GetJobResponse'
, getJobResponse_billableDuration
- The billable time the Amazon Braket job used to complete.
$sel:checkpointConfig:GetJobResponse'
, getJobResponse_checkpointConfig
- Information about the output locations for job checkpoint data.
$sel:deviceConfig:GetJobResponse'
, getJobResponse_deviceConfig
- The quantum processing unit (QPU) or simulator used to run the Amazon
Braket job.
GetJobResponse
, getJobResponse_endedAt
- The date and time that the Amazon Braket job ended.
$sel:events:GetJobResponse'
, getJobResponse_events
- Details about the type and time events occurred related to the Amazon
Braket job.
$sel:failureReason:GetJobResponse'
, getJobResponse_failureReason
- A description of the reason why an Amazon Braket job failed, if it
failed.
$sel:hyperParameters:GetJobResponse'
, getJobResponse_hyperParameters
- 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.
$sel:inputDataConfig:GetJobResponse'
, getJobResponse_inputDataConfig
- A list of parameters that specify the name and type of input data and
where it is located.
GetJobResponse
, getJobResponse_startedAt
- The date and time that the Amazon Braket job was started.
$sel:stoppingCondition:GetJobResponse'
, getJobResponse_stoppingCondition
- The user-defined criteria that specifies when to stop a job running.
GetJobResponse
, getJobResponse_tags
- A tag object that consists of a key and an optional value, used to
manage metadata for Amazon Braket resources.
$sel:httpStatus:GetJobResponse'
, getJobResponse_httpStatus
- The response's http status code.
$sel:algorithmSpecification:GetJobResponse'
, getJobResponse_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.
GetJobResponse
, getJobResponse_createdAt
- The date and time that the Amazon Braket job was created.
$sel:instanceConfig:GetJobResponse'
, getJobResponse_instanceConfig
- The resource instances to use while running the hybrid job on Amazon
Braket.
GetJob
, getJobResponse_jobArn
- The ARN of the Amazon Braket job.
GetJobResponse
, getJobResponse_jobName
- The name of the Amazon Braket job.
$sel:outputDataConfig:GetJobResponse'
, getJobResponse_outputDataConfig
- The path to the S3 location where job artifacts are stored and the
encryption key used to store them there.
$sel:roleArn:GetJobResponse'
, getJobResponse_roleArn
- 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
, getJobResponse_status
- The status of the Amazon Braket job.
GetQuantumTask
data GetQuantumTask Source #
See: newGetQuantumTask
smart constructor.
Instances
Create a value of GetQuantumTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetQuantumTask
, getQuantumTask_quantumTaskArn
- the ARN of the task to retrieve.
data GetQuantumTaskResponse Source #
See: newGetQuantumTaskResponse
smart constructor.
GetQuantumTaskResponse' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int ISO8601 Text Text Text Text Text Integer QuantumTaskStatus |
Instances
newGetQuantumTaskResponse Source #
:: Int | |
-> UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Integer | |
-> QuantumTaskStatus | |
-> GetQuantumTaskResponse |
Create a value of GetQuantumTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetQuantumTaskResponse
, getQuantumTaskResponse_endedAt
- The time at which the task ended.
$sel:failureReason:GetQuantumTaskResponse'
, getQuantumTaskResponse_failureReason
- The reason that a task failed.
GetQuantumTaskResponse
, getQuantumTaskResponse_jobArn
- The ARN of the Amazon Braket job associated with the quantum task.
GetQuantumTaskResponse
, getQuantumTaskResponse_tags
- The tags that belong to this task.
$sel:httpStatus:GetQuantumTaskResponse'
, getQuantumTaskResponse_httpStatus
- The response's http status code.
GetQuantumTaskResponse
, getQuantumTaskResponse_createdAt
- The time at which the task was created.
GetQuantumTaskResponse
, getQuantumTaskResponse_deviceArn
- The ARN of the device the task was run on.
$sel:deviceParameters:GetQuantumTaskResponse'
, getQuantumTaskResponse_deviceParameters
- The parameters for the device on which the task ran.
GetQuantumTaskResponse
, getQuantumTaskResponse_outputS3Bucket
- The S3 bucket where task results are stored.
GetQuantumTaskResponse
, getQuantumTaskResponse_outputS3Directory
- The folder in the S3 bucket where task results are stored.
GetQuantumTask
, getQuantumTaskResponse_quantumTaskArn
- The ARN of the task.
GetQuantumTaskResponse
, getQuantumTaskResponse_shots
- The number of shots used in the task.
GetQuantumTaskResponse
, getQuantumTaskResponse_status
- The status of the task.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- Specify the resourceArn
for the resource whose tags to display.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- Displays the key, value pairs of tags associated with this resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
SearchDevices (Paginated)
data SearchDevices Source #
See: newSearchDevices
smart constructor.
Instances
newSearchDevices :: SearchDevices Source #
Create a value of SearchDevices
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:SearchDevices'
, searchDevices_maxResults
- The maximum number of results to return in the response.
SearchDevices
, searchDevices_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.
$sel:filters:SearchDevices'
, searchDevices_filters
- The filter values to use to search for a device.
data SearchDevicesResponse Source #
See: newSearchDevicesResponse
smart constructor.
Instances
newSearchDevicesResponse Source #
Create a value of SearchDevicesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchDevices
, searchDevicesResponse_nextToken
- 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.
$sel:httpStatus:SearchDevicesResponse'
, searchDevicesResponse_httpStatus
- The response's http status code.
$sel:devices:SearchDevicesResponse'
, searchDevicesResponse_devices
- An array of DeviceSummary
objects for devices that match the specified
filter values.
SearchJobs (Paginated)
data SearchJobs Source #
See: newSearchJobs
smart constructor.
Instances
newSearchJobs :: SearchJobs Source #
Create a value of SearchJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:SearchJobs'
, searchJobs_maxResults
- The maximum number of results to return in the response.
SearchJobs
, searchJobs_nextToken
- 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.
$sel:filters:SearchJobs'
, searchJobs_filters
- The filter values to use when searching for a job.
data SearchJobsResponse Source #
See: newSearchJobsResponse
smart constructor.
Instances
newSearchJobsResponse Source #
Create a value of SearchJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchJobs
, searchJobsResponse_nextToken
- 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.
$sel:httpStatus:SearchJobsResponse'
, searchJobsResponse_httpStatus
- The response's http status code.
$sel:jobs:SearchJobsResponse'
, searchJobsResponse_jobs
- An array of JobSummary
objects for devices that match the specified
filter values.
SearchQuantumTasks (Paginated)
data SearchQuantumTasks Source #
See: newSearchQuantumTasks
smart constructor.
Instances
newSearchQuantumTasks :: SearchQuantumTasks Source #
Create a value of SearchQuantumTasks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:SearchQuantumTasks'
, searchQuantumTasks_maxResults
- Maximum number of results to return in the response.
SearchQuantumTasks
, searchQuantumTasks_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.
$sel:filters:SearchQuantumTasks'
, searchQuantumTasks_filters
- Array of SearchQuantumTasksFilter
objects.
data SearchQuantumTasksResponse Source #
See: newSearchQuantumTasksResponse
smart constructor.
Instances
newSearchQuantumTasksResponse Source #
Create a value of SearchQuantumTasksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchQuantumTasks
, searchQuantumTasksResponse_nextToken
- 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.
$sel:httpStatus:SearchQuantumTasksResponse'
, searchQuantumTasksResponse_httpStatus
- The response's http status code.
$sel:quantumTasks:SearchQuantumTasksResponse'
, searchQuantumTasksResponse_quantumTasks
- An array of QuantumTaskSummary
objects for tasks that match the
specified filters.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- Specify the resourceArn
of the resource to which a tag will be added.
TagResource
, tagResource_tags
- Specify the tags to add to the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- Specify the resourceArn
for the resource from which to remove the
tags.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- Specify the keys for the tags to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
Types
CancellationStatus
newtype CancellationStatus Source #
pattern CancellationStatus_CANCELLED :: CancellationStatus | |
pattern CancellationStatus_CANCELLING :: CancellationStatus |
Instances
CompressionType
newtype CompressionType Source #
pattern CompressionType_GZIP :: CompressionType | |
pattern CompressionType_NONE :: CompressionType |
Instances
DeviceStatus
newtype DeviceStatus Source #
pattern DeviceStatus_OFFLINE :: DeviceStatus | |
pattern DeviceStatus_ONLINE :: DeviceStatus | |
pattern DeviceStatus_RETIRED :: DeviceStatus |
Instances
DeviceType
newtype DeviceType Source #
pattern DeviceType_QPU :: DeviceType | |
pattern DeviceType_SIMULATOR :: DeviceType |
Instances
InstanceType
newtype InstanceType Source #
Instances
JobEventType
newtype JobEventType Source #
pattern JobEventType_CANCELLED :: JobEventType | |
pattern JobEventType_COMPLETED :: JobEventType | |
pattern JobEventType_DEPRIORITIZED_DUE_TO_INACTIVITY :: JobEventType | |
pattern JobEventType_DOWNLOADING_DATA :: JobEventType | |
pattern JobEventType_FAILED :: JobEventType | |
pattern JobEventType_MAX_RUNTIME_EXCEEDED :: JobEventType | |
pattern JobEventType_QUEUED_FOR_EXECUTION :: JobEventType | |
pattern JobEventType_RUNNING :: JobEventType | |
pattern JobEventType_STARTING_INSTANCE :: JobEventType | |
pattern JobEventType_UPLOADING_RESULTS :: JobEventType | |
pattern JobEventType_WAITING_FOR_PRIORITY :: JobEventType |
Instances
JobPrimaryStatus
newtype JobPrimaryStatus Source #
pattern JobPrimaryStatus_CANCELLED :: JobPrimaryStatus | |
pattern JobPrimaryStatus_CANCELLING :: JobPrimaryStatus | |
pattern JobPrimaryStatus_COMPLETED :: JobPrimaryStatus | |
pattern JobPrimaryStatus_FAILED :: JobPrimaryStatus | |
pattern JobPrimaryStatus_QUEUED :: JobPrimaryStatus | |
pattern JobPrimaryStatus_RUNNING :: JobPrimaryStatus |
Instances
QuantumTaskStatus
newtype QuantumTaskStatus Source #
pattern QuantumTaskStatus_CANCELLED :: QuantumTaskStatus | |
pattern QuantumTaskStatus_CANCELLING :: QuantumTaskStatus | |
pattern QuantumTaskStatus_COMPLETED :: QuantumTaskStatus | |
pattern QuantumTaskStatus_CREATED :: QuantumTaskStatus | |
pattern QuantumTaskStatus_FAILED :: QuantumTaskStatus | |
pattern QuantumTaskStatus_QUEUED :: QuantumTaskStatus | |
pattern QuantumTaskStatus_RUNNING :: QuantumTaskStatus |
Instances
SearchJobsFilterOperator
newtype SearchJobsFilterOperator Source #
Instances
SearchQuantumTasksFilterOperator
newtype SearchQuantumTasksFilterOperator Source #
Instances
AlgorithmSpecification
data AlgorithmSpecification Source #
Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to the Python scripts used for entry and training.
See: newAlgorithmSpecification
smart constructor.
Instances
newAlgorithmSpecification :: AlgorithmSpecification Source #
Create a value of AlgorithmSpecification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:containerImage:AlgorithmSpecification'
, algorithmSpecification_containerImage
- The container image used to create an Amazon Braket job.
$sel:scriptModeConfig:AlgorithmSpecification'
, algorithmSpecification_scriptModeConfig
- Configures the paths to the Python scripts used for entry and training.
ContainerImage
data ContainerImage Source #
The container image used to create an Amazon Braket job.
See: newContainerImage
smart constructor.
Instances
Create a value of ContainerImage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:uri:ContainerImage'
, containerImage_uri
- The URI locating the container image.
DataSource
data DataSource Source #
Information about the source of the data used by the Amazon Braket job.
See: newDataSource
smart constructor.
Instances
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DataSource:DataSource'
, dataSource_s3DataSource
- Information about the data stored in Amazon S3 used by the Amazon Braket
job.
DeviceConfig
data DeviceConfig Source #
Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.
See: newDeviceConfig
smart constructor.
Instances
Create a value of DeviceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:device:DeviceConfig'
, deviceConfig_device
- The primary quantum processing unit (QPU) or simulator used to create
and run an Amazon Braket job.
DeviceSummary
data DeviceSummary Source #
Includes information about the device.
See: newDeviceSummary
smart constructor.
Instances
:: Text | |
-> Text | |
-> DeviceStatus | |
-> DeviceType | |
-> Text | |
-> DeviceSummary |
Create a value of DeviceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceArn:DeviceSummary'
, deviceSummary_deviceArn
- The ARN of the device.
$sel:deviceName:DeviceSummary'
, deviceSummary_deviceName
- The name of the device.
$sel:deviceStatus:DeviceSummary'
, deviceSummary_deviceStatus
- The status of the device.
$sel:deviceType:DeviceSummary'
, deviceSummary_deviceType
- The type of the device.
$sel:providerName:DeviceSummary'
, deviceSummary_providerName
- The provider of the device.
InputFileConfig
data InputFileConfig Source #
A list of parameters that specify the input channels, type of input data, and where it is located.
See: newInputFileConfig
smart constructor.
Instances
:: Text | |
-> DataSource | |
-> InputFileConfig |
Create a value of InputFileConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentType:InputFileConfig'
, inputFileConfig_contentType
- The MIME type of the data.
$sel:channelName:InputFileConfig'
, inputFileConfig_channelName
- A named input source that an Amazon Braket job can consume.
$sel:dataSource:InputFileConfig'
, inputFileConfig_dataSource
- The location of the channel data.
InstanceConfig
data InstanceConfig Source #
Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
See: newInstanceConfig
smart constructor.
Instances
:: InstanceType | |
-> Natural | |
-> InstanceConfig |
Create a value of InstanceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceCount:InstanceConfig'
, instanceConfig_instanceCount
- Configures the number of resource instances to use while running an
Amazon Braket job on Amazon Braket. The default value is 1.
$sel:instanceType:InstanceConfig'
, instanceConfig_instanceType
- Configures the type resource instances to use while running an Amazon
Braket hybrid job.
$sel:volumeSizeInGb:InstanceConfig'
, instanceConfig_volumeSizeInGb
- The size of the storage volume, in GB, that user wants to provision.
JobCheckpointConfig
data JobCheckpointConfig Source #
Contains information about the output locations for job checkpoint data.
See: newJobCheckpointConfig
smart constructor.
Instances
newJobCheckpointConfig Source #
Create a value of JobCheckpointConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:localPath:JobCheckpointConfig'
, jobCheckpointConfig_localPath
- (Optional) The local directory where checkpoints are written. The
default directory is /opt/braket/checkpoints/
.
$sel:s3Uri:JobCheckpointConfig'
, jobCheckpointConfig_s3Uri
- Identifies the S3 path where you want Amazon Braket to store
checkpoints. For example, s3://bucket-name/key-name-prefix
.
JobEventDetails
data JobEventDetails Source #
Details about the type and time events occurred related to the Amazon Braket job.
See: newJobEventDetails
smart constructor.
Instances
newJobEventDetails :: JobEventDetails Source #
Create a value of JobEventDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventType:JobEventDetails'
, jobEventDetails_eventType
- The type of event that occurred related to the Amazon Braket job.
$sel:message:JobEventDetails'
, jobEventDetails_message
- A message describing the event that occurred related to the Amazon
Braket job.
$sel:timeOfEvent:JobEventDetails'
, jobEventDetails_timeOfEvent
- TThe type of event that occurred related to the Amazon Braket job.
JobOutputDataConfig
data JobOutputDataConfig Source #
Specifies the path to the S3 location where you want to store job artifacts and the encryption key used to store them.
See: newJobOutputDataConfig
smart constructor.
Instances
newJobOutputDataConfig Source #
Create a value of JobOutputDataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyId:JobOutputDataConfig'
, jobOutputDataConfig_kmsKeyId
- 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.
$sel:s3Path:JobOutputDataConfig'
, jobOutputDataConfig_s3Path
- Identifies the S3 path where you want Amazon Braket to store the job
training artifacts. For example, s3://bucket-name/key-name-prefix
.
JobStoppingCondition
data JobStoppingCondition Source #
Specifies limits for how long an Amazon Braket job can run.
See: newJobStoppingCondition
smart constructor.
Instances
newJobStoppingCondition :: JobStoppingCondition Source #
Create a value of JobStoppingCondition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxRuntimeInSeconds:JobStoppingCondition'
, jobStoppingCondition_maxRuntimeInSeconds
- The maximum length of time, in seconds, that an Amazon Braket job can
run.
JobSummary
data JobSummary Source #
Provides summary information about an Amazon Braket job.
See: newJobSummary
smart constructor.
JobSummary' (Maybe ISO8601) (Maybe ISO8601) (Maybe (HashMap Text Text)) ISO8601 Text Text Text JobPrimaryStatus |
Instances
:: UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> JobPrimaryStatus | |
-> JobSummary |
Create a value of JobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endedAt:JobSummary'
, jobSummary_endedAt
- The date and time that the Amazon Braket job ended.
$sel:startedAt:JobSummary'
, jobSummary_startedAt
- The date and time that the Amazon Braket job was started.
$sel:tags:JobSummary'
, jobSummary_tags
- A tag object that consists of a key and an optional value, used to
manage metadata for Amazon Braket resources.
$sel:createdAt:JobSummary'
, jobSummary_createdAt
- The date and time that the Amazon Braket job was created.
$sel:device:JobSummary'
, jobSummary_device
- Provides summary information about the primary device used by an Amazon
Braket job.
$sel:jobArn:JobSummary'
, jobSummary_jobArn
- The ARN of the Amazon Braket job.
$sel:jobName:JobSummary'
, jobSummary_jobName
- The name of the Amazon Braket job.
$sel:status:JobSummary'
, jobSummary_status
- The status of the Amazon Braket job.
QuantumTaskSummary
data QuantumTaskSummary Source #
Includes information about a quantum task.
See: newQuantumTaskSummary
smart constructor.
QuantumTaskSummary' (Maybe ISO8601) (Maybe (HashMap Text Text)) ISO8601 Text Text Text Text Integer QuantumTaskStatus |
Instances
newQuantumTaskSummary Source #
:: UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> Text | |
-> Integer | |
-> QuantumTaskStatus | |
-> QuantumTaskSummary |
Create a value of QuantumTaskSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endedAt:QuantumTaskSummary'
, quantumTaskSummary_endedAt
- The time at which the task finished.
$sel:tags:QuantumTaskSummary'
, quantumTaskSummary_tags
- Displays the key, value pairs of tags associated with this quantum task.
$sel:createdAt:QuantumTaskSummary'
, quantumTaskSummary_createdAt
- The time at which the task was created.
$sel:deviceArn:QuantumTaskSummary'
, quantumTaskSummary_deviceArn
- The ARN of the device the task ran on.
$sel:outputS3Bucket:QuantumTaskSummary'
, quantumTaskSummary_outputS3Bucket
- The S3 bucket where the task result file is stored..
$sel:outputS3Directory:QuantumTaskSummary'
, quantumTaskSummary_outputS3Directory
- The folder in the S3 bucket where the task result file is stored.
$sel:quantumTaskArn:QuantumTaskSummary'
, quantumTaskSummary_quantumTaskArn
- The ARN of the task.
$sel:shots:QuantumTaskSummary'
, quantumTaskSummary_shots
- The shots used for the task.
$sel:status:QuantumTaskSummary'
, quantumTaskSummary_status
- The status of the task.
S3DataSource
data S3DataSource Source #
Information about the data stored in Amazon S3 used by the Amazon Braket job.
See: newS3DataSource
smart constructor.
Instances
Create a value of S3DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Uri:S3DataSource'
, s3DataSource_s3Uri
- Depending on the value specified for the S3DataType
, identifies either
a key name prefix or a manifest that locates the S3 data source.
ScriptModeConfig
data ScriptModeConfig Source #
Contains information about the Python scripts used for entry and by an Amazon Braket job.
See: newScriptModeConfig
smart constructor.
Instances
Create a value of ScriptModeConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compressionType:ScriptModeConfig'
, scriptModeConfig_compressionType
- The type of compression used by the Python scripts for an Amazon Braket
job.
$sel:entryPoint:ScriptModeConfig'
, scriptModeConfig_entryPoint
- The path to the Python script that serves as the entry point for an
Amazon Braket job.
$sel:s3Uri:ScriptModeConfig'
, scriptModeConfig_s3Uri
- The URI that specifies the S3 path to the Python script module that
contains the training script used by an Amazon Braket job.
SearchDevicesFilter
data SearchDevicesFilter Source #
The filter to use for searching devices.
See: newSearchDevicesFilter
smart constructor.
Instances
newSearchDevicesFilter Source #
:: Text | |
-> NonEmpty Text | |
-> SearchDevicesFilter |
Create a value of SearchDevicesFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SearchDevicesFilter'
, searchDevicesFilter_name
- The name to use to filter results.
$sel:values:SearchDevicesFilter'
, searchDevicesFilter_values
- The values to use to filter results.
SearchJobsFilter
data SearchJobsFilter Source #
A filter used to search for Amazon Braket jobs.
See: newSearchJobsFilter
smart constructor.
Instances
Create a value of SearchJobsFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SearchJobsFilter'
, searchJobsFilter_name
- The name to use for the jobs filter.
$sel:operator:SearchJobsFilter'
, searchJobsFilter_operator
- An operator to use for the jobs filter.
$sel:values:SearchJobsFilter'
, searchJobsFilter_values
- The values to use for the jobs filter.
SearchQuantumTasksFilter
data SearchQuantumTasksFilter Source #
A filter to use to search for tasks.
See: newSearchQuantumTasksFilter
smart constructor.
Instances
newSearchQuantumTasksFilter Source #
Create a value of SearchQuantumTasksFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SearchQuantumTasksFilter'
, searchQuantumTasksFilter_name
- The name of the device used for the task.
$sel:operator:SearchQuantumTasksFilter'
, searchQuantumTasksFilter_operator
- An operator to use in the filter.
$sel:values:SearchQuantumTasksFilter'
, searchQuantumTasksFilter_values
- The values to use for the filter.