/AWS1/CL_BRKGETJOBRESPONSE

GetJobResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_status TYPE /AWS1/BRKJOBPRIMARYSTATUS /AWS1/BRKJOBPRIMARYSTATUS

The status of the Amazon Braket hybrid job.

iv_jobarn TYPE /AWS1/BRKJOBARN /AWS1/BRKJOBARN

The ARN of the Amazon Braket hybrid job.

iv_rolearn TYPE /AWS1/BRKROLEARN /AWS1/BRKROLEARN

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 results and other hybrid job details to the s3 buckets of a user.

iv_jobname TYPE /AWS1/BRKSTRING /AWS1/BRKSTRING

The name of the Amazon Braket hybrid job.

io_outputdataconfig TYPE REF TO /AWS1/CL_BRKJOBOUTPUTDATACFG /AWS1/CL_BRKJOBOUTPUTDATACFG

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

io_algorithmspecification TYPE REF TO /AWS1/CL_BRKALGORITHMSPEC /AWS1/CL_BRKALGORITHMSPEC

Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

io_instanceconfig TYPE REF TO /AWS1/CL_BRKINSTANCECONFIG /AWS1/CL_BRKINSTANCECONFIG

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

iv_createdat TYPE /AWS1/BRKTIMESTAMP /AWS1/BRKTIMESTAMP

The time at which the Amazon Braket hybrid job was created.

Optional arguments:

iv_failurereason TYPE /AWS1/BRKSTRING1024 /AWS1/BRKSTRING1024

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

it_hyperparameters TYPE /AWS1/CL_BRKHYPERPARAMETERS_W=>TT_HYPERPARAMETERS TT_HYPERPARAMETERS

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

it_inputdataconfig TYPE /AWS1/CL_BRKINPUTFILECONFIG=>TT_INPUTCONFIGLIST TT_INPUTCONFIGLIST

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

io_stoppingcondition TYPE REF TO /AWS1/CL_BRKJOBSTOPPINGCOND /AWS1/CL_BRKJOBSTOPPINGCOND

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

io_checkpointconfig TYPE REF TO /AWS1/CL_BRKJOBCHECKPOINTCFG /AWS1/CL_BRKJOBCHECKPOINTCFG

Information about the output locations for hybrid job checkpoint data.

iv_startedat TYPE /AWS1/BRKTIMESTAMP /AWS1/BRKTIMESTAMP

The time at which the Amazon Braket hybrid job was started.

iv_endedat TYPE /AWS1/BRKTIMESTAMP /AWS1/BRKTIMESTAMP

The time at which the Amazon Braket hybrid job ended.

iv_billableduration TYPE /AWS1/BRKINTEGER /AWS1/BRKINTEGER

The billable time for which the Amazon Braket hybrid job used to complete.

io_deviceconfig TYPE REF TO /AWS1/CL_BRKDEVICECONFIG /AWS1/CL_BRKDEVICECONFIG

The primary device used by the Amazon Braket hybrid job.

it_events TYPE /AWS1/CL_BRKJOBEVENTDETAILS=>TT_JOBEVENTS TT_JOBEVENTS

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

it_tags TYPE /AWS1/CL_BRKTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

The tags associated with this hybrid job.

io_queueinfo TYPE REF TO /AWS1/CL_BRKHYBRIDJOBQUEUEINFO /AWS1/CL_BRKHYBRIDJOBQUEUEINFO

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

it_associations TYPE /AWS1/CL_BRKASSOCIATION=>TT_ASSOCIATIONS TT_ASSOCIATIONS

The list of Amazon Braket resources associated with the hybrid job.

---

Queryable Attributes

status

The status of the Amazon Braket hybrid job.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

jobArn

The ARN of the Amazon Braket hybrid job.

Accessible with the following methods

Method	Description
GET_JOBARN()	Getter for JOBARN, with configurable default
ASK_JOBARN()	Getter for JOBARN w/ exceptions if field has no value
HAS_JOBARN()	Determine if JOBARN has a value

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 results and other hybrid job details to the s3 buckets of a user.

Accessible with the following methods

Method	Description
GET_ROLEARN()	Getter for ROLEARN, with configurable default
ASK_ROLEARN()	Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN()	Determine if ROLEARN has a value

failureReason

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

Accessible with the following methods

