/AWS1/CL_SGMDSCOPTIMIZATIONJ01

DescribeOptimizationJobResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_optimizationjobarn TYPE /AWS1/SGMOPTIMIZATIONJOBARN /AWS1/SGMOPTIMIZATIONJOBARN

The Amazon Resource Name (ARN) of the optimization job.

iv_optimizationjobstatus TYPE /AWS1/SGMOPTIMIZATIONJOBSTATUS /AWS1/SGMOPTIMIZATIONJOBSTATUS

The current status of the optimization job.

iv_creationtime TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

The time when you created the optimization job.

iv_lastmodifiedtime TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

The time when the optimization job was last updated.

iv_optimizationjobname TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME

The name that you assigned to the optimization job.

io_modelsource TYPE REF TO /AWS1/CL_SGMOPTIMIZATIONJOBM00 /AWS1/CL_SGMOPTIMIZATIONJOBM00

The location of the source model to optimize with an optimization job.

iv_deploymentinstancetype TYPE /AWS1/SGMOPTIMIZATIONJOBDEPL00 /AWS1/SGMOPTIMIZATIONJOBDEPL00

The type of instance that hosts the optimized model that you create with the optimization job.

it_optimizationconfigs TYPE /AWS1/CL_SGMOPTIMIZATIONCONFIG=>TT_OPTIMIZATIONCONFIGS TT_OPTIMIZATIONCONFIGS

Settings for each of the optimization techniques that the job applies.

io_outputconfig TYPE REF TO /AWS1/CL_SGMOPTIMIZATIONJOBO00 /AWS1/CL_SGMOPTIMIZATIONJOBO00

Details for where to store the optimized model that you create with the optimization job.

iv_rolearn TYPE /AWS1/SGMROLEARN /AWS1/SGMROLEARN

The ARN of the IAM role that you assigned to the optimization job.

io_stoppingcondition TYPE REF TO /AWS1/CL_SGMSTOPPINGCONDITION /AWS1/CL_SGMSTOPPINGCONDITION

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

Optional arguments:

iv_optimizationstarttime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time when the optimization job started.

iv_optimizationendtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time when the optimization job finished processing.

iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON

If the optimization job status is FAILED, the reason for the failure.

it_optimizationenvironment TYPE /AWS1/CL_SGMOPTIMIZATIONJOBE00=>TT_OPTIMIZATIONJOBENVIRONMEN00 TT_OPTIMIZATIONJOBENVIRONMEN00

The environment variables to set in the model container.

iv_maxinstancecount TYPE /AWS1/SGMOPTMZTNJOBMAXINSTCNT /AWS1/SGMOPTMZTNJOBMAXINSTCNT

The maximum number of instances to use for the optimization job.

io_optimizationoutput TYPE REF TO /AWS1/CL_SGMOPTIMIZATIONOUTPUT /AWS1/CL_SGMOPTIMIZATIONOUTPUT

Output values produced by an optimization job.

io_vpcconfig TYPE REF TO /AWS1/CL_SGMOPTIMIZATIONVPCCFG /AWS1/CL_SGMOPTIMIZATIONVPCCFG

A VPC in Amazon VPC that your optimized model has access to.

---

Queryable Attributes

OptimizationJobArn

The Amazon Resource Name (ARN) of the optimization job.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONJOBARN()	Getter for OPTIMIZATIONJOBARN, with configurable default
ASK_OPTIMIZATIONJOBARN()	Getter for OPTIMIZATIONJOBARN w/ exceptions if field has no
HAS_OPTIMIZATIONJOBARN()	Determine if OPTIMIZATIONJOBARN has a value

OptimizationJobStatus

The current status of the optimization job.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONJOBSTATUS()	Getter for OPTIMIZATIONJOBSTATUS, with configurable default
ASK_OPTIMIZATIONJOBSTATUS()	Getter for OPTIMIZATIONJOBSTATUS w/ exceptions if field has
HAS_OPTIMIZATIONJOBSTATUS()	Determine if OPTIMIZATIONJOBSTATUS has a value

OptimizationStartTime

The time when the optimization job started.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONSTARTTIME()	Getter for OPTIMIZATIONSTARTTIME, with configurable default
ASK_OPTIMIZATIONSTARTTIME()	Getter for OPTIMIZATIONSTARTTIME w/ exceptions if field has
HAS_OPTIMIZATIONSTARTTIME()	Determine if OPTIMIZATIONSTARTTIME has a value

