Network.AWS.MachineLearning.GetMLModel

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel .

GetMLModel provides results in normal or verbose format.

Creating a Request

getMLModel

Arguments

:: Text

gmlmMLModelId

-> GetMLModel

Creates a value of GetMLModel with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gmlmVerbose - Specifies whether the GetMLModel operation should return Recipe . If true, Recipe is returned. If false, Recipe is not returned.
• gmlmMLModelId - The ID assigned to the MLModel at creation.

data GetMLModel

See: getMLModel smart constructor.

Instances

Eq GetMLModel

Methods

(==) :: GetMLModel -> GetMLModel -> Bool

(/=) :: GetMLModel -> GetMLModel -> Bool

Data GetMLModel

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetMLModel -> c GetMLModel

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetMLModel

toConstr :: GetMLModel -> Constr

dataTypeOf :: GetMLModel -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetMLModel)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetMLModel)

gmapT :: (forall b. Data b => b -> b) -> GetMLModel -> GetMLModel

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetMLModel -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetMLModel -> r

gmapQ :: (forall d. Data d => d -> u) -> GetMLModel -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetMLModel -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetMLModel -> m GetMLModel

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMLModel -> m GetMLModel

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMLModel -> m GetMLModel

Read GetMLModel

Methods

readsPrec :: Int -> ReadS GetMLModel

readList :: ReadS [GetMLModel]

readPrec :: ReadPrec GetMLModel

readListPrec :: ReadPrec [GetMLModel]

Show GetMLModel

Methods

showsPrec :: Int -> GetMLModel -> ShowS

show :: GetMLModel -> String

showList :: [GetMLModel] -> ShowS

Generic GetMLModel

Associated Types

type Rep GetMLModel :: * -> *

Methods

from :: GetMLModel -> Rep GetMLModel x

to :: Rep GetMLModel x -> GetMLModel

Hashable GetMLModel

Methods

hashWithSalt :: Int -> GetMLModel -> Int

hash :: GetMLModel -> Int

ToJSON GetMLModel

Methods

toJSON :: GetMLModel -> Value

toEncoding :: GetMLModel -> Encoding

toJSONList :: [GetMLModel] -> Value

toEncodingList :: [GetMLModel] -> Encoding

NFData GetMLModel

Methods

rnf :: GetMLModel -> ()

AWSRequest GetMLModel

Associated Types

type Rs GetMLModel :: *

Methods

request :: GetMLModel -> Request GetMLModel

response :: MonadResource m => Logger -> Service -> Proxy * GetMLModel -> ClientResponse -> m (Response GetMLModel)

ToQuery GetMLModel

Methods

toQuery :: GetMLModel -> QueryString

ToPath GetMLModel

Methods

toPath :: GetMLModel -> ByteString

ToHeaders GetMLModel

Methods

toHeaders :: GetMLModel -> [Header]

type Rep GetMLModel

type Rep GetMLModel = D1 (MetaData "GetMLModel" "Network.AWS.MachineLearning.GetMLModel" "amazonka-ml-1.5.0-CbUNVP31vJd1Lf9wTXn86Z" False) (C1 (MetaCons "GetMLModel'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmVerbose") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gmlmMLModelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetMLModel

type Rs GetMLModel = GetMLModelResponse

Request Lenses

gmlmVerbose :: Lens' GetMLModel (Maybe Bool)

Specifies whether the GetMLModel operation should return Recipe . If true, Recipe is returned. If false, Recipe is not returned.

gmlmMLModelId :: Lens' GetMLModel Text

The ID assigned to the MLModel at creation.

Destructuring the Response

getMLModelResponse

Arguments

:: Int

gmlmrsResponseStatus

-> GetMLModelResponse

Creates a value of GetMLModelResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gmlmrsStatus - 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.
• gmlmrsLastUpdatedAt - The time of the most recent edit to the MLModel . The time is expressed in epoch time.
• gmlmrsTrainingParameters - 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.
• gmlmrsScoreThresholdLastUpdatedAt - The time of the most recent edit to the ScoreThreshold . The time is expressed in epoch time.
• gmlmrsCreatedAt - The time that the MLModel was created. The time is expressed in epoch time.
• gmlmrsComputeTime - 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.
• gmlmrsRecipe - 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.
• gmlmrsInputDataLocationS3 - The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
• gmlmrsMLModelId - The MLModel ID, which is same as the MLModelId in the request.
• gmlmrsSizeInBytes - Undocumented member.
• gmlmrsSchema - The schema used by all of the data files referenced by the DataSource .
• gmlmrsStartedAt - The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS . StartedAt isn't available if the MLModel is in the PENDING state.
• gmlmrsScoreThreshold - 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 .
• gmlmrsFinishedAt - 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.
• gmlmrsCreatedByIAMUser - 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.
• gmlmrsName - A user-supplied name or description of the MLModel .
• gmlmrsLogURI - A link to the file that contains logs of the CreateMLModel operation.
• gmlmrsEndpointInfo - The current endpoint of the MLModel
• gmlmrsTrainingDataSourceId - The ID of the training DataSource .
• gmlmrsMessage - A description of the most recent details about accessing the MLModel .
• gmlmrsMLModelType - 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?"
• gmlmrsResponseStatus - -- | The response status code.

data GetMLModelResponse

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

See: getMLModelResponse smart constructor.

Instances

Eq GetMLModelResponse

Methods

(==) :: GetMLModelResponse -> GetMLModelResponse -> Bool

(/=) :: GetMLModelResponse -> GetMLModelResponse -> Bool

Data GetMLModelResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetMLModelResponse -> c GetMLModelResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetMLModelResponse

toConstr :: GetMLModelResponse -> Constr

dataTypeOf :: GetMLModelResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetMLModelResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetMLModelResponse)

