{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Braket.CreateQuantumTask -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Creates a quantum task. module Amazonka.Braket.CreateQuantumTask ( -- * Creating a Request CreateQuantumTask (..), newCreateQuantumTask, -- * Request Lenses createQuantumTask_deviceParameters, createQuantumTask_jobToken, createQuantumTask_tags, createQuantumTask_action, createQuantumTask_clientToken, createQuantumTask_deviceArn, createQuantumTask_outputS3Bucket, createQuantumTask_outputS3KeyPrefix, createQuantumTask_shots, -- * Destructuring the Response CreateQuantumTaskResponse (..), newCreateQuantumTaskResponse, -- * Response Lenses createQuantumTaskResponse_httpStatus, createQuantumTaskResponse_quantumTaskArn, ) where import Amazonka.Braket.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newCreateQuantumTask' smart constructor. data CreateQuantumTask = CreateQuantumTask' { -- | The parameters for the device to run the task on. deviceParameters :: Prelude.Maybe Prelude.Text, -- | The token for an Amazon Braket job that associates it with the quantum -- task. jobToken :: Prelude.Maybe Prelude.Text, -- | Tags to be added to the quantum task you\'re creating. tags :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text), -- | The action associated with the task. action :: Prelude.Text, -- | The client token associated with the request. clientToken :: Prelude.Text, -- | The ARN of the device to run the task on. deviceArn :: Prelude.Text, -- | The S3 bucket to store task result files in. outputS3Bucket :: Prelude.Text, -- | The key prefix for the location in the S3 bucket to store task results -- in. outputS3KeyPrefix :: Prelude.Text, -- | The number of shots to use for the task. shots :: Prelude.Natural } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateQuantumTask' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'deviceParameters', 'createQuantumTask_deviceParameters' - The parameters for the device to run the task on. -- -- 'jobToken', 'createQuantumTask_jobToken' - The token for an Amazon Braket job that associates it with the quantum -- task. -- -- 'tags', 'createQuantumTask_tags' - Tags to be added to the quantum task you\'re creating. -- -- 'action', 'createQuantumTask_action' - The action associated with the task. -- -- 'clientToken', 'createQuantumTask_clientToken' - The client token associated with the request. -- -- 'deviceArn', 'createQuantumTask_deviceArn' - The ARN of the device to run the task on. -- -- 'outputS3Bucket', 'createQuantumTask_outputS3Bucket' - The S3 bucket to store task result files in. -- -- 'outputS3KeyPrefix', 'createQuantumTask_outputS3KeyPrefix' - The key prefix for the location in the S3 bucket to store task results -- in. -- -- 'shots', 'createQuantumTask_shots' - The number of shots to use for the task. newCreateQuantumTask :: -- | 'action' Prelude.Text -> -- | 'clientToken' Prelude.Text -> -- | 'deviceArn' Prelude.Text -> -- | 'outputS3Bucket' Prelude.Text -> -- | 'outputS3KeyPrefix' Prelude.Text -> -- | 'shots' Prelude.Natural -> CreateQuantumTask newCreateQuantumTask pAction_ pClientToken_ pDeviceArn_ pOutputS3Bucket_ pOutputS3KeyPrefix_ pShots_ = CreateQuantumTask' { deviceParameters = Prelude.Nothing, jobToken = Prelude.Nothing, tags = Prelude.Nothing, action = pAction_, clientToken = pClientToken_, deviceArn = pDeviceArn_, outputS3Bucket = pOutputS3Bucket_, outputS3KeyPrefix = pOutputS3KeyPrefix_, shots = pShots_ } -- | The parameters for the device to run the task on. createQuantumTask_deviceParameters :: Lens.Lens' CreateQuantumTask (Prelude.Maybe Prelude.Text) createQuantumTask_deviceParameters = Lens.lens (\CreateQuantumTask' {deviceParameters} -> deviceParameters) (\s@CreateQuantumTask' {} a -> s {deviceParameters = a} :: CreateQuantumTask) -- | The token for an Amazon Braket job that associates it with the quantum -- task. createQuantumTask_jobToken :: Lens.Lens' CreateQuantumTask (Prelude.Maybe Prelude.Text) createQuantumTask_jobToken = Lens.lens (\CreateQuantumTask' {jobToken} -> jobToken) (\s@CreateQuantumTask' {} a -> s {jobToken = a} :: CreateQuantumTask) -- | Tags to be added to the quantum task you\'re creating. createQuantumTask_tags :: Lens.Lens' CreateQuantumTask (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) createQuantumTask_tags = Lens.lens (\CreateQuantumTask' {tags} -> tags) (\s@CreateQuantumTask' {} a -> s {tags = a} :: CreateQuantumTask) Prelude.. Lens.mapping Lens.coerced -- | The action associated with the task. createQuantumTask_action :: Lens.Lens' CreateQuantumTask Prelude.Text createQuantumTask_action = Lens.lens (\CreateQuantumTask' {action} -> action) (\s@CreateQuantumTask' {} a -> s {action = a} :: CreateQuantumTask) -- | The client token associated with the request. createQuantumTask_clientToken :: Lens.Lens' CreateQuantumTask Prelude.Text createQuantumTask_clientToken = Lens.lens (\CreateQuantumTask' {clientToken} -> clientToken) (\s@CreateQuantumTask' {} a -> s {clientToken = a} :: CreateQuantumTask) -- | The ARN of the device to run the task on. createQuantumTask_deviceArn :: Lens.Lens' CreateQuantumTask Prelude.Text createQuantumTask_deviceArn = Lens.lens (\CreateQuantumTask' {deviceArn} -> deviceArn) (\s@CreateQuantumTask' {} a -> s {deviceArn = a} :: CreateQuantumTask) -- | The S3 bucket to store task result files in. createQuantumTask_outputS3Bucket :: Lens.Lens' CreateQuantumTask Prelude.Text createQuantumTask_outputS3Bucket = Lens.lens (\CreateQuantumTask' {outputS3Bucket} -> outputS3Bucket) (\s@CreateQuantumTask' {} a -> s {outputS3Bucket = a} :: CreateQuantumTask) -- | The key prefix for the location in the S3 bucket to store task results -- in. createQuantumTask_outputS3KeyPrefix :: Lens.Lens' CreateQuantumTask Prelude.Text createQuantumTask_outputS3KeyPrefix = Lens.lens (\CreateQuantumTask' {outputS3KeyPrefix} -> outputS3KeyPrefix) (\s@CreateQuantumTask' {} a -> s {outputS3KeyPrefix = a} :: CreateQuantumTask) -- | The number of shots to use for the task. createQuantumTask_shots :: Lens.Lens' CreateQuantumTask Prelude.Natural createQuantumTask_shots = Lens.lens (\CreateQuantumTask' {shots} -> shots) (\s@CreateQuantumTask' {} a -> s {shots = a} :: CreateQuantumTask) instance Core.AWSRequest CreateQuantumTask where type AWSResponse CreateQuantumTask = CreateQuantumTaskResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> CreateQuantumTaskResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (x Data..:> "quantumTaskArn") ) instance Prelude.Hashable CreateQuantumTask where hashWithSalt _salt CreateQuantumTask' {..} = _salt `Prelude.hashWithSalt` deviceParameters `Prelude.hashWithSalt` jobToken `Prelude.hashWithSalt` tags `Prelude.hashWithSalt` action `Prelude.hashWithSalt` clientToken `Prelude.hashWithSalt` deviceArn `Prelude.hashWithSalt` outputS3Bucket `Prelude.hashWithSalt` outputS3KeyPrefix `Prelude.hashWithSalt` shots instance Prelude.NFData CreateQuantumTask where rnf CreateQuantumTask' {..} = Prelude.rnf deviceParameters `Prelude.seq` Prelude.rnf jobToken `Prelude.seq` Prelude.rnf tags `Prelude.seq` Prelude.rnf action `Prelude.seq` Prelude.rnf clientToken `Prelude.seq` Prelude.rnf deviceArn `Prelude.seq` Prelude.rnf outputS3Bucket `Prelude.seq` Prelude.rnf outputS3KeyPrefix `Prelude.seq` Prelude.rnf shots instance Data.ToHeaders CreateQuantumTask where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON CreateQuantumTask where toJSON CreateQuantumTask' {..} = Data.object ( Prelude.catMaybes [ ("deviceParameters" Data..=) Prelude.<$> deviceParameters, ("jobToken" Data..=) Prelude.<$> jobToken, ("tags" Data..=) Prelude.<$> tags, Prelude.Just ("action" Data..= action), Prelude.Just ("clientToken" Data..= clientToken), Prelude.Just ("deviceArn" Data..= deviceArn), Prelude.Just ("outputS3Bucket" Data..= outputS3Bucket), Prelude.Just ("outputS3KeyPrefix" Data..= outputS3KeyPrefix), Prelude.Just ("shots" Data..= shots) ] ) instance Data.ToPath CreateQuantumTask where toPath = Prelude.const "/quantum-task" instance Data.ToQuery CreateQuantumTask where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newCreateQuantumTaskResponse' smart constructor. data CreateQuantumTaskResponse = CreateQuantumTaskResponse' { -- | The response's http status code. httpStatus :: Prelude.Int, -- | The ARN of the task created by the request. quantumTaskArn :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'CreateQuantumTaskResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpStatus', 'createQuantumTaskResponse_httpStatus' - The response's http status code. -- -- 'quantumTaskArn', 'createQuantumTaskResponse_quantumTaskArn' - The ARN of the task created by the request. newCreateQuantumTaskResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'quantumTaskArn' Prelude.Text -> CreateQuantumTaskResponse newCreateQuantumTaskResponse pHttpStatus_ pQuantumTaskArn_ = CreateQuantumTaskResponse' { httpStatus = pHttpStatus_, quantumTaskArn = pQuantumTaskArn_ } -- | The response's http status code. createQuantumTaskResponse_httpStatus :: Lens.Lens' CreateQuantumTaskResponse Prelude.Int createQuantumTaskResponse_httpStatus = Lens.lens (\CreateQuantumTaskResponse' {httpStatus} -> httpStatus) (\s@CreateQuantumTaskResponse' {} a -> s {httpStatus = a} :: CreateQuantumTaskResponse) -- | The ARN of the task created by the request. createQuantumTaskResponse_quantumTaskArn :: Lens.Lens' CreateQuantumTaskResponse Prelude.Text createQuantumTaskResponse_quantumTaskArn = Lens.lens (\CreateQuantumTaskResponse' {quantumTaskArn} -> quantumTaskArn) (\s@CreateQuantumTaskResponse' {} a -> s {quantumTaskArn = a} :: CreateQuantumTaskResponse) instance Prelude.NFData CreateQuantumTaskResponse where rnf CreateQuantumTaskResponse' {..} = Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf quantumTaskArn