OptimizationEndTime

The time when the optimization job finished processing.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONENDTIME()	Getter for OPTIMIZATIONENDTIME, with configurable default
ASK_OPTIMIZATIONENDTIME()	Getter for OPTIMIZATIONENDTIME w/ exceptions if field has no
HAS_OPTIMIZATIONENDTIME()	Determine if OPTIMIZATIONENDTIME has a value

CreationTime

The time when you created the optimization job.

Accessible with the following methods

Method	Description
GET_CREATIONTIME()	Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME()	Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME()	Determine if CREATIONTIME has a value

LastModifiedTime

The time when the optimization job was last updated.

Accessible with the following methods

Method	Description
GET_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME, with configurable default
ASK_LASTMODIFIEDTIME()	Getter for LASTMODIFIEDTIME w/ exceptions if field has no va
HAS_LASTMODIFIEDTIME()	Determine if LASTMODIFIEDTIME has a value

FailureReason

If the optimization job status is FAILED, the reason for the failure.

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

OptimizationJobName

The name that you assigned to the optimization job.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONJOBNAME()	Getter for OPTIMIZATIONJOBNAME, with configurable default
ASK_OPTIMIZATIONJOBNAME()	Getter for OPTIMIZATIONJOBNAME w/ exceptions if field has no
HAS_OPTIMIZATIONJOBNAME()	Determine if OPTIMIZATIONJOBNAME has a value

ModelSource

The location of the source model to optimize with an optimization job.

Accessible with the following methods

Method	Description
GET_MODELSOURCE()	Getter for MODELSOURCE

OptimizationEnvironment

The environment variables to set in the model container.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONENVIRONMENT()	Getter for OPTIMIZATIONENVIRONMENT, with configurable defaul
ASK_OPTIMIZATIONENVIRONMENT()	Getter for OPTIMIZATIONENVIRONMENT w/ exceptions if field ha
HAS_OPTIMIZATIONENVIRONMENT()	Determine if OPTIMIZATIONENVIRONMENT has a value

DeploymentInstanceType

The type of instance that hosts the optimized model that you create with the optimization job.

Accessible with the following methods

Method	Description
GET_DEPLOYMENTINSTANCETYPE()	Getter for DEPLOYMENTINSTANCETYPE, with configurable default
ASK_DEPLOYMENTINSTANCETYPE()	Getter for DEPLOYMENTINSTANCETYPE w/ exceptions if field has
HAS_DEPLOYMENTINSTANCETYPE()	Determine if DEPLOYMENTINSTANCETYPE has a value

MaxInstanceCount

The maximum number of instances to use for the optimization job.

Accessible with the following methods

Method	Description
GET_MAXINSTANCECOUNT()	Getter for MAXINSTANCECOUNT, with configurable default
ASK_MAXINSTANCECOUNT()	Getter for MAXINSTANCECOUNT w/ exceptions if field has no va
HAS_MAXINSTANCECOUNT()	Determine if MAXINSTANCECOUNT has a value

OptimizationConfigs

Settings for each of the optimization techniques that the job applies.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONCONFIGS()	Getter for OPTIMIZATIONCONFIGS, with configurable default
ASK_OPTIMIZATIONCONFIGS()	Getter for OPTIMIZATIONCONFIGS w/ exceptions if field has no
HAS_OPTIMIZATIONCONFIGS()	Determine if OPTIMIZATIONCONFIGS has a value

OutputConfig

Details for where to store the optimized model that you create with the optimization job.

Accessible with the following methods

Method	Description
GET_OUTPUTCONFIG()	Getter for OUTPUTCONFIG

OptimizationOutput

Output values produced by an optimization job.

Accessible with the following methods

Method	Description
GET_OPTIMIZATIONOUTPUT()	Getter for OPTIMIZATIONOUTPUT

RoleArn

The ARN of the IAM role that you assigned to the optimization job.

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

StoppingCondition

Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker ends the job. Use this API to cap costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

Accessible with the following methods

Method	Description
GET_STOPPINGCONDITION()	Getter for STOPPINGCONDITION

VpcConfig

A VPC in Amazon VPC that your optimized model has access to.

Accessible with the following methods

Method	Description
GET_VPCCONFIG()	Getter for VPCCONFIG