Amazonka.Braket.GetJob

Retrieves the specified Amazon Braket job.

Creating a Request

data GetJob

See: newGetJob smart constructor.

Constructors

GetJob'

Fields

• jobArn :: Text

  The ARN of the job to retrieve.

Instances

ToHeaders GetJob

Defined in Amazonka.Braket.GetJob

Methods

toHeaders :: GetJob -> [Header]

ToPath GetJob

Defined in Amazonka.Braket.GetJob

Methods

toPath :: GetJob -> ByteString

ToQuery GetJob

Defined in Amazonka.Braket.GetJob

Methods

toQuery :: GetJob -> QueryString

AWSRequest GetJob

Defined in Amazonka.Braket.GetJob

Associated Types

type AWSResponse GetJob

Methods

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

Defined in Amazonka.Braket.GetJob

Associated Types

type Rep GetJob :: Type -> Type

Methods

from :: GetJob -> Rep GetJob x

to :: Rep GetJob x -> GetJob

Read GetJob

Defined in Amazonka.Braket.GetJob

Methods

readsPrec :: Int -> ReadS GetJob

readList :: ReadS [GetJob]

readPrec :: ReadPrec GetJob

readListPrec :: ReadPrec [GetJob]

Show GetJob

Defined in Amazonka.Braket.GetJob

Methods

showsPrec :: Int -> GetJob -> ShowS

show :: GetJob -> String

showList :: [GetJob] -> ShowS

NFData GetJob

Defined in Amazonka.Braket.GetJob

Methods

rnf :: GetJob -> ()

Eq GetJob

Defined in Amazonka.Braket.GetJob

Methods

(==) :: GetJob -> GetJob -> Bool

(/=) :: GetJob -> GetJob -> Bool

Hashable GetJob

Defined in Amazonka.Braket.GetJob

Methods

hashWithSalt :: Int -> GetJob -> Int

hash :: GetJob -> Int

type AWSResponse GetJob

Defined in Amazonka.Braket.GetJob

type AWSResponse GetJob = GetJobResponse

type Rep GetJob

Defined in Amazonka.Braket.GetJob

