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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon Braket job.

Synopsis

data CreateJob = CreateJob' {
- checkpointConfig :: Maybe JobCheckpointConfig
- hyperParameters :: Maybe (HashMap Text Text)
- inputDataConfig :: Maybe [InputFileConfig]
- stoppingCondition :: Maybe JobStoppingCondition
- tags :: Maybe (HashMap Text Text)
- algorithmSpecification :: AlgorithmSpecification
- clientToken :: Text
- deviceConfig :: DeviceConfig
- instanceConfig :: InstanceConfig
- jobName :: Text
- outputDataConfig :: JobOutputDataConfig
- roleArn :: Text
}
newCreateJob :: AlgorithmSpecification -> Text -> DeviceConfig -> InstanceConfig -> Text -> JobOutputDataConfig -> Text -> CreateJob
createJob_checkpointConfig :: Lens' CreateJob (Maybe JobCheckpointConfig)
createJob_hyperParameters :: Lens' CreateJob (Maybe (HashMap Text Text))
createJob_inputDataConfig :: Lens' CreateJob (Maybe [InputFileConfig])
createJob_stoppingCondition :: Lens' CreateJob (Maybe JobStoppingCondition)
createJob_tags :: Lens' CreateJob (Maybe (HashMap Text Text))
createJob_algorithmSpecification :: Lens' CreateJob AlgorithmSpecification
createJob_clientToken :: Lens' CreateJob Text
createJob_deviceConfig :: Lens' CreateJob DeviceConfig
createJob_instanceConfig :: Lens' CreateJob InstanceConfig
createJob_jobName :: Lens' CreateJob Text
createJob_outputDataConfig :: Lens' CreateJob JobOutputDataConfig
createJob_roleArn :: Lens' CreateJob Text
data CreateJobResponse = CreateJobResponse' {
- httpStatus :: Int
- jobArn :: Text
}
newCreateJobResponse :: Int -> Text -> CreateJobResponse
createJobResponse_httpStatus :: Lens' CreateJobResponse Int
createJobResponse_jobArn :: Lens' CreateJobResponse Text

Creating a Request

data CreateJob Source #

See: newCreateJob smart constructor.

Constructors

CreateJob'

Fields

checkpointConfig :: Maybe JobCheckpointConfig
Information about the output locations for job checkpoint data.
hyperParameters :: Maybe (HashMap Text Text)
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.
inputDataConfig :: Maybe [InputFileConfig]
A list of parameters that specify the name and type of input data and where it is located.
stoppingCondition :: Maybe JobStoppingCondition
The user-defined criteria that specifies when a job stops running.
tags :: Maybe (HashMap Text Text)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
algorithmSpecification :: 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.
clientToken :: Text
A unique token that guarantees that the call to this API is idempotent.
deviceConfig :: DeviceConfig
The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.
instanceConfig :: InstanceConfig
Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
jobName :: Text
The name of the Amazon Braket job.
outputDataConfig :: JobOutputDataConfig
The path to the S3 location where you want to store job artifacts and the encryption key used to store them.
roleArn :: Text
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.

Instances

Instances details

ToJSON CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods toJSON :: CreateJob -> Value # toEncoding :: CreateJob -> Encoding # toJSONList :: [CreateJob] -> Value # toEncodingList :: [CreateJob] -> Encoding #
ToHeaders CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods toHeaders :: CreateJob -> [Header] #
ToPath CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods toPath :: CreateJob -> ByteString #
ToQuery CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods toQuery :: CreateJob -> QueryString #
AWSRequest CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Associated Types type AWSResponse CreateJob # Methods request :: (Service -> Service) -> CreateJob -> Request CreateJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJob))) #
Generic CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Associated Types type Rep CreateJob :: Type -> Type # Methods from :: CreateJob -> Rep CreateJob x # to :: Rep CreateJob x -> CreateJob #
Read CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods readsPrec :: Int -> ReadS CreateJob # readList :: ReadS [CreateJob] # readPrec :: ReadPrec CreateJob # readListPrec :: ReadPrec [CreateJob] #
Show CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods showsPrec :: Int -> CreateJob -> ShowS # show :: CreateJob -> String # showList :: [CreateJob] -> ShowS #
NFData CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods rnf :: CreateJob -> () #
Eq CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods (==) :: CreateJob -> CreateJob -> Bool # (/=) :: CreateJob -> CreateJob -> Bool #
Hashable CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob Methods hashWithSalt :: Int -> CreateJob -> Int # hash :: CreateJob -> Int #
type AWSResponse CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob type AWSResponse CreateJob = CreateJobResponse
type Rep CreateJob Source #
Instance details Defined in Amazonka.Braket.CreateJob type Rep CreateJob = D1 ('MetaData "CreateJob" "Amazonka.Braket.CreateJob" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "CreateJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checkpointConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobCheckpointConfig)) :: (S1 ('MetaSel ('Just "hyperParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputFileConfig])))) :: (S1 ('MetaSel ('Just "stoppingCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStoppingCondition)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "algorithmSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlgorithmSpecification)))) :: ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "deviceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceConfig) :: S1 ('MetaSel ('Just "instanceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InstanceConfig))) :: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobOutputDataConfig) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateJob Source #

Arguments

:: AlgorithmSpecification	`$sel:algorithmSpecification:CreateJob'`
-> Text	`$sel:clientToken:CreateJob'`
-> DeviceConfig	`$sel:deviceConfig:CreateJob'`
-> InstanceConfig	`$sel:instanceConfig:CreateJob'`
-> Text	`CreateJob`
-> JobOutputDataConfig	`$sel:outputDataConfig:CreateJob'`
-> Text	`$sel:roleArn:CreateJob'`
-> 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.

Request Lenses

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

Information about the output locations for job checkpoint data.

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

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

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

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

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

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

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

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

createJob_algorithmSpecification :: Lens' CreateJob AlgorithmSpecification Source #

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

createJob_clientToken :: Lens' CreateJob Text Source #

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

createJob_deviceConfig :: Lens' CreateJob DeviceConfig Source #

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

createJob_instanceConfig :: Lens' CreateJob InstanceConfig Source #

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

createJob_jobName :: Lens' CreateJob Text Source #

The name of the Amazon Braket job.

createJob_outputDataConfig :: Lens' CreateJob JobOutputDataConfig Source #

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

createJob_roleArn :: Lens' CreateJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

Destructuring the Response

data CreateJobResponse Source #

See: newCreateJobResponse smart constructor.

Constructors

CreateJobResponse'
Fields httpStatus :: Int The response's http status code. jobArn :: Text The ARN of the Amazon Braket job created.

Instances

Instances details

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

newCreateJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateJobResponse'`
-> Text	`CreateJobResponse`
-> CreateJobResponse

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.

Response Lenses

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.

createJobResponse_jobArn :: Lens' CreateJobResponse Text Source #

The ARN of the Amazon Braket job created.