Method	Description
GET_FAILUREREASON()	Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON()	Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON()	Determine if FAILUREREASON has a value

jobName

The name of the Amazon Braket hybrid job.

Accessible with the following methods

Method	Description
GET_JOBNAME()	Getter for JOBNAME, with configurable default
ASK_JOBNAME()	Getter for JOBNAME w/ exceptions if field has no value
HAS_JOBNAME()	Determine if JOBNAME has a value

hyperParameters

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

Accessible with the following methods

Method	Description
GET_HYPERPARAMETERS()	Getter for HYPERPARAMETERS, with configurable default
ASK_HYPERPARAMETERS()	Getter for HYPERPARAMETERS w/ exceptions if field has no val
HAS_HYPERPARAMETERS()	Determine if HYPERPARAMETERS has a value

inputDataConfig

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

Accessible with the following methods

Method	Description
GET_INPUTDATACONFIG()	Getter for INPUTDATACONFIG, with configurable default
ASK_INPUTDATACONFIG()	Getter for INPUTDATACONFIG w/ exceptions if field has no val
HAS_INPUTDATACONFIG()	Determine if INPUTDATACONFIG has a value

outputDataConfig

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

Accessible with the following methods

Method	Description
GET_OUTPUTDATACONFIG()	Getter for OUTPUTDATACONFIG

stoppingCondition

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

Accessible with the following methods

Method	Description
GET_STOPPINGCONDITION()	Getter for STOPPINGCONDITION

checkpointConfig

Information about the output locations for hybrid job checkpoint data.

Accessible with the following methods

Method	Description
GET_CHECKPOINTCONFIG()	Getter for CHECKPOINTCONFIG

algorithmSpecification

Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

Accessible with the following methods

Method	Description
GET_ALGORITHMSPECIFICATION()	Getter for ALGORITHMSPECIFICATION

instanceConfig

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

Accessible with the following methods

Method	Description
GET_INSTANCECONFIG()	Getter for INSTANCECONFIG

createdAt

The time at which the Amazon Braket hybrid job was created.

Accessible with the following methods

Method	Description
GET_CREATEDAT()	Getter for CREATEDAT, with configurable default
ASK_CREATEDAT()	Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT()	Determine if CREATEDAT has a value

startedAt

The time at which the Amazon Braket hybrid job was started.

Accessible with the following methods

Method	Description
GET_STARTEDAT()	Getter for STARTEDAT, with configurable default
ASK_STARTEDAT()	Getter for STARTEDAT w/ exceptions if field has no value
HAS_STARTEDAT()	Determine if STARTEDAT has a value

endedAt

The time at which the Amazon Braket hybrid job ended.

Accessible with the following methods

Method	Description
GET_ENDEDAT()	Getter for ENDEDAT, with configurable default
ASK_ENDEDAT()	Getter for ENDEDAT w/ exceptions if field has no value
HAS_ENDEDAT()	Determine if ENDEDAT has a value

billableDuration

The billable time for which the Amazon Braket hybrid job used to complete.

Accessible with the following methods

Method	Description
GET_BILLABLEDURATION()	Getter for BILLABLEDURATION, with configurable default
ASK_BILLABLEDURATION()	Getter for BILLABLEDURATION w/ exceptions if field has no va
HAS_BILLABLEDURATION()	Determine if BILLABLEDURATION has a value

deviceConfig

The primary device used by the Amazon Braket hybrid job.

Accessible with the following methods

Method	Description
GET_DEVICECONFIG()	Getter for DEVICECONFIG

events

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

Accessible with the following methods

Method	Description
GET_EVENTS()	Getter for EVENTS, with configurable default
ASK_EVENTS()	Getter for EVENTS w/ exceptions if field has no value
HAS_EVENTS()	Determine if EVENTS has a value

tags

The tags associated with this hybrid job.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

queueInfo

Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

Accessible with the following methods

Method	Description
GET_QUEUEINFO()	Getter for QUEUEINFO

associations

The list of Amazon Braket resources associated with the hybrid job.

Accessible with the following methods

Method	Description
GET_ASSOCIATIONS()	Getter for ASSOCIATIONS, with configurable default
ASK_ASSOCIATIONS()	Getter for ASSOCIATIONS w/ exceptions if field has no value
HAS_ASSOCIATIONS()	Determine if ASSOCIATIONS has a value