amazonka-ml-0.3.4: Amazon Machine Learning SDK.

Safe HaskellNone
LanguageHaskell2010

Network.AWS.MachineLearning.Types

Contents

Synopsis

Service

data MachineLearning Source

Version 2014-12-12 of the Amazon Machine Learning service.

Error

data JSONError :: *

Instances

Eq JSONError 
Show JSONError 
Generic JSONError 
FromJSON JSONError 
AWSErrorCode JSONError 
type Rep JSONError = D1 D1JSONError (C1 C1_0JSONError ((:*:) (S1 S1_0_0JSONError (Rec0 (Maybe Text))) ((:*:) (S1 S1_0_1JSONError (Rec0 ErrorCode)) (S1 S1_0_2JSONError (Rec0 Text))))) 

BatchPredictionFilterVariable

PerformanceMetrics

performanceMetrics :: PerformanceMetrics Source

PerformanceMetrics constructor.

The fields accessible through corresponding lenses are:

RealtimeEndpointInfo

reiCreatedAt :: Lens' RealtimeEndpointInfo (Maybe UTCTime) Source

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

reiEndpointStatus :: Lens' RealtimeEndpointInfo (Maybe RealtimeEndpointStatus) Source

The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

NONE - Endpoint does not exist or was previously deleted. READY - Endpoint is ready to be used for real-time predictions. UPDATING - Updating/creating the endpoint.

reiEndpointUrl :: Lens' RealtimeEndpointInfo (Maybe Text) Source

The URI that specifies where to send real-time prediction requests for the MLModel.

Note The application must wait until the real-time endpoint is ready before using this URI.

reiPeakRequestsPerSecond :: Lens' RealtimeEndpointInfo (Maybe Int) Source

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

Prediction

pPredictedLabel :: Lens' Prediction (Maybe Text) Source

The prediction label for either a BINARY or MULTICLASS MLModel.

pPredictedValue :: Lens' Prediction (Maybe Double) Source

The prediction value for REGRESSION MLModel.

S3DataSpec

sdsDataLocationS3 :: Lens' S3DataSpec Text Source

The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.

sdsDataRearrangement :: Lens' S3DataSpec (Maybe Text) Source

Describes the splitting requirement of a Datasource.

sdsDataSchema :: Lens' S3DataSpec (Maybe Text) Source

Describes the schema for an Amazon S3 DataSource.

sdsDataSchemaLocationS3 :: Lens' S3DataSpec (Maybe Text) Source

Describes the schema Location in Amazon S3.

DetailsAttributes

EvaluationFilterVariable

RealtimeEndpointStatus

RDSDataSpec

rdsdsDataRearrangement :: Lens' RDSDataSpec (Maybe Text) Source

DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.

Sample - ' "{"randomSeed":"some-random-seed","splitting":{"percentBegin":10,"percentEnd":60}}"'

rdsdsDataSchema :: Lens' RDSDataSpec (Maybe Text) Source

A JSON string that represents the schema. This is not required if DataSchemaUri is specified.

rdsdsDataSchemaUri :: Lens' RDSDataSpec (Maybe Text) Source

The Amazon S3 location of the DataSchema.

rdsdsDatabaseCredentials :: Lens' RDSDataSpec RDSDatabaseCredentials Source

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

rdsdsDatabaseInformation :: Lens' RDSDataSpec RDSDatabase Source

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

rdsdsResourceRole :: Lens' RDSDataSpec Text Source

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

rdsdsS3StagingLocation :: Lens' RDSDataSpec Text Source

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

rdsdsSecurityGroupIds :: Lens' RDSDataSpec [Text] Source

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

rdsdsSelectSqlQuery :: Lens' RDSDataSpec Text Source

The query that is used to retrieve the observation data for the DataSource.

rdsdsServiceRole :: Lens' RDSDataSpec Text Source

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

rdsdsSubnetId :: Lens' RDSDataSpec Text Source

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

RDSMetadata

rdsmDataPipelineId :: Lens' RDSMetadata (Maybe Text) Source

The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.

rdsmDatabase :: Lens' RDSMetadata (Maybe RDSDatabase) Source

The database details required to connect to an Amazon RDS.

rdsmResourceRole :: Lens' RDSMetadata (Maybe Text) Source