gmapT :: (forall b. Data b => b -> b) -> GetMLModelResponse -> GetMLModelResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetMLModelResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetMLModelResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetMLModelResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetMLModelResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetMLModelResponse -> m GetMLModelResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMLModelResponse -> m GetMLModelResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetMLModelResponse -> m GetMLModelResponse

Read GetMLModelResponse

Methods

readsPrec :: Int -> ReadS GetMLModelResponse

readList :: ReadS [GetMLModelResponse]

readPrec :: ReadPrec GetMLModelResponse

readListPrec :: ReadPrec [GetMLModelResponse]

Show GetMLModelResponse

Methods

showsPrec :: Int -> GetMLModelResponse -> ShowS

show :: GetMLModelResponse -> String

showList :: [GetMLModelResponse] -> ShowS

Generic GetMLModelResponse

Associated Types

type Rep GetMLModelResponse :: * -> *

Methods

from :: GetMLModelResponse -> Rep GetMLModelResponse x

to :: Rep GetMLModelResponse x -> GetMLModelResponse

NFData GetMLModelResponse

Methods

rnf :: GetMLModelResponse -> ()

type Rep GetMLModelResponse

type Rep GetMLModelResponse = D1 (MetaData "GetMLModelResponse" "Network.AWS.MachineLearning.GetMLModel" "amazonka-ml-1.5.0-CbUNVP31vJd1Lf9wTXn86Z" False) (C1 (MetaCons "GetMLModelResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EntityStatus))) (S1 (MetaSel (Just Symbol "_gmlmrsLastUpdatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsTrainingParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsScoreThresholdLastUpdatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_gmlmrsCreatedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsComputeTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsRecipe") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gmlmrsInputDataLocationS3") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsMLModelId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsSizeInBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_gmlmrsSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsStartedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_gmlmrsScoreThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsFinishedAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsCreatedByIAMUser") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gmlmrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsEndpointInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RealtimeEndpointInfo))) (S1 (MetaSel (Just Symbol "_gmlmrsTrainingDataSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gmlmrsMLModelType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MLModelType))) (S1 (MetaSel (Just Symbol "_gmlmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))))

Response Lenses

gmlmrsStatus :: Lens' GetMLModelResponse (Maybe 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.

gmlmrsLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)

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

gmlmrsTrainingParameters :: Lens' GetMLModelResponse (HashMap Text Text)

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.

gmlmrsScoreThresholdLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)

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

gmlmrsCreatedAt :: Lens' GetMLModelResponse (Maybe UTCTime)

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

gmlmrsComputeTime :: Lens' GetMLModelResponse (Maybe Integer)

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.

gmlmrsRecipe :: Lens' GetMLModelResponse (Maybe Text)

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.

gmlmrsInputDataLocationS3 :: Lens' GetMLModelResponse (Maybe Text)

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

gmlmrsMLModelId :: Lens' GetMLModelResponse (Maybe Text)

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

gmlmrsSizeInBytes :: Lens' GetMLModelResponse (Maybe Integer)

Undocumented member.

gmlmrsSchema :: Lens' GetMLModelResponse (Maybe Text)

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

gmlmrsStartedAt :: Lens' GetMLModelResponse (Maybe UTCTime)

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

gmlmrsScoreThreshold :: Lens' GetMLModelResponse (Maybe Double)

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 .

gmlmrsFinishedAt :: Lens' GetMLModelResponse (Maybe UTCTime)

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.

gmlmrsCreatedByIAMUser :: Lens' GetMLModelResponse (Maybe Text)

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.

gmlmrsName :: Lens' GetMLModelResponse (Maybe Text)

A user-supplied name or description of the MLModel .

gmlmrsLogURI :: Lens' GetMLModelResponse (Maybe Text)

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

gmlmrsEndpointInfo :: Lens' GetMLModelResponse (Maybe RealtimeEndpointInfo)

The current endpoint of the MLModel

gmlmrsTrainingDataSourceId :: Lens' GetMLModelResponse (Maybe Text)

The ID of the training DataSource .

gmlmrsMessage :: Lens' GetMLModelResponse (Maybe Text)

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

gmlmrsMLModelType :: Lens' GetMLModelResponse (Maybe 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?"

gmlmrsResponseStatus :: Lens' GetMLModelResponse Int

• - | The response status code.