type Rep GetJob = D1 ('MetaData "GetJob" "Amazonka.Braket.GetJob" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "GetJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetJob

Arguments

:: Text

GetJob

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

Request Lenses

getJob_jobArn :: Lens' GetJob Text

The ARN of the job to retrieve.

Destructuring the Response

data GetJobResponse

See: newGetJobResponse smart constructor.

Constructors

GetJobResponse'

Fields

• billableDuration :: Maybe Int

  The billable time the Amazon Braket job used to complete.

• checkpointConfig :: Maybe JobCheckpointConfig

  Information about the output locations for job checkpoint data.

• deviceConfig :: Maybe DeviceConfig

  The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

• endedAt :: Maybe ISO8601

  The date and time that the Amazon Braket job ended.

• events :: Maybe [JobEventDetails]

  Details about the type and time events occurred related to the Amazon Braket job.

• failureReason :: Maybe Text

  A description of the reason why an Amazon Braket job failed, if it failed.

• hyperParameters :: Maybe (HashMap Text Text)

  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.

• inputDataConfig :: Maybe [InputFileConfig]

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

• startedAt :: Maybe ISO8601

  The date and time that the Amazon Braket job was started.

• stoppingCondition :: Maybe JobStoppingCondition

  The user-defined criteria that specifies when to stop a job 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.

• httpStatus :: Int

  The response's http status code.

• algorithmSpecification :: 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.

• createdAt :: ISO8601

  The date and time that the Amazon Braket job was created.

• instanceConfig :: InstanceConfig

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

• jobArn :: Text

  The ARN of the Amazon Braket job.

• jobName :: Text

  The name of the Amazon Braket job.

• outputDataConfig :: JobOutputDataConfig

  The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

• 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 s3 buckets of a user.

• status :: JobPrimaryStatus

  The status of the Amazon Braket job.

Instances

Generic GetJobResponse

Defined in Amazonka.Braket.GetJob

Associated Types

type Rep GetJobResponse :: Type -> Type

Methods

from :: GetJobResponse -> Rep GetJobResponse x

to :: Rep GetJobResponse x -> GetJobResponse

Read GetJobResponse

Defined in Amazonka.Braket.GetJob

Methods

readsPrec :: Int -> ReadS GetJobResponse

readList :: ReadS [GetJobResponse]

readPrec :: ReadPrec GetJobResponse

readListPrec :: ReadPrec [GetJobResponse]

Show GetJobResponse

Defined in Amazonka.Braket.GetJob

Methods

showsPrec :: Int -> GetJobResponse -> ShowS

show :: GetJobResponse -> String

showList :: [GetJobResponse] -> ShowS

NFData GetJobResponse

Defined in Amazonka.Braket.GetJob

Methods

rnf :: GetJobResponse -> ()

Eq GetJobResponse

Defined in Amazonka.Braket.GetJob

Methods

(==) :: GetJobResponse -> GetJobResponse -> Bool

(/=) :: GetJobResponse -> GetJobResponse -> Bool

type Rep GetJobResponse

Defined in Amazonka.Braket.GetJob

type Rep GetJobResponse = D1 ('MetaData "GetJobResponse" "Amazonka.Braket.GetJob" "amazonka-braket-2.0-K4GTd9RbB3VBh6Qg8rMHaZ" 'False) (C1 ('MetaCons "GetJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "billableDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "checkpointConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobCheckpointConfig))) :*: (S1 ('MetaSel ('Just "deviceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceConfig)) :*: (S1 ('MetaSel ('Just "endedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobEventDetails]))))) :*: ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: 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 "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "algorithmSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlgorithmSpecification) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "instanceConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InstanceConfig)))) :*: ((S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: 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) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobPrimaryStatus)))))))

newGetJobResponse

Arguments

:: Int

$sel:httpStatus:GetJobResponse'

-> AlgorithmSpecification

$sel:algorithmSpecification:GetJobResponse'

-> UTCTime

GetJobResponse

-> InstanceConfig

$sel:instanceConfig:GetJobResponse'

-> Text

GetJob

-> Text

GetJobResponse

-> JobOutputDataConfig

$sel:outputDataConfig:GetJobResponse'

-> Text

$sel:roleArn:GetJobResponse'

-> JobPrimaryStatus

GetJobResponse

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

Response Lenses

getJobResponse_billableDuration :: Lens' GetJobResponse (Maybe Int)

The billable time the Amazon Braket job used to complete.

getJobResponse_checkpointConfig :: Lens' GetJobResponse (Maybe JobCheckpointConfig)

Information about the output locations for job checkpoint data.

getJobResponse_deviceConfig :: Lens' GetJobResponse (Maybe DeviceConfig)

The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.

getJobResponse_endedAt :: Lens' GetJobResponse (Maybe UTCTime)

The date and time that the Amazon Braket job ended.

getJobResponse_events :: Lens' GetJobResponse (Maybe [JobEventDetails])

Details about the type and time events occurred related to the Amazon Braket job.

getJobResponse_failureReason :: Lens' GetJobResponse (Maybe Text)

A description of the reason why an Amazon Braket job failed, if it failed.

getJobResponse_hyperParameters :: Lens' GetJobResponse (Maybe (HashMap Text Text))

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.

getJobResponse_inputDataConfig :: Lens' GetJobResponse (Maybe [InputFileConfig])

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

getJobResponse_startedAt :: Lens' GetJobResponse (Maybe UTCTime)

The date and time that the Amazon Braket job was started.

getJobResponse_stoppingCondition :: Lens' GetJobResponse (Maybe JobStoppingCondition)

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

getJobResponse_tags :: Lens' GetJobResponse (Maybe (HashMap Text Text))

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

getJobResponse_httpStatus :: Lens' GetJobResponse Int

The response's http status code.

getJobResponse_algorithmSpecification :: Lens' 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_createdAt :: Lens' GetJobResponse UTCTime

The date and time that the Amazon Braket job was created.

getJobResponse_instanceConfig :: Lens' GetJobResponse InstanceConfig

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

getJobResponse_jobArn :: Lens' GetJobResponse Text

The ARN of the Amazon Braket job.

getJobResponse_jobName :: Lens' GetJobResponse Text

The name of the Amazon Braket job.

getJobResponse_outputDataConfig :: Lens' GetJobResponse JobOutputDataConfig

The path to the S3 location where job artifacts are stored and the encryption key used to store them there.

getJobResponse_roleArn :: Lens' GetJobResponse 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 s3 buckets of a user.

getJobResponse_status :: Lens' GetJobResponse JobPrimaryStatus

The status of the Amazon Braket job.