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.CreateQuantumTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a quantum task.

Synopsis

data CreateQuantumTask = CreateQuantumTask' {
- deviceParameters :: Maybe Text
- jobToken :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- action :: Text
- clientToken :: Text
- deviceArn :: Text
- outputS3Bucket :: Text
- outputS3KeyPrefix :: Text
- shots :: Natural
}
newCreateQuantumTask :: Text -> Text -> Text -> Text -> Text -> Natural -> CreateQuantumTask
createQuantumTask_deviceParameters :: Lens' CreateQuantumTask (Maybe Text)
createQuantumTask_jobToken :: Lens' CreateQuantumTask (Maybe Text)
createQuantumTask_tags :: Lens' CreateQuantumTask (Maybe (HashMap Text Text))
createQuantumTask_action :: Lens' CreateQuantumTask Text
createQuantumTask_clientToken :: Lens' CreateQuantumTask Text
createQuantumTask_deviceArn :: Lens' CreateQuantumTask Text
createQuantumTask_outputS3Bucket :: Lens' CreateQuantumTask Text
createQuantumTask_outputS3KeyPrefix :: Lens' CreateQuantumTask Text
createQuantumTask_shots :: Lens' CreateQuantumTask Natural
data CreateQuantumTaskResponse = CreateQuantumTaskResponse' {
- httpStatus :: Int
- quantumTaskArn :: Text
}
newCreateQuantumTaskResponse :: Int -> Text -> CreateQuantumTaskResponse
createQuantumTaskResponse_httpStatus :: Lens' CreateQuantumTaskResponse Int
createQuantumTaskResponse_quantumTaskArn :: Lens' CreateQuantumTaskResponse Text

Creating a Request

data CreateQuantumTask Source #

See: newCreateQuantumTask smart constructor.

Constructors

CreateQuantumTask'

Fields

deviceParameters :: Maybe Text
The parameters for the device to run the task on.
jobToken :: Maybe Text
The token for an Amazon Braket job that associates it with the quantum task.
tags :: Maybe (HashMap Text Text)
Tags to be added to the quantum task you're creating.
action :: Text
The action associated with the task.
clientToken :: Text
The client token associated with the request.
deviceArn :: Text
The ARN of the device to run the task on.
outputS3Bucket :: Text
The S3 bucket to store task result files in.
outputS3KeyPrefix :: Text
The key prefix for the location in the S3 bucket to store task results in.
shots :: Natural
The number of shots to use for the task.

Instances

Instances details

