/AWS1/CL_BTCDESCRSERVICEJOBRSP¶
DescribeServiceJobResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_jobid TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The job ID for the service job.
iv_jobname TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The name of the service job.
iv_jobqueue TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The ARN of the job queue that the service job is associated with.
iv_servicejobtype TYPE /AWS1/BTCSERVICEJOBTYPE /AWS1/BTCSERVICEJOBTYPE¶
The type of service job. For SageMaker Training jobs, this value is
SAGEMAKER_TRAINING.
iv_startedat TYPE /AWS1/BTCLONG /AWS1/BTCLONG¶
The Unix timestamp (in milliseconds) for when the service job was started.
iv_status TYPE /AWS1/BTCSERVICEJOBSTATUS /AWS1/BTCSERVICEJOBSTATUS¶
The current status of the service job.
Optional arguments:¶
it_attempts TYPE /AWS1/CL_BTCSVCJOBATTEMPTDET=>TT_SERVICEJOBATTEMPTDETAILS TT_SERVICEJOBATTEMPTDETAILS¶
A list of job attempts associated with the service job.
it_capacityusage TYPE /AWS1/CL_BTCSVCJOBCAPUSAGEDET=>TT_SVCJOBCAPUSAGEDETAILLIST TT_SVCJOBCAPUSAGEDETAILLIST¶
The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the
serviceRequestPayload.InstanceCountfield.
iv_createdat TYPE /AWS1/BTCLONG /AWS1/BTCLONG¶
The Unix timestamp (in milliseconds) for when the service job was created.
iv_isterminated TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN¶
Indicates whether the service job has been terminated.
iv_jobarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The Amazon Resource Name (ARN) of the service job.
io_latestattempt TYPE REF TO /AWS1/CL_BTCLATSTSVCJOBATTEMPT /AWS1/CL_BTCLATSTSVCJOBATTEMPT¶
The latest attempt associated with the service job.
io_retrystrategy TYPE REF TO /AWS1/CL_BTCSVCJOBRETRYSTRAG /AWS1/CL_BTCSVCJOBRETRYSTRAG¶
The retry strategy to use for failed service jobs that are submitted with this service job.
iv_scheduledat TYPE /AWS1/BTCLONG /AWS1/BTCLONG¶
The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the
SCHEDULEDstate.
iv_schedulingpriority TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER¶
The scheduling priority of the service job.
iv_servicerequestpayload TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The request, in JSON, for the service that the
SubmitServiceJoboperation is queueing.
iv_shareidentifier TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The share identifier for the service job. This is used for fair-share scheduling.
iv_quotasharename TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
The name of the quota share that the service job is associated with.
io_preemptionconfiguration TYPE REF TO /AWS1/CL_BTCSVCJOBPREEMPTNCONF /AWS1/CL_BTCSVCJOBPREEMPTNCONF¶
Specifies the service job behavior when preempted.
io_preemptionsummary TYPE REF TO /AWS1/CL_BTCSVCJOBPREEMPTNSUMM /AWS1/CL_BTCSVCJOBPREEMPTNSUMM¶
Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.
iv_statusreason TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING¶
A short, human-readable string to provide more details for the current status of the service job.
iv_stoppedat TYPE /AWS1/BTCLONG /AWS1/BTCLONG¶
The Unix timestamp (in milliseconds) for when the service job stopped running.
it_tags TYPE /AWS1/CL_BTCTAGRISTAGSMAP_W=>TT_TAGRISTAGSMAP TT_TAGRISTAGSMAP¶
The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
io_timeoutconfig TYPE REF TO /AWS1/CL_BTCSERVICEJOBTIMEOUT /AWS1/CL_BTCSERVICEJOBTIMEOUT¶
The timeout configuration for the service job.
Queryable Attributes¶
attempts¶
A list of job attempts associated with the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTEMPTS() |
Getter for ATTEMPTS, with configurable default |
ASK_ATTEMPTS() |
Getter for ATTEMPTS w/ exceptions if field has no value |
HAS_ATTEMPTS() |
Determine if ATTEMPTS has a value |
capacityUsage¶
The configured capacity for the service job, such as the number of instances. The number of instances should be the same value as the
serviceRequestPayload.InstanceCountfield.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYUSAGE() |
Getter for CAPACITYUSAGE, with configurable default |
ASK_CAPACITYUSAGE() |
Getter for CAPACITYUSAGE w/ exceptions if field has no value |
HAS_CAPACITYUSAGE() |
Determine if CAPACITYUSAGE has a value |
createdAt¶
The Unix timestamp (in milliseconds) for when the service 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 |
isTerminated¶
Indicates whether the service job has been terminated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISTERMINATED() |
Getter for ISTERMINATED, with configurable default |
ASK_ISTERMINATED() |
Getter for ISTERMINATED w/ exceptions if field has no value |
HAS_ISTERMINATED() |
Determine if ISTERMINATED has a value |
jobArn¶
The Amazon Resource Name (ARN) of the service 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 |
jobId¶
The job ID for the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBID() |
Getter for JOBID, with configurable default |
ASK_JOBID() |
Getter for JOBID w/ exceptions if field has no value |
HAS_JOBID() |
Determine if JOBID has a value |
jobName¶
The name of the service 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 |
jobQueue¶
The ARN of the job queue that the service job is associated with.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBQUEUE() |
Getter for JOBQUEUE, with configurable default |
ASK_JOBQUEUE() |
Getter for JOBQUEUE w/ exceptions if field has no value |
HAS_JOBQUEUE() |
Determine if JOBQUEUE has a value |
latestAttempt¶
The latest attempt associated with the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LATESTATTEMPT() |
Getter for LATESTATTEMPT |
retryStrategy¶
The retry strategy to use for failed service jobs that are submitted with this service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRYSTRATEGY() |
Getter for RETRYSTRATEGY |
scheduledAt¶
The Unix timestamp (in milliseconds) for when the service job was scheduled. This represents when the service job was dispatched to SageMaker and the service job transitioned to the
SCHEDULEDstate.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEDAT() |
Getter for SCHEDULEDAT, with configurable default |
ASK_SCHEDULEDAT() |
Getter for SCHEDULEDAT w/ exceptions if field has no value |
HAS_SCHEDULEDAT() |
Determine if SCHEDULEDAT has a value |
schedulingPriority¶
The scheduling priority of the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULINGPRIORITY() |
Getter for SCHEDULINGPRIORITY, with configurable default |
ASK_SCHEDULINGPRIORITY() |
Getter for SCHEDULINGPRIORITY w/ exceptions if field has no |
HAS_SCHEDULINGPRIORITY() |
Determine if SCHEDULINGPRIORITY has a value |
serviceRequestPayload¶
The request, in JSON, for the service that the
SubmitServiceJoboperation is queueing.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEREQUESTPAYLOAD() |
Getter for SERVICEREQUESTPAYLOAD, with configurable default |
ASK_SERVICEREQUESTPAYLOAD() |
Getter for SERVICEREQUESTPAYLOAD w/ exceptions if field has |
HAS_SERVICEREQUESTPAYLOAD() |
Determine if SERVICEREQUESTPAYLOAD has a value |
serviceJobType¶
The type of service job. For SageMaker Training jobs, this value is
SAGEMAKER_TRAINING.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SERVICEJOBTYPE() |
Getter for SERVICEJOBTYPE, with configurable default |
ASK_SERVICEJOBTYPE() |
Getter for SERVICEJOBTYPE w/ exceptions if field has no valu |
HAS_SERVICEJOBTYPE() |
Determine if SERVICEJOBTYPE has a value |
shareIdentifier¶
The share identifier for the service job. This is used for fair-share scheduling.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SHAREIDENTIFIER() |
Getter for SHAREIDENTIFIER, with configurable default |
ASK_SHAREIDENTIFIER() |
Getter for SHAREIDENTIFIER w/ exceptions if field has no val |
HAS_SHAREIDENTIFIER() |
Determine if SHAREIDENTIFIER has a value |
quotaShareName¶
The name of the quota share that the service job is associated with.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUOTASHARENAME() |
Getter for QUOTASHARENAME, with configurable default |
ASK_QUOTASHARENAME() |
Getter for QUOTASHARENAME w/ exceptions if field has no valu |
HAS_QUOTASHARENAME() |
Determine if QUOTASHARENAME has a value |
preemptionConfiguration¶
Specifies the service job behavior when preempted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PREEMPTIONCONFIGURATION() |
Getter for PREEMPTIONCONFIGURATION |
preemptionSummary¶
Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PREEMPTIONSUMMARY() |
Getter for PREEMPTIONSUMMARY |
startedAt¶
The Unix timestamp (in milliseconds) for when the service 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 |
status¶
The current status of the service 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 |
statusReason¶
A short, human-readable string to provide more details for the current status of the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
stoppedAt¶
The Unix timestamp (in milliseconds) for when the service job stopped running.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STOPPEDAT() |
Getter for STOPPEDAT, with configurable default |
ASK_STOPPEDAT() |
Getter for STOPPEDAT w/ exceptions if field has no value |
HAS_STOPPEDAT() |
Determine if STOPPEDAT has a value |
tags¶
The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
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 |
timeoutConfig¶
The timeout configuration for the service job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TIMEOUTCONFIG() |
Getter for TIMEOUTCONFIG |