| 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.Types
Contents
- Service Configuration
- Errors
- 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
Description
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
- 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' {}
- newAlgorithmSpecification :: AlgorithmSpecification
- algorithmSpecification_containerImage :: Lens' AlgorithmSpecification (Maybe ContainerImage)
- algorithmSpecification_scriptModeConfig :: Lens' AlgorithmSpecification (Maybe ScriptModeConfig)
- data ContainerImage = ContainerImage' {}
- newContainerImage :: Text -> ContainerImage
- containerImage_uri :: Lens' ContainerImage Text
- data DataSource = DataSource' {}
- newDataSource :: S3DataSource -> DataSource
- dataSource_s3DataSource :: Lens' DataSource S3DataSource
- data DeviceConfig = DeviceConfig' {}
- newDeviceConfig :: Text -> DeviceConfig
- deviceConfig_device :: Lens' DeviceConfig Text
- data DeviceSummary = DeviceSummary' {}
- newDeviceSummary :: Text -> Text -> DeviceStatus -> DeviceType -> Text -> DeviceSummary
- deviceSummary_deviceArn :: Lens' DeviceSummary Text
- deviceSummary_deviceName :: Lens' DeviceSummary Text
- deviceSummary_deviceStatus :: Lens' DeviceSummary DeviceStatus
- deviceSummary_deviceType :: Lens' DeviceSummary DeviceType
- deviceSummary_providerName :: Lens' DeviceSummary Text
- data InputFileConfig = InputFileConfig' {}
- newInputFileConfig :: Text -> DataSource -> InputFileConfig
- inputFileConfig_contentType :: Lens' InputFileConfig (Maybe Text)
- inputFileConfig_channelName :: Lens' InputFileConfig Text
- inputFileConfig_dataSource :: Lens' InputFileConfig DataSource
- data InstanceConfig = InstanceConfig' {}
- newInstanceConfig :: InstanceType -> Natural -> InstanceConfig
- instanceConfig_instanceCount :: Lens' InstanceConfig (Maybe Natural)
- instanceConfig_instanceType :: Lens' InstanceConfig InstanceType
- instanceConfig_volumeSizeInGb :: Lens' InstanceConfig Natural
- data JobCheckpointConfig = JobCheckpointConfig' {}
- newJobCheckpointConfig :: Text -> JobCheckpointConfig
- jobCheckpointConfig_localPath :: Lens' JobCheckpointConfig (Maybe Text)
- jobCheckpointConfig_s3Uri :: Lens' JobCheckpointConfig Text
- data JobEventDetails = JobEventDetails' {}
- newJobEventDetails :: JobEventDetails
- jobEventDetails_eventType :: Lens' JobEventDetails (Maybe JobEventType)
- jobEventDetails_message :: Lens' JobEventDetails (Maybe Text)
- jobEventDetails_timeOfEvent :: Lens' JobEventDetails (Maybe UTCTime)
- data JobOutputDataConfig = JobOutputDataConfig' {}
- newJobOutputDataConfig :: Text -> JobOutputDataConfig
- jobOutputDataConfig_kmsKeyId :: Lens' JobOutputDataConfig (Maybe Text)
- jobOutputDataConfig_s3Path :: Lens' JobOutputDataConfig Text
- data JobStoppingCondition = JobStoppingCondition' {}
- newJobStoppingCondition :: JobStoppingCondition
- jobStoppingCondition_maxRuntimeInSeconds :: Lens' JobStoppingCondition (Maybe Natural)
- data JobSummary = JobSummary' {}
- newJobSummary :: UTCTime -> Text -> Text -> Text -> JobPrimaryStatus -> JobSummary
- jobSummary_endedAt :: Lens' JobSummary (Maybe UTCTime)
- jobSummary_startedAt :: Lens' JobSummary (Maybe UTCTime)
- jobSummary_tags :: Lens' JobSummary (Maybe (HashMap Text Text))
- jobSummary_createdAt :: Lens' JobSummary UTCTime
- jobSummary_device :: Lens' JobSummary Text
- jobSummary_jobArn :: Lens' JobSummary Text
- jobSummary_jobName :: Lens' JobSummary Text
- jobSummary_status :: Lens' JobSummary JobPrimaryStatus
- data QuantumTaskSummary = QuantumTaskSummary' {}
- newQuantumTaskSummary :: UTCTime -> Text -> Text -> Text -> Text -> Integer -> QuantumTaskStatus -> QuantumTaskSummary
- quantumTaskSummary_endedAt :: Lens' QuantumTaskSummary (Maybe UTCTime)
- quantumTaskSummary_tags :: Lens' QuantumTaskSummary (Maybe (HashMap Text Text))
- quantumTaskSummary_createdAt :: Lens' QuantumTaskSummary UTCTime
- quantumTaskSummary_deviceArn :: Lens' QuantumTaskSummary Text
- quantumTaskSummary_outputS3Bucket :: Lens' QuantumTaskSummary Text
- quantumTaskSummary_outputS3Directory :: Lens' QuantumTaskSummary Text
- quantumTaskSummary_quantumTaskArn :: Lens' QuantumTaskSummary Text
- quantumTaskSummary_shots :: Lens' QuantumTaskSummary Integer
- quantumTaskSummary_status :: Lens' QuantumTaskSummary QuantumTaskStatus
- data S3DataSource = S3DataSource' {}
- newS3DataSource :: Text -> S3DataSource
- s3DataSource_s3Uri :: Lens' S3DataSource Text
- data ScriptModeConfig = ScriptModeConfig' {}
- newScriptModeConfig :: Text -> Text -> ScriptModeConfig
- scriptModeConfig_compressionType :: Lens' ScriptModeConfig (Maybe CompressionType)
- scriptModeConfig_entryPoint :: Lens' ScriptModeConfig Text
- scriptModeConfig_s3Uri :: Lens' ScriptModeConfig Text
- data SearchDevicesFilter = SearchDevicesFilter' {}
- newSearchDevicesFilter :: Text -> NonEmpty Text -> SearchDevicesFilter
- searchDevicesFilter_name :: Lens' SearchDevicesFilter Text
- searchDevicesFilter_values :: Lens' SearchDevicesFilter (NonEmpty Text)
- data SearchJobsFilter = SearchJobsFilter' {}
- newSearchJobsFilter :: Text -> SearchJobsFilterOperator -> NonEmpty Text -> SearchJobsFilter
- searchJobsFilter_name :: Lens' SearchJobsFilter Text
- searchJobsFilter_operator :: Lens' SearchJobsFilter SearchJobsFilterOperator
- searchJobsFilter_values :: Lens' SearchJobsFilter (NonEmpty Text)
- data SearchQuantumTasksFilter = SearchQuantumTasksFilter' {}
- newSearchQuantumTasksFilter :: Text -> SearchQuantumTasksFilterOperator -> NonEmpty Text -> SearchQuantumTasksFilter
- searchQuantumTasksFilter_name :: Lens' SearchQuantumTasksFilter Text
- searchQuantumTasksFilter_operator :: Lens' SearchQuantumTasksFilter SearchQuantumTasksFilterOperator
- searchQuantumTasksFilter_values :: Lens' SearchQuantumTasksFilter (NonEmpty Text)
Service Configuration
defaultService :: Service Source #
API version 2019-09-01 of the Amazon Braket SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
An error occurred due to a conflict.
_DeviceOfflineException :: AsError a => Fold a ServiceError Source #
The specified device is currently offline.
_DeviceRetiredException :: AsError a => Fold a ServiceError Source #
The specified device has been retired.
_InternalServiceException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception, or failure.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request failed because a service quota is exceeded.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The throttling rate limit is met.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
CancellationStatus
newtype CancellationStatus Source #
Constructors
| CancellationStatus' | |
Fields | |
Bundled Patterns
| pattern CancellationStatus_CANCELLED :: CancellationStatus | |
| pattern CancellationStatus_CANCELLING :: CancellationStatus |
Instances
CompressionType
newtype CompressionType Source #
Constructors
| CompressionType' | |
Fields | |
Bundled Patterns
| pattern CompressionType_GZIP :: CompressionType | |
| pattern CompressionType_NONE :: CompressionType |
Instances
DeviceStatus
newtype DeviceStatus Source #
Constructors
| DeviceStatus' | |
Fields | |
Bundled Patterns
| pattern DeviceStatus_OFFLINE :: DeviceStatus | |
| pattern DeviceStatus_ONLINE :: DeviceStatus | |
| pattern DeviceStatus_RETIRED :: DeviceStatus |
Instances
DeviceType
newtype DeviceType Source #
Constructors
| DeviceType' | |
Fields | |
Bundled Patterns
| pattern DeviceType_QPU :: DeviceType | |
| pattern DeviceType_SIMULATOR :: DeviceType |
Instances
InstanceType
newtype InstanceType Source #
Constructors
| InstanceType' | |
Fields | |
Bundled Patterns
Instances
JobEventType
newtype JobEventType Source #
Constructors
| JobEventType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| JobPrimaryStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| QuantumTaskStatus' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| SearchJobsFilterOperator' | |
Fields | |
Bundled Patterns
Instances
SearchQuantumTasksFilterOperator
newtype SearchQuantumTasksFilterOperator Source #
Constructors
| SearchQuantumTasksFilterOperator' | |
Fields | |
Bundled Patterns
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.
Constructors
| AlgorithmSpecification' | |
Fields
| |
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.
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
data ContainerImage Source #
The container image used to create an Amazon Braket job.
See: newContainerImage smart constructor.
Constructors
| ContainerImage' | |
Instances
Arguments
| :: Text | |
| -> ContainerImage |
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.
containerImage_uri :: Lens' ContainerImage Text Source #
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.
Constructors
| DataSource' | |
Fields
| |
Instances
Arguments
| :: S3DataSource | |
| -> DataSource |
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.
dataSource_s3DataSource :: Lens' DataSource S3DataSource Source #
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.
Constructors
| DeviceConfig' | |
Instances
Arguments
| :: Text | |
| -> DeviceConfig |
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.
deviceConfig_device :: Lens' DeviceConfig Text Source #
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.
Constructors
| DeviceSummary' | |
Fields
| |
Instances
Arguments
| :: 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.
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
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.
Constructors
| InputFileConfig' | |
Fields
| |
Instances
Arguments
| :: 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.
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
data InstanceConfig Source #
Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.
See: newInstanceConfig smart constructor.
Constructors
| InstanceConfig' | |
Fields
| |
Instances
Arguments
| :: 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.
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
data JobCheckpointConfig Source #
Contains information about the output locations for job checkpoint data.
See: newJobCheckpointConfig smart constructor.
Constructors
| JobCheckpointConfig' | |
Instances
newJobCheckpointConfig Source #
Arguments
| :: Text | |
| -> JobCheckpointConfig |
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.
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
data JobEventDetails Source #
Details about the type and time events occurred related to the Amazon Braket job.
See: newJobEventDetails smart constructor.
Constructors
| JobEventDetails' | |
Fields
| |
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.
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
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.
Constructors
| JobOutputDataConfig' | |
Fields
| |
Instances
newJobOutputDataConfig Source #
Arguments
| :: Text | |
| -> JobOutputDataConfig |
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.
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.
JobStoppingCondition
data JobStoppingCondition Source #
Specifies limits for how long an Amazon Braket job can run.
See: newJobStoppingCondition smart constructor.
Constructors
| JobStoppingCondition' | |
Fields
| |
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.
jobStoppingCondition_maxRuntimeInSeconds :: Lens' JobStoppingCondition (Maybe Natural) Source #
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.
Constructors
| JobSummary' | |
Fields
| |
Instances
Arguments
| :: 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.
jobSummary_endedAt :: Lens' JobSummary (Maybe UTCTime) Source #
The date and time that the Amazon Braket job ended.
jobSummary_startedAt :: Lens' JobSummary (Maybe UTCTime) Source #
The date and time that the Amazon Braket job was started.
jobSummary_tags :: Lens' JobSummary (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.
jobSummary_createdAt :: Lens' JobSummary UTCTime Source #
The date and time that the Amazon Braket job was created.
jobSummary_device :: Lens' JobSummary Text Source #
Provides summary information about the primary device used by an Amazon Braket job.
jobSummary_jobArn :: Lens' JobSummary Text Source #
The ARN of the Amazon Braket job.
jobSummary_jobName :: Lens' JobSummary Text Source #
The name of the Amazon Braket job.
jobSummary_status :: Lens' JobSummary JobPrimaryStatus Source #
The status of the Amazon Braket job.
QuantumTaskSummary
data QuantumTaskSummary Source #
Includes information about a quantum task.
See: newQuantumTaskSummary smart constructor.
Constructors
| QuantumTaskSummary' | |
Fields
| |
Instances
newQuantumTaskSummary Source #
Arguments
| :: 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.
quantumTaskSummary_endedAt :: Lens' QuantumTaskSummary (Maybe UTCTime) Source #
The time at which the task finished.
quantumTaskSummary_tags :: Lens' QuantumTaskSummary (Maybe (HashMap Text Text)) Source #
Displays the key, value pairs of tags associated with this quantum task.
quantumTaskSummary_createdAt :: Lens' QuantumTaskSummary UTCTime Source #
The time at which the task was created.
quantumTaskSummary_deviceArn :: Lens' QuantumTaskSummary Text Source #
The ARN of the device the task ran on.
quantumTaskSummary_outputS3Bucket :: Lens' QuantumTaskSummary Text Source #
The S3 bucket where the task result file is stored..
quantumTaskSummary_outputS3Directory :: Lens' QuantumTaskSummary Text Source #
The folder in the S3 bucket where the task result file is stored.
quantumTaskSummary_quantumTaskArn :: Lens' QuantumTaskSummary Text Source #
The ARN of the task.
quantumTaskSummary_shots :: Lens' QuantumTaskSummary Integer Source #
The shots used for the task.
quantumTaskSummary_status :: Lens' QuantumTaskSummary QuantumTaskStatus Source #
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.
Constructors
| S3DataSource' | |
Instances
Arguments
| :: Text | |
| -> S3DataSource |
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.
s3DataSource_s3Uri :: Lens' S3DataSource Text Source #
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.
Constructors
| ScriptModeConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ScriptModeConfig |
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.
scriptModeConfig_compressionType :: Lens' ScriptModeConfig (Maybe CompressionType) Source #
The type of compression used by the Python scripts for an Amazon Braket job.
scriptModeConfig_entryPoint :: Lens' ScriptModeConfig Text Source #
The path to the Python script that serves as the entry point for an Amazon Braket job.
scriptModeConfig_s3Uri :: Lens' ScriptModeConfig Text Source #
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.
Constructors
| SearchDevicesFilter' | |
Instances
newSearchDevicesFilter Source #
Arguments
| :: 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.
searchDevicesFilter_name :: Lens' SearchDevicesFilter Text Source #
The name to use to filter results.
searchDevicesFilter_values :: Lens' SearchDevicesFilter (NonEmpty Text) Source #
The values to use to filter results.
SearchJobsFilter
data SearchJobsFilter Source #
A filter used to search for Amazon Braket jobs.
See: newSearchJobsFilter smart constructor.
Constructors
| SearchJobsFilter' | |
Instances
Arguments
| :: Text | |
| -> SearchJobsFilterOperator | |
| -> NonEmpty Text | |
| -> SearchJobsFilter |
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.
searchJobsFilter_name :: Lens' SearchJobsFilter Text Source #
The name to use for the jobs filter.
searchJobsFilter_operator :: Lens' SearchJobsFilter SearchJobsFilterOperator Source #
An operator to use for the jobs filter.
searchJobsFilter_values :: Lens' SearchJobsFilter (NonEmpty Text) Source #
The values to use for the jobs filter.
SearchQuantumTasksFilter
data SearchQuantumTasksFilter Source #
A filter to use to search for tasks.
See: newSearchQuantumTasksFilter smart constructor.
Constructors
| SearchQuantumTasksFilter' | |
Instances
newSearchQuantumTasksFilter Source #
Arguments
| :: Text | |
| -> SearchQuantumTasksFilterOperator | |
| -> NonEmpty Text | |
| -> SearchQuantumTasksFilter |
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.
searchQuantumTasksFilter_name :: Lens' SearchQuantumTasksFilter Text Source #
The name of the device used for the task.
searchQuantumTasksFilter_operator :: Lens' SearchQuantumTasksFilter SearchQuantumTasksFilterOperator Source #
An operator to use in the filter.
searchQuantumTasksFilter_values :: Lens' SearchQuantumTasksFilter (NonEmpty Text) Source #
The values to use for the filter.