The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

rdsmSelectSqlQuery :: Lens' RDSMetadata (Maybe Text) Source

The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

rdsmServiceRole :: Lens' RDSMetadata (Maybe Text) Source

The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

RedshiftDatabase

redshiftDatabase Source

RedshiftDatabase constructor.

The fields accessible through corresponding lenses are:

RedshiftDatabaseCredentials

MLModel

mlmAlgorithm :: Lens' MLModel (Maybe Algorithm) Source

The algorithm used to train the MLModel. The following algorithm is supported:

SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function.

mlmCreatedAt :: Lens' MLModel (Maybe UTCTime) Source

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

mlmCreatedByIamUser :: Lens' MLModel (Maybe Text) Source

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.

mlmInputDataLocationS3 :: Lens' MLModel (Maybe Text) Source

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

mlmLastUpdatedAt :: Lens' MLModel (Maybe UTCTime) Source

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

mlmMLModelId :: Lens' MLModel (Maybe Text) Source

The ID assigned to the MLModel at creation.

mlmMLModelType :: Lens' MLModel (Maybe MLModelType) Source

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

REGRESSION - Produces a numeric result. For example, "What listing price should a house have?". BINARY - Produces one of two possible results. For example, "Is this a child-friendly web site?". MULTICLASS - Produces more than two possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?".

mlmMessage :: Lens' MLModel (Maybe Text) Source

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

mlmName :: Lens' MLModel (Maybe Text) Source

A user-supplied name or description of the MLModel.

mlmScoreThresholdLastUpdatedAt :: Lens' MLModel (Maybe UTCTime) Source

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

mlmStatus :: Lens' MLModel (Maybe EntityStatus) Source

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

PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel. INPROGRESS - The creation process is underway. FAILED - The request to create an MLModel did not run to completion. It is not usable. COMPLETED - The creation process completed successfully. DELETED - The MLModel is marked as deleted. It is not usable.

mlmTrainingDataSourceId :: Lens' MLModel (Maybe Text) Source

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

mlmTrainingParameters :: Lens' MLModel (HashMap Text Text) Source

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.l1RegularizationAmount' - 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, specify a small value, such as 1.0E-04 or 1.0E-08.

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

'sgd.l2RegularizationAmount' - 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, specify a small value, such as 1.0E-04 or 1.0E-08.

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

'sgd.maxPasses' - 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.maxMLModelSizeInBytes' - Maximum allowed size of the model. Depending on the input data, the model size might affect performance.

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

BatchPrediction

bpBatchPredictionDataSourceId :: Lens' BatchPrediction (Maybe Text) Source

The ID of the DataSource that points to the group of observations to predict.

bpBatchPredictionId :: Lens' BatchPrediction (Maybe Text) Source

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

bpCreatedAt :: Lens' BatchPrediction (Maybe UTCTime) Source

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

bpCreatedByIamUser :: Lens' BatchPrediction (Maybe Text) Source

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

bpInputDataLocationS3 :: Lens' BatchPrediction (Maybe Text) Source

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

bpLastUpdatedAt :: Lens' BatchPrediction (Maybe UTCTime) Source

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

bpMLModelId :: Lens' BatchPrediction (Maybe Text) Source

The ID of the MLModel that generated predictions for the BatchPrediction request.

bpMessage :: Lens' BatchPrediction (Maybe Text) Source

A description of the most recent details about processing the batch prediction request.

bpName :: Lens' BatchPrediction (Maybe Text) Source

A user-supplied name or description of the BatchPrediction.

bpOutputUri :: Lens' BatchPrediction (Maybe Text) Source

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the "outputURI" field: :, //, /./, /../.

bpStatus :: Lens' BatchPrediction (Maybe EntityStatus) Source

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

PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations. INPROGRESS - The process is underway. FAILED - The request to peform a batch prediction did not run to completion. It is not usable. COMPLETED - The batch prediction process completed successfully. DELETED - The BatchPrediction is marked as deleted. It is not usable.

SortOrder

Algorithm

EntityStatus

DataSource

dsComputeStatistics :: Lens' DataSource (Maybe Bool) Source

The parameter is true if statistics need to be generated from the observation data.

