/AWS1/CL_BDKGETCUSTOMMODELRSP¶
GetCustomModelResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_modelarn TYPE /AWS1/BDKMODELARN /AWS1/BDKMODELARN¶
Amazon Resource Name (ARN) associated with this model.
iv_modelname TYPE /AWS1/BDKCUSTOMMODELNAME /AWS1/BDKCUSTOMMODELNAME¶
Model name associated with this model.
iv_creationtime TYPE /AWS1/BDKTIMESTAMP /AWS1/BDKTIMESTAMP¶
Creation time of the model.
Optional arguments:¶
iv_jobname TYPE /AWS1/BDKJOBNAME /AWS1/BDKJOBNAME¶
Job name associated with this model.
iv_jobarn TYPE /AWS1/BDKMDELCUSTIZATIONJOBARN /AWS1/BDKMDELCUSTIZATIONJOBARN¶
Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is
NULL.
iv_basemodelarn TYPE /AWS1/BDKMODELARN /AWS1/BDKMODELARN¶
Amazon Resource Name (ARN) of the base model.
iv_customizationtype TYPE /AWS1/BDKCUSTOMIZATIONTYPE /AWS1/BDKCUSTOMIZATIONTYPE¶
The type of model customization.
iv_modelkmskeyarn TYPE /AWS1/BDKKMSKEYARN /AWS1/BDKKMSKEYARN¶
The custom model is encrypted at rest using this key.
it_hyperparameters TYPE /AWS1/CL_BDKMDELCUSTIZATIONH00=>TT_MODELCUSTIZATIONHYPERPARAMS TT_MODELCUSTIZATIONHYPERPARAMS¶
Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
io_trainingdataconfig TYPE REF TO /AWS1/CL_BDKTRAININGDATACONFIG /AWS1/CL_BDKTRAININGDATACONFIG¶
Contains information about the training dataset.
io_validationdataconfig TYPE REF TO /AWS1/CL_BDKVALIDATIONDATACFG /AWS1/CL_BDKVALIDATIONDATACFG¶
Contains information about the validation dataset.
io_outputdataconfig TYPE REF TO /AWS1/CL_BDKOUTPUTDATACONFIG /AWS1/CL_BDKOUTPUTDATACONFIG¶
Output data configuration associated with this custom model.
io_trainingmetrics TYPE REF TO /AWS1/CL_BDKTRAININGMETRICS /AWS1/CL_BDKTRAININGMETRICS¶
Contains training metrics from the job creation.
it_validationmetrics TYPE /AWS1/CL_BDKVALIDATORMETRIC=>TT_VALIDATIONMETRICS TT_VALIDATIONMETRICS¶
The validation metrics from the job creation.
io_customizationconfig TYPE REF TO /AWS1/CL_BDKCUSTOMIZATIONCFG /AWS1/CL_BDKCUSTOMIZATIONCFG¶
The customization configuration for the custom model.
iv_modelstatus TYPE /AWS1/BDKMODELSTATUS /AWS1/BDKMODELSTATUS¶
The current status of the custom model. Possible values include:
Creating- The model is being created and validated.
Active- The model has been successfully created and is ready for use.
Failed- The model creation process failed. Check thefailureMessagefield for details.
iv_failuremessage TYPE /AWS1/BDKERRORMESSAGE /AWS1/BDKERRORMESSAGE¶
A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.
Queryable Attributes¶
modelArn¶
Amazon Resource Name (ARN) associated with this model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELARN() |
Getter for MODELARN, with configurable default |
ASK_MODELARN() |
Getter for MODELARN w/ exceptions if field has no value |
HAS_MODELARN() |
Determine if MODELARN has a value |
modelName¶
Model name associated with this model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELNAME() |
Getter for MODELNAME, with configurable default |
ASK_MODELNAME() |
Getter for MODELNAME w/ exceptions if field has no value |
HAS_MODELNAME() |
Determine if MODELNAME has a value |
jobName¶
Job name associated with this model.
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 |
jobArn¶
Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is
NULL.
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 |
baseModelArn¶
Amazon Resource Name (ARN) of the base model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BASEMODELARN() |
Getter for BASEMODELARN, with configurable default |
ASK_BASEMODELARN() |
Getter for BASEMODELARN w/ exceptions if field has no value |
HAS_BASEMODELARN() |
Determine if BASEMODELARN has a value |
customizationType¶
The type of model customization.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMIZATIONTYPE() |
Getter for CUSTOMIZATIONTYPE, with configurable default |
ASK_CUSTOMIZATIONTYPE() |
Getter for CUSTOMIZATIONTYPE w/ exceptions if field has no v |
HAS_CUSTOMIZATIONTYPE() |
Determine if CUSTOMIZATIONTYPE has a value |
modelKmsKeyArn¶
The custom model is encrypted at rest using this key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELKMSKEYARN() |
Getter for MODELKMSKEYARN, with configurable default |
ASK_MODELKMSKEYARN() |
Getter for MODELKMSKEYARN w/ exceptions if field has no valu |
HAS_MODELKMSKEYARN() |
Determine if MODELKMSKEYARN has a value |
hyperParameters¶
Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
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 |
trainingDataConfig¶
Contains information about the training dataset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAININGDATACONFIG() |
Getter for TRAININGDATACONFIG |
validationDataConfig¶
Contains information about the validation dataset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VALIDATIONDATACONFIG() |
Getter for VALIDATIONDATACONFIG |
outputDataConfig¶
Output data configuration associated with this custom model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPUTDATACONFIG() |
Getter for OUTPUTDATACONFIG |
trainingMetrics¶
Contains training metrics from the job creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TRAININGMETRICS() |
Getter for TRAININGMETRICS |
validationMetrics¶
The validation metrics from the job creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VALIDATIONMETRICS() |
Getter for VALIDATIONMETRICS, with configurable default |
ASK_VALIDATIONMETRICS() |
Getter for VALIDATIONMETRICS w/ exceptions if field has no v |
HAS_VALIDATIONMETRICS() |
Determine if VALIDATIONMETRICS has a value |
creationTime¶
Creation time of the model.
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 |
customizationConfig¶
The customization configuration for the custom model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMIZATIONCONFIG() |
Getter for CUSTOMIZATIONCONFIG |
modelStatus¶
The current status of the custom model. Possible values include:
Creating- The model is being created and validated.
Active- The model has been successfully created and is ready for use.
Failed- The model creation process failed. Check thefailureMessagefield for details.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELSTATUS() |
Getter for MODELSTATUS, with configurable default |
ASK_MODELSTATUS() |
Getter for MODELSTATUS w/ exceptions if field has no value |
HAS_MODELSTATUS() |
Determine if MODELSTATUS has a value |
failureMessage¶
A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREMESSAGE() |
Getter for FAILUREMESSAGE, with configurable default |
ASK_FAILUREMESSAGE() |
Getter for FAILUREMESSAGE w/ exceptions if field has no valu |
HAS_FAILUREMESSAGE() |
Determine if FAILUREMESSAGE has a value |