ToJSON CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods toJSON :: CreateQuantumTask -> Value # toEncoding :: CreateQuantumTask -> Encoding # toJSONList :: [CreateQuantumTask] -> Value # toEncodingList :: [CreateQuantumTask] -> Encoding #
ToHeaders CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods toHeaders :: CreateQuantumTask -> [Header] #
ToPath CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods toPath :: CreateQuantumTask -> ByteString #
ToQuery CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods toQuery :: CreateQuantumTask -> QueryString #
AWSRequest CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Associated Types type AWSResponse CreateQuantumTask # Methods request :: (Service -> Service) -> CreateQuantumTask -> Request CreateQuantumTask # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateQuantumTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateQuantumTask))) #
Generic CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Associated Types type Rep CreateQuantumTask :: Type -> Type # Methods from :: CreateQuantumTask -> Rep CreateQuantumTask x # to :: Rep CreateQuantumTask x -> CreateQuantumTask #
Read CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods readsPrec :: Int -> ReadS CreateQuantumTask # readList :: ReadS [CreateQuantumTask] # readPrec :: ReadPrec CreateQuantumTask # readListPrec :: ReadPrec [CreateQuantumTask] #
Show CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods showsPrec :: Int -> CreateQuantumTask -> ShowS # show :: CreateQuantumTask -> String # showList :: [CreateQuantumTask] -> ShowS #
NFData CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods rnf :: CreateQuantumTask -> () #
Eq CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods (==) :: CreateQuantumTask -> CreateQuantumTask -> Bool # (/=) :: CreateQuantumTask -> CreateQuantumTask -> Bool #
Hashable CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods hashWithSalt :: Int -> CreateQuantumTask -> Int # hash :: CreateQuantumTask -> Int #
type AWSResponse CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask type AWSResponse CreateQuantumTask = CreateQuantumTaskResponse
type Rep CreateQuantumTask Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask type Rep CreateQuantumTask = D1 ('MetaData "CreateQuantumTask" "Amazonka.Braket.CreateQuantumTask" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "CreateQuantumTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deviceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deviceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "outputS3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "outputS3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "shots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))))

newCreateQuantumTask Source #

Arguments

:: Text	`$sel:action:CreateQuantumTask'`
-> Text	`$sel:clientToken:CreateQuantumTask'`
-> Text	`CreateQuantumTask`
-> Text	`CreateQuantumTask`
-> Text	`$sel:outputS3KeyPrefix:CreateQuantumTask'`
-> Natural	`CreateQuantumTask`
-> CreateQuantumTask

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.

Request Lenses

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

The parameters for the device to run the task on.

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

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

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

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

createQuantumTask_action :: Lens' CreateQuantumTask Text Source #

The action associated with the task.

createQuantumTask_clientToken :: Lens' CreateQuantumTask Text Source #

The client token associated with the request.

createQuantumTask_deviceArn :: Lens' CreateQuantumTask Text Source #

The ARN of the device to run the task on.

createQuantumTask_outputS3Bucket :: Lens' CreateQuantumTask Text Source #

The S3 bucket to store task result files in.

createQuantumTask_outputS3KeyPrefix :: Lens' CreateQuantumTask Text Source #

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

createQuantumTask_shots :: Lens' CreateQuantumTask Natural Source #

The number of shots to use for the task.

Destructuring the Response

data CreateQuantumTaskResponse Source #

See: newCreateQuantumTaskResponse smart constructor.

Constructors

CreateQuantumTaskResponse'
Fields httpStatus :: Int The response's http status code. quantumTaskArn :: Text The ARN of the task created by the request.

Instances

Instances details

Generic CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Associated Types type Rep CreateQuantumTaskResponse :: Type -> Type # Methods from :: CreateQuantumTaskResponse -> Rep CreateQuantumTaskResponse x # to :: Rep CreateQuantumTaskResponse x -> CreateQuantumTaskResponse #
Read CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods readsPrec :: Int -> ReadS CreateQuantumTaskResponse # readList :: ReadS [CreateQuantumTaskResponse] # readPrec :: ReadPrec CreateQuantumTaskResponse # readListPrec :: ReadPrec [CreateQuantumTaskResponse] #
Show CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods showsPrec :: Int -> CreateQuantumTaskResponse -> ShowS # show :: CreateQuantumTaskResponse -> String # showList :: [CreateQuantumTaskResponse] -> ShowS #
NFData CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods rnf :: CreateQuantumTaskResponse -> () #
Eq CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask Methods (==) :: CreateQuantumTaskResponse -> CreateQuantumTaskResponse -> Bool # (/=) :: CreateQuantumTaskResponse -> CreateQuantumTaskResponse -> Bool #
type Rep CreateQuantumTaskResponse Source #
Instance details Defined in Amazonka.Braket.CreateQuantumTask type Rep CreateQuantumTaskResponse = D1 ('MetaData "CreateQuantumTaskResponse" "Amazonka.Braket.CreateQuantumTask" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "CreateQuantumTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "quantumTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateQuantumTaskResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateQuantumTaskResponse'`
-> Text	`CreateQuantumTaskResponse`
-> 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.

Response Lenses

createQuantumTaskResponse_httpStatus :: Lens' CreateQuantumTaskResponse Int Source #

The response's http status code.

createQuantumTaskResponse_quantumTaskArn :: Lens' CreateQuantumTaskResponse Text Source #

The ARN of the task created by the request.