dsCreatedAt :: Lens' DataSource (Maybe UTCTime) Source

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

dsCreatedByIamUser :: Lens' DataSource (Maybe Text) Source

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

dsDataLocationS3 :: Lens' DataSource (Maybe Text) Source

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

dsDataRearrangement :: Lens' DataSource (Maybe Text) Source

A JSON string that represents the splitting requirement of a Datasource.

dsDataSizeInBytes :: Lens' DataSource (Maybe Integer) Source

The total number of observations contained in the data files that the DataSource references.

dsDataSourceId :: Lens' DataSource (Maybe Text) Source

The ID that is assigned to the DataSource during creation.

dsLastUpdatedAt :: Lens' DataSource (Maybe UTCTime) Source

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

dsMessage :: Lens' DataSource (Maybe Text) Source

A description of the most recent details about creating the DataSource.

dsName :: Lens' DataSource (Maybe Text) Source

A user-supplied name or description of the DataSource.

dsNumberOfFiles :: Lens' DataSource (Maybe Integer) Source

The number of data files referenced by the DataSource.

dsStatus :: Lens' DataSource (Maybe EntityStatus) Source

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

PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource. INPROGRESS - The creation process is underway. FAILED - The request to create a DataSource did not run to completion. It is not usable. COMPLETED - The creation process completed successfully. DELETED - The DataSource is marked as deleted. It is not usable.

RDSDatabase

rdsdatabase Source

RDSDatabase constructor.

The fields accessible through corresponding lenses are:

rdsdInstanceIdentifier :: Lens' RDSDatabase Text Source

The ID of an RDS DB instance.

RDSDatabaseCredentials

rdsdatabaseCredentials Source

RDSDatabaseCredentials constructor.

The fields accessible through corresponding lenses are:

MLModelFilterVariable

DataSourceFilterVariable

RedshiftDataSpec

rdsDataRearrangement :: Lens' RedshiftDataSpec (Maybe Text) Source

Describes the splitting specifications for a DataSource.

rdsDataSchema :: Lens' RedshiftDataSpec (Maybe Text) Source

Describes the schema for an Amazon Redshift DataSource.

rdsDataSchemaUri :: Lens' RedshiftDataSpec (Maybe Text) Source

Describes the schema location for an Amazon Redshift DataSource.

rdsDatabaseCredentials :: Lens' RedshiftDataSpec RedshiftDatabaseCredentials Source

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

rdsDatabaseInformation :: Lens' RedshiftDataSpec RedshiftDatabase Source

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

rdsS3StagingLocation :: Lens' RedshiftDataSpec Text Source

Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

rdsSelectSqlQuery :: Lens' RedshiftDataSpec Text Source

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

Evaluation

eCreatedAt :: Lens' Evaluation (Maybe UTCTime) Source

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

eCreatedByIamUser :: Lens' Evaluation (Maybe Text) Source

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

eEvaluationDataSourceId :: Lens' Evaluation (Maybe Text) Source

The ID of the DataSource that is used to evaluate the MLModel.

eEvaluationId :: Lens' Evaluation (Maybe Text) Source

The ID that is assigned to the Evaluation at creation.

eInputDataLocationS3 :: Lens' Evaluation (Maybe Text) Source

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

eLastUpdatedAt :: Lens' Evaluation (Maybe UTCTime) Source

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

eMLModelId :: Lens' Evaluation (Maybe Text) Source

The ID of the MLModel that is the focus of the evaluation.

eMessage :: Lens' Evaluation (Maybe Text) Source

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

eName :: Lens' Evaluation (Maybe Text) Source

A user-supplied name or description of the Evaluation.

ePerformanceMetrics :: Lens' Evaluation (Maybe PerformanceMetrics) Source

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the AmazonMachine Learning Developer Guide.

eStatus :: Lens' Evaluation (Maybe EntityStatus) Source

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

PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel. INPROGRESS - The evaluation is underway. FAILED - The request to evaluate an MLModel did not run to completion. It is not usable. COMPLETED - The evaluation process completed successfully. DELETED - The Evaluation is marked as deleted. It is not usable.

RedshiftMetadata

rmSelectSqlQuery :: Lens' RedshiftMetadata (Maybe Text) Source

The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

MLModelType