Skip to content

/AWS1/CL_ML_GETMLMODELOUTPUT

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_mlmodelid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID

The MLModel ID, which is same as the MLModelId in the request.

iv_trainingdatasourceid TYPE /AWS1/ML_ENTITYID /AWS1/ML_ENTITYID

The ID of the training DataSource.

iv_createdbyiamuser TYPE /AWS1/ML_AWSUSERARN /AWS1/ML_AWSUSERARN

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

iv_createdat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

The time that the MLModel was created. The time is expressed in epoch time.

iv_lastupdatedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

iv_name TYPE /AWS1/ML_MLMODELNAME /AWS1/ML_MLMODELNAME

A user-supplied name or description of the MLModel.

iv_status TYPE /AWS1/ML_ENTITYSTATUS /AWS1/ML_ENTITYSTATUS

The current status of the MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.

  • INPROGRESS - The request is processing.

  • FAILED - The request did not run to completion. The ML model isn't usable.

  • COMPLETED - The request completed successfully.

  • DELETED - The MLModel is marked as deleted. It isn't usable.

iv_sizeinbytes TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE

Long integer type that is a 64-bit signed number.

io_endpointinfo TYPE REF TO /AWS1/CL_ML_REALTIMEENDPTINFO /AWS1/CL_ML_REALTIMEENDPTINFO

The current endpoint of the MLModel

it_trainingparameters TYPE /AWS1/CL_ML_TRAININGPARAMS_W=>TT_TRAININGPARAMETERS TT_TRAININGPARAMETERS

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

iv_inputdatalocations3 TYPE /AWS1/ML_S3URL /AWS1/ML_S3URL

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

iv_mlmodeltype TYPE /AWS1/ML_MLMODELTYPE /AWS1/ML_MLMODELTYPE

Identifies the MLModel category. The following are the available types:

  • REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"

  • BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"

  • MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"

iv_scorethreshold TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

iv_scorethreshlastupdatedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

iv_loguri TYPE /AWS1/ML_PRESIGNEDS3URL /AWS1/ML_PRESIGNEDS3URL

A link to the file that contains logs of the CreateMLModel operation.

iv_message TYPE /AWS1/ML_MESSAGE /AWS1/ML_MESSAGE

A description of the most recent details about accessing the MLModel.

iv_computetime TYPE /AWS1/ML_LONGTYPE /AWS1/ML_LONGTYPE

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

iv_finishedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

iv_startedat TYPE /AWS1/ML_EPOCHTIME /AWS1/ML_EPOCHTIME

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

iv_recipe TYPE /AWS1/ML_RECIPE /AWS1/ML_RECIPE

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note: This parameter is provided as part of the verbose format.

iv_schema TYPE /AWS1/ML_DATASCHEMA /AWS1/ML_DATASCHEMA

The schema used by all of the data files referenced by the DataSource.

Note: This parameter is provided as part of the verbose format.

Queryable Attributes

MLModelId

The MLModel ID, which is same as the MLModelId in the request.

Accessible with the following methods

Method Description
GET_MLMODELID() Getter for MLMODELID, with configurable default
ASK_MLMODELID() Getter for MLMODELID w/ exceptions if field has no value
HAS_MLMODELID() Determine if MLMODELID has a value

TrainingDataSourceId

The ID of the training DataSource.

Accessible with the following methods

Method Description
GET_TRAININGDATASOURCEID() Getter for TRAININGDATASOURCEID, with configurable default
ASK_TRAININGDATASOURCEID() Getter for TRAININGDATASOURCEID w/ exceptions if field has n
HAS_TRAININGDATASOURCEID() Determine if TRAININGDATASOURCEID has a value

CreatedByIamUser

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

Accessible with the following methods

Method Description
GET_CREATEDBYIAMUSER() Getter for CREATEDBYIAMUSER, with configurable default
ASK_CREATEDBYIAMUSER() Getter for CREATEDBYIAMUSER w/ exceptions if field has no va
HAS_CREATEDBYIAMUSER() Determine if CREATEDBYIAMUSER has a value

CreatedAt

The time that the MLModel was created. The time is expressed in epoch time.

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

LastUpdatedAt

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

Accessible with the following methods

Method Description
GET_LASTUPDATEDAT() Getter for LASTUPDATEDAT, with configurable default
ASK_LASTUPDATEDAT() Getter for LASTUPDATEDAT w/ exceptions if field has no value
HAS_LASTUPDATEDAT() Determine if LASTUPDATEDAT has a value

Name

A user-supplied name or description of the MLModel.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

Status

The current status of the MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.

  • INPROGRESS - The request is processing.

  • FAILED - The request did not run to completion. The ML model isn't usable.

  • COMPLETED - The request completed successfully.

  • DELETED - The MLModel is marked as deleted. It isn't usable.

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

SizeInBytes

Long integer type that is a 64-bit signed number.

Accessible with the following methods

Method Description
GET_SIZEINBYTES() Getter for SIZEINBYTES, with configurable default
ASK_SIZEINBYTES() Getter for SIZEINBYTES w/ exceptions if field has no value
HAS_SIZEINBYTES() Determine if SIZEINBYTES has a value

EndpointInfo

The current endpoint of the MLModel

Accessible with the following methods

Method Description
GET_ENDPOINTINFO() Getter for ENDPOINTINFO

TrainingParameters

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

Accessible with the following methods

Method Description
GET_TRAININGPARAMETERS() Getter for TRAININGPARAMETERS, with configurable default
ASK_TRAININGPARAMETERS() Getter for TRAININGPARAMETERS w/ exceptions if field has no
HAS_TRAININGPARAMETERS() Determine if TRAININGPARAMETERS has a value

InputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

Accessible with the following methods

Method Description
GET_INPUTDATALOCATIONS3() Getter for INPUTDATALOCATIONS3, with configurable default
ASK_INPUTDATALOCATIONS3() Getter for INPUTDATALOCATIONS3 w/ exceptions if field has no
HAS_INPUTDATALOCATIONS3() Determine if INPUTDATALOCATIONS3 has a value

MLModelType

Identifies the MLModel category. The following are the available types:

  • REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"

  • BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"

  • MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"

Accessible with the following methods

Method Description
GET_MLMODELTYPE() Getter for MLMODELTYPE, with configurable default
ASK_MLMODELTYPE() Getter for MLMODELTYPE w/ exceptions if field has no value
HAS_MLMODELTYPE() Determine if MLMODELTYPE has a value

ScoreThreshold

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

Accessible with the following methods

Method Description
GET_SCORETHRESHOLD() Getter for SCORETHRESHOLD, with configurable default
ASK_SCORETHRESHOLD() Getter for SCORETHRESHOLD w/ exceptions if field has no valu
STR_SCORETHRESHOLD() String format for SCORETHRESHOLD, with configurable default
HAS_SCORETHRESHOLD() Determine if SCORETHRESHOLD has a value

ScoreThresholdLastUpdatedAt

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

Accessible with the following methods

Method Description
GET_SCORETHRESHLASTUPDATEDAT() Getter for SCORETHRESHOLDLASTUPDATEDAT, with configurable de
ASK_SCORETHRESHLASTUPDATEDAT() Getter for SCORETHRESHOLDLASTUPDATEDAT w/ exceptions if fiel
HAS_SCORETHRESHLASTUPDATEDAT() Determine if SCORETHRESHOLDLASTUPDATEDAT has a value

LogUri

A link to the file that contains logs of the CreateMLModel operation.

Accessible with the following methods

Method Description
GET_LOGURI() Getter for LOGURI, with configurable default
ASK_LOGURI() Getter for LOGURI w/ exceptions if field has no value
HAS_LOGURI() Determine if LOGURI has a value

Message

A description of the most recent details about accessing the MLModel.

Accessible with the following methods

Method Description
GET_MESSAGE() Getter for MESSAGE, with configurable default
ASK_MESSAGE() Getter for MESSAGE w/ exceptions if field has no value
HAS_MESSAGE() Determine if MESSAGE has a value

ComputeTime

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

Accessible with the following methods

Method Description
GET_COMPUTETIME() Getter for COMPUTETIME, with configurable default
ASK_COMPUTETIME() Getter for COMPUTETIME w/ exceptions if field has no value
HAS_COMPUTETIME() Determine if COMPUTETIME has a value

FinishedAt

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

Accessible with the following methods

Method Description
GET_FINISHEDAT() Getter for FINISHEDAT, with configurable default
ASK_FINISHEDAT() Getter for FINISHEDAT w/ exceptions if field has no value
HAS_FINISHEDAT() Determine if FINISHEDAT has a value

StartedAt

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

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

Recipe

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note: This parameter is provided as part of the verbose format.

Accessible with the following methods

Method Description
GET_RECIPE() Getter for RECIPE, with configurable default
ASK_RECIPE() Getter for RECIPE w/ exceptions if field has no value
HAS_RECIPE() Determine if RECIPE has a value

Schema

The schema used by all of the data files referenced by the DataSource.

Note: This parameter is provided as part of the verbose format.

Accessible with the following methods

Method Description
GET_SCHEMA() Getter for SCHEMA, with configurable default
ASK_SCHEMA() Getter for SCHEMA w/ exceptions if field has no value
HAS_SCHEMA() Determine if SCHEMA has a value