libZSservicesZSamazonka-mlZSamazonka-ml
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MachineLearning.Lens

Description

 
Synopsis

Operations

UpdateDataSource

updateDataSource_dataSourceId :: Lens' UpdateDataSource Text Source #

The ID assigned to the DataSource during creation.

updateDataSource_dataSourceName :: Lens' UpdateDataSource Text Source #

A new user-supplied name or description of the DataSource that will replace the current description.

updateDataSourceResponse_dataSourceId :: Lens' UpdateDataSourceResponse (Maybe Text) Source #

The ID assigned to the DataSource during creation. This value should be identical to the value of the DataSourceID in the request.

DeleteDataSource

deleteDataSource_dataSourceId :: Lens' DeleteDataSource Text Source #

A user-supplied ID that uniquely identifies the DataSource.

deleteDataSourceResponse_dataSourceId :: Lens' DeleteDataSourceResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

DescribeTags

describeTags_resourceId :: Lens' DescribeTags Text Source #

The ID of the ML object. For example, exampleModelId.

describeTagsResponse_tags :: Lens' DescribeTagsResponse (Maybe [Tag]) Source #

A list of tags associated with the ML object.

CreateDataSourceFromRedshift

createDataSourceFromRedshift_dataSourceName :: Lens' CreateDataSourceFromRedshift (Maybe Text) Source #

A user-supplied name or description of the DataSource.

createDataSourceFromRedshift_computeStatistics :: Lens' CreateDataSourceFromRedshift (Maybe Bool) Source #

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

createDataSourceFromRedshift_dataSourceId :: Lens' CreateDataSourceFromRedshift Text Source #

A user-supplied ID that uniquely identifies the DataSource.

createDataSourceFromRedshift_dataSpec :: Lens' CreateDataSourceFromRedshift RedshiftDataSpec Source #

The data specification of an Amazon Redshift DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon Redshift database.
    • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
  • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.
  • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
  • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.
  • DataSchemaUri - The Amazon S3 location of the DataSchema.
  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.

    Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

createDataSourceFromRedshift_roleARN :: Lens' CreateDataSourceFromRedshift Text Source #

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

  • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster
  • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

createDataSourceFromRedshiftResponse_dataSourceId :: Lens' CreateDataSourceFromRedshiftResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

CreateDataSourceFromS3

createDataSourceFromS3_dataSourceName :: Lens' CreateDataSourceFromS3 (Maybe Text) Source #

A user-supplied name or description of the DataSource.

createDataSourceFromS3_computeStatistics :: Lens' CreateDataSourceFromS3 (Maybe Bool) Source #

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the @DataSource needs to be used for MLModel@ training.

createDataSourceFromS3_dataSourceId :: Lens' CreateDataSourceFromS3 Text Source #

A user-supplied identifier that uniquely identifies the DataSource.

createDataSourceFromS3_dataSpec :: Lens' CreateDataSourceFromS3 S3DataSpec Source #

The data specification of a DataSource:

  • DataLocationS3 - The Amazon S3 location of the observation data.
  • DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.
  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

    Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

createDataSourceFromS3Response_dataSourceId :: Lens' CreateDataSourceFromS3Response (Maybe Text) Source #

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

CreateMLModel

createMLModel_recipe :: Lens' CreateMLModel (Maybe Text) Source #

The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

createMLModel_recipeUri :: Lens' CreateMLModel (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

createMLModel_mLModelName :: Lens' CreateMLModel (Maybe Text) Source #

A user-supplied name or description of the MLModel.

createMLModel_parameters :: Lens' CreateMLModel (Maybe (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.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 the 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.

createMLModel_mLModelId :: Lens' CreateMLModel Text Source #

A user-supplied ID that uniquely identifies the MLModel.

createMLModel_mLModelType :: Lens' CreateMLModel MLModelType Source #

The category of supervised learning that this MLModel will address. Choose from the following types:

  • Choose REGRESSION if the MLModel will be used to predict a numeric value.
  • Choose BINARY if the MLModel result has two possible values.
  • Choose MULTICLASS if the MLModel result has a limited number of values.

For more information, see the Amazon Machine Learning Developer Guide.

createMLModel_trainingDataSourceId :: Lens' CreateMLModel Text Source #

The DataSource that points to the training data.

createMLModelResponse_mLModelId :: Lens' CreateMLModelResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

DeleteTags

deleteTags_tagKeys :: Lens' DeleteTags [Text] Source #

One or more tags to delete.

deleteTags_resourceId :: Lens' DeleteTags Text Source #

The ID of the tagged ML object. For example, exampleModelId.

deleteTagsResponse_resourceId :: Lens' DeleteTagsResponse (Maybe Text) Source #

The ID of the ML object from which tags were deleted.

deleteTagsResponse_resourceType :: Lens' DeleteTagsResponse (Maybe TaggableResourceType) Source #

The type of the ML object from which tags were deleted.

DeleteBatchPrediction

deleteBatchPrediction_batchPredictionId :: Lens' DeleteBatchPrediction Text Source #

A user-supplied ID that uniquely identifies the BatchPrediction.

deleteBatchPredictionResponse_batchPredictionId :: Lens' DeleteBatchPredictionResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to the value of the BatchPredictionID in the request.

UpdateBatchPrediction

updateBatchPrediction_batchPredictionId :: Lens' UpdateBatchPrediction Text Source #

The ID assigned to the BatchPrediction during creation.

updateBatchPrediction_batchPredictionName :: Lens' UpdateBatchPrediction Text Source #

A new user-supplied name or description of the BatchPrediction.

updateBatchPredictionResponse_batchPredictionId :: Lens' UpdateBatchPredictionResponse (Maybe Text) Source #

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

GetMLModel

getMLModel_verbose :: Lens' GetMLModel (Maybe Bool) Source #

Specifies whether the GetMLModel operation should return Recipe.

If true, Recipe is returned.

If false, Recipe is not returned.

getMLModel_mLModelId :: Lens' GetMLModel Text Source #

The ID assigned to the MLModel at creation.

getMLModelResponse_status :: Lens' GetMLModelResponse (Maybe EntityStatus) Source #

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.

getMLModelResponse_lastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source #

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

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

getMLModelResponse_scoreThresholdLastUpdatedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source #

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

getMLModelResponse_createdAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source #

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

getMLModelResponse_computeTime :: Lens' GetMLModelResponse (Maybe Integer) Source #

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.

getMLModelResponse_recipe :: Lens' GetMLModelResponse (Maybe Text) Source #

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.

getMLModelResponse_inputDataLocationS3 :: Lens' GetMLModelResponse (Maybe Text) Source #

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

getMLModelResponse_mLModelId :: Lens' GetMLModelResponse (Maybe Text) Source #

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

getMLModelResponse_schema :: Lens' GetMLModelResponse (Maybe Text) Source #

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

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

getMLModelResponse_startedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source #

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

getMLModelResponse_scoreThreshold :: Lens' GetMLModelResponse (Maybe Double) Source #

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.

getMLModelResponse_finishedAt :: Lens' GetMLModelResponse (Maybe UTCTime) Source #

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.

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

getMLModelResponse_name :: Lens' GetMLModelResponse (Maybe Text) Source #

A user-supplied name or description of the MLModel.

getMLModelResponse_logUri :: Lens' GetMLModelResponse (Maybe Text) Source #

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

getMLModelResponse_message :: Lens' GetMLModelResponse (Maybe Text) Source #

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

getMLModelResponse_mLModelType :: Lens' GetMLModelResponse (Maybe MLModelType) Source #

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?"

GetDataSource

getDataSource_verbose :: Lens' GetDataSource (Maybe Bool) Source #

Specifies whether the GetDataSource operation should return DataSourceSchema.

If true, DataSourceSchema is returned.

If false, DataSourceSchema is not returned.

getDataSource_dataSourceId :: Lens' GetDataSource Text Source #

The ID assigned to the DataSource at creation.

getDataSourceResponse_status :: Lens' GetDataSourceResponse (Maybe EntityStatus) Source #

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

  • PENDING - 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.

getDataSourceResponse_numberOfFiles :: Lens' GetDataSourceResponse (Maybe Integer) Source #

The number of data files referenced by the DataSource.

getDataSourceResponse_lastUpdatedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

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

getDataSourceResponse_createdAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

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

getDataSourceResponse_computeTime :: Lens' GetDataSourceResponse (Maybe Integer) Source #

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

getDataSourceResponse_dataSourceId :: Lens' GetDataSourceResponse (Maybe Text) Source #

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

getDataSourceResponse_dataSizeInBytes :: Lens' GetDataSourceResponse (Maybe Integer) Source #

The total size of observations in the data files.

getDataSourceResponse_dataSourceSchema :: Lens' GetDataSourceResponse (Maybe Text) Source #

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

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

getDataSourceResponse_startedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

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

getDataSourceResponse_finishedAt :: Lens' GetDataSourceResponse (Maybe UTCTime) Source #

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

getDataSourceResponse_createdByIamUser :: Lens' GetDataSourceResponse (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.

getDataSourceResponse_name :: Lens' GetDataSourceResponse (Maybe Text) Source #

A user-supplied name or description of the DataSource.

getDataSourceResponse_logUri :: Lens' GetDataSourceResponse (Maybe Text) Source #

A link to the file containing logs of CreateDataSourceFrom* operations.

getDataSourceResponse_dataLocationS3 :: Lens' GetDataSourceResponse (Maybe Text) Source #

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

getDataSourceResponse_computeStatistics :: Lens' GetDataSourceResponse (Maybe Bool) Source #

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

getDataSourceResponse_message :: Lens' GetDataSourceResponse (Maybe Text) Source #

The user-supplied description of the most recent details about creating the DataSource.

getDataSourceResponse_dataRearrangement :: Lens' GetDataSourceResponse (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

UpdateEvaluation

updateEvaluation_evaluationId :: Lens' UpdateEvaluation Text Source #

The ID assigned to the Evaluation during creation.

updateEvaluation_evaluationName :: Lens' UpdateEvaluation Text Source #

A new user-supplied name or description of the Evaluation that will replace the current content.

updateEvaluationResponse_evaluationId :: Lens' UpdateEvaluationResponse (Maybe Text) Source #

The ID assigned to the Evaluation during creation. This value should be identical to the value of the Evaluation in the request.

DeleteEvaluation

deleteEvaluation_evaluationId :: Lens' DeleteEvaluation Text Source #

A user-supplied ID that uniquely identifies the Evaluation to delete.

deleteEvaluationResponse_evaluationId :: Lens' DeleteEvaluationResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

DeleteMLModel

deleteMLModel_mLModelId :: Lens' DeleteMLModel Text Source #

A user-supplied ID that uniquely identifies the MLModel.

deleteMLModelResponse_mLModelId :: Lens' DeleteMLModelResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelID in the request.

UpdateMLModel

updateMLModel_mLModelName :: Lens' UpdateMLModel (Maybe Text) Source #

A user-supplied name or description of the MLModel.

updateMLModel_scoreThreshold :: Lens' UpdateMLModel (Maybe Double) Source #

The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.

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

updateMLModel_mLModelId :: Lens' UpdateMLModel Text Source #

The ID assigned to the MLModel during creation.

updateMLModelResponse_mLModelId :: Lens' UpdateMLModelResponse (Maybe Text) Source #

The ID assigned to the MLModel during creation. This value should be identical to the value of the MLModelID in the request.

GetBatchPrediction

getBatchPrediction_batchPredictionId :: Lens' GetBatchPrediction Text Source #

An ID assigned to the BatchPrediction at creation.

getBatchPredictionResponse_status :: Lens' GetBatchPredictionResponse (Maybe EntityStatus) Source #

The status of the BatchPrediction, which can be one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
  • INPROGRESS - The batch predictions are in progress.
  • FAILED - The request to perform 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.

getBatchPredictionResponse_lastUpdatedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #

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

getBatchPredictionResponse_createdAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #

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

getBatchPredictionResponse_computeTime :: Lens' GetBatchPredictionResponse (Maybe Integer) Source #

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

getBatchPredictionResponse_inputDataLocationS3 :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

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

getBatchPredictionResponse_mLModelId :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

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

getBatchPredictionResponse_batchPredictionDataSourceId :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

The ID of the DataSource that was used to create the BatchPrediction.

getBatchPredictionResponse_totalRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer) Source #

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

getBatchPredictionResponse_startedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #

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

getBatchPredictionResponse_batchPredictionId :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

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

getBatchPredictionResponse_finishedAt :: Lens' GetBatchPredictionResponse (Maybe UTCTime) Source #

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

getBatchPredictionResponse_invalidRecordCount :: Lens' GetBatchPredictionResponse (Maybe Integer) Source #

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

getBatchPredictionResponse_createdByIamUser :: Lens' GetBatchPredictionResponse (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.

getBatchPredictionResponse_name :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

A user-supplied name or description of the BatchPrediction.

getBatchPredictionResponse_logUri :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

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

getBatchPredictionResponse_message :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

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

getBatchPredictionResponse_outputUri :: Lens' GetBatchPredictionResponse (Maybe Text) Source #

The location of an Amazon S3 bucket or directory to receive the operation results.

DescribeBatchPredictions

describeBatchPredictions_eq :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

describeBatchPredictions_ge :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeBatchPredictions_prefix :: Lens' DescribeBatchPredictions (Maybe Text) Source #

A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

describeBatchPredictions_gt :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

describeBatchPredictions_ne :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

describeBatchPredictions_nextToken :: Lens' DescribeBatchPredictions (Maybe Text) Source #

An ID of the page in the paginated results.

describeBatchPredictions_sortOrder :: Lens' DescribeBatchPredictions (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of MLModels.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

describeBatchPredictions_limit :: Lens' DescribeBatchPredictions (Maybe Natural) Source #

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

describeBatchPredictions_lt :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

describeBatchPredictions_filterVariable :: Lens' DescribeBatchPredictions (Maybe BatchPredictionFilterVariable) Source #

Use one of the following variables to filter a list of BatchPrediction:

  • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
  • Status - Sets the search criteria to the BatchPrediction status.
  • Name - Sets the search criteria to the contents of the BatchPrediction ____ Name.
  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

describeBatchPredictions_le :: Lens' DescribeBatchPredictions (Maybe Text) Source #

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

describeBatchPredictionsResponse_results :: Lens' DescribeBatchPredictionsResponse (Maybe [BatchPrediction]) Source #

A list of BatchPrediction objects that meet the search criteria.

describeBatchPredictionsResponse_nextToken :: Lens' DescribeBatchPredictionsResponse (Maybe Text) Source #

The ID of the next page in the paginated results that indicates at least one more page follows.

CreateDataSourceFromRDS

createDataSourceFromRDS_dataSourceName :: Lens' CreateDataSourceFromRDS (Maybe Text) Source #

A user-supplied name or description of the DataSource.

createDataSourceFromRDS_computeStatistics :: Lens' CreateDataSourceFromRDS (Maybe Bool) Source #

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the @DataSource needs to be used for MLModel@ training.

createDataSourceFromRDS_dataSourceId :: Lens' CreateDataSourceFromRDS Text Source #

A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

createDataSourceFromRDS_rDSData :: Lens' CreateDataSourceFromRDS RDSDataSpec Source #

The data specification of an Amazon RDS DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon RDS database.
    • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.
  • DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.
  • ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
  • ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.
  • SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.
  • SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
  • S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
  • DataSchemaUri - The Amazon S3 location of the DataSchema.
  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.
  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

    Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

createDataSourceFromRDS_roleARN :: Lens' CreateDataSourceFromRDS Text Source #

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

createDataSourceFromRDSResponse_dataSourceId :: Lens' CreateDataSourceFromRDSResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

CreateEvaluation

createEvaluation_evaluationName :: Lens' CreateEvaluation (Maybe Text) Source #

A user-supplied name or description of the Evaluation.

createEvaluation_evaluationId :: Lens' CreateEvaluation Text Source #

A user-supplied ID that uniquely identifies the Evaluation.

createEvaluation_mLModelId :: Lens' CreateEvaluation Text Source #

The ID of the MLModel to evaluate.

The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.

createEvaluation_evaluationDataSourceId :: Lens' CreateEvaluation Text Source #

The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.

createEvaluationResponse_evaluationId :: Lens' CreateEvaluationResponse (Maybe Text) Source #

The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

Predict

predict_mLModelId :: Lens' Predict Text Source #

A unique identifier of the MLModel.

predict_record :: Lens' Predict (HashMap Text Text) Source #

Undocumented member.

predictResponse_httpStatus :: Lens' PredictResponse Int Source #

The response's http status code.

DeleteRealtimeEndpoint

deleteRealtimeEndpoint_mLModelId :: Lens' DeleteRealtimeEndpoint Text Source #

The ID assigned to the MLModel during creation.

deleteRealtimeEndpointResponse_mLModelId :: Lens' DeleteRealtimeEndpointResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

CreateBatchPrediction

createBatchPrediction_batchPredictionName :: Lens' CreateBatchPrediction (Maybe Text) Source #

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

createBatchPrediction_batchPredictionId :: Lens' CreateBatchPrediction Text Source #

A user-supplied ID that uniquely identifies the BatchPrediction.

createBatchPrediction_mLModelId :: Lens' CreateBatchPrediction Text Source #

The ID of the MLModel that will generate predictions for the group of observations.

createBatchPrediction_batchPredictionDataSourceId :: Lens' CreateBatchPrediction Text Source #

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

createBatchPrediction_outputUri :: Lens' CreateBatchPrediction Text Source #

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

createBatchPredictionResponse_batchPredictionId :: Lens' CreateBatchPredictionResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

GetEvaluation

getEvaluation_evaluationId :: Lens' GetEvaluation Text Source #

The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information.

getEvaluationResponse_status :: Lens' GetEvaluationResponse (Maybe EntityStatus) Source #

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

  • PENDING - Amazon Machine Language (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.

getEvaluationResponse_performanceMetrics :: Lens' GetEvaluationResponse (Maybe PerformanceMetrics) Source #

Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric 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 Amazon Machine Learning Developer Guide.

getEvaluationResponse_lastUpdatedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #

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

getEvaluationResponse_createdAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #

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

getEvaluationResponse_computeTime :: Lens' GetEvaluationResponse (Maybe Integer) Source #

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

getEvaluationResponse_inputDataLocationS3 :: Lens' GetEvaluationResponse (Maybe Text) Source #

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

getEvaluationResponse_mLModelId :: Lens' GetEvaluationResponse (Maybe Text) Source #

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

getEvaluationResponse_startedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #

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

getEvaluationResponse_finishedAt :: Lens' GetEvaluationResponse (Maybe UTCTime) Source #

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

getEvaluationResponse_createdByIamUser :: Lens' GetEvaluationResponse (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.

getEvaluationResponse_name :: Lens' GetEvaluationResponse (Maybe Text) Source #

A user-supplied name or description of the Evaluation.

getEvaluationResponse_logUri :: Lens' GetEvaluationResponse (Maybe Text) Source #

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

getEvaluationResponse_evaluationId :: Lens' GetEvaluationResponse (Maybe Text) Source #

The evaluation ID which is same as the EvaluationId in the request.

getEvaluationResponse_message :: Lens' GetEvaluationResponse (Maybe Text) Source #

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

DescribeEvaluations

describeEvaluations_eq :: Lens' DescribeEvaluations (Maybe Text) Source #

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

describeEvaluations_ge :: Lens' DescribeEvaluations (Maybe Text) Source #

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeEvaluations_prefix :: Lens' DescribeEvaluations (Maybe Text) Source #

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

describeEvaluations_gt :: Lens' DescribeEvaluations (Maybe Text) Source #

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

describeEvaluations_ne :: Lens' DescribeEvaluations (Maybe Text) Source #

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

describeEvaluations_nextToken :: Lens' DescribeEvaluations (Maybe Text) Source #

The ID of the page in the paginated results.

describeEvaluations_sortOrder :: Lens' DescribeEvaluations (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of Evaluation.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

describeEvaluations_limit :: Lens' DescribeEvaluations (Maybe Natural) Source #

The maximum number of Evaluation to include in the result.

describeEvaluations_lt :: Lens' DescribeEvaluations (Maybe Text) Source #

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

describeEvaluations_filterVariable :: Lens' DescribeEvaluations (Maybe EvaluationFilterVariable) Source #

Use one of the following variable to filter a list of Evaluation objects:

  • CreatedAt - Sets the search criteria to the Evaluation creation date.
  • Status - Sets the search criteria to the Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation ____ Name.
  • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
  • MLModelId - Sets the search criteria to the MLModel that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

describeEvaluations_le :: Lens' DescribeEvaluations (Maybe Text) Source #

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

describeEvaluationsResponse_results :: Lens' DescribeEvaluationsResponse (Maybe [Evaluation]) Source #

A list of Evaluation that meet the search criteria.

describeEvaluationsResponse_nextToken :: Lens' DescribeEvaluationsResponse (Maybe Text) Source #

The ID of the next page in the paginated results that indicates at least one more page follows.

CreateRealtimeEndpoint

createRealtimeEndpoint_mLModelId :: Lens' CreateRealtimeEndpoint Text Source #

The ID assigned to the MLModel during creation.

createRealtimeEndpointResponse_mLModelId :: Lens' CreateRealtimeEndpointResponse (Maybe Text) Source #

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

AddTags

addTags_tags :: Lens' AddTags [Tag] Source #

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

addTags_resourceId :: Lens' AddTags Text Source #

The ID of the ML object to tag. For example, exampleModelId.

addTags_resourceType :: Lens' AddTags TaggableResourceType Source #

The type of the ML object to tag.

addTagsResponse_resourceId :: Lens' AddTagsResponse (Maybe Text) Source #

The ID of the ML object that was tagged.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.

DescribeMLModels

describeMLModels_eq :: Lens' DescribeMLModels (Maybe Text) Source #

The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

describeMLModels_ge :: Lens' DescribeMLModels (Maybe Text) Source #

The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeMLModels_prefix :: Lens' DescribeMLModels (Maybe Text) Source #

A string that is found at the beginning of a variable, such as Name or Id.

For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

describeMLModels_gt :: Lens' DescribeMLModels (Maybe Text) Source #

The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

describeMLModels_ne :: Lens' DescribeMLModels (Maybe Text) Source #

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

describeMLModels_nextToken :: Lens' DescribeMLModels (Maybe Text) Source #

The ID of the page in the paginated results.

describeMLModels_sortOrder :: Lens' DescribeMLModels (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of MLModel.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

describeMLModels_limit :: Lens' DescribeMLModels (Maybe Natural) Source #

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

describeMLModels_lt :: Lens' DescribeMLModels (Maybe Text) Source #

The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

describeMLModels_filterVariable :: Lens' DescribeMLModels (Maybe MLModelFilterVariable) Source #

Use one of the following variables to filter a list of MLModel:

  • CreatedAt - Sets the search criteria to MLModel creation date.
  • Status - Sets the search criteria to MLModel status.
  • Name - Sets the search criteria to the contents of MLModel ____ Name.
  • IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
  • TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
  • RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
  • MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
  • Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
  • TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

describeMLModels_le :: Lens' DescribeMLModels (Maybe Text) Source #

The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

describeMLModelsResponse_results :: Lens' DescribeMLModelsResponse (Maybe [MLModel]) Source #

A list of MLModel that meet the search criteria.

describeMLModelsResponse_nextToken :: Lens' DescribeMLModelsResponse (Maybe Text) Source #

The ID of the next page in the paginated results that indicates at least one more page follows.

DescribeDataSources

describeDataSources_eq :: Lens' DescribeDataSources (Maybe Text) Source #

The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

describeDataSources_ge :: Lens' DescribeDataSources (Maybe Text) Source #

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

describeDataSources_prefix :: Lens' DescribeDataSources (Maybe Text) Source #

A string that is found at the beginning of a variable, such as Name or Id.

For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09
  • 2014-09-09
  • 2014-09-09-Holiday

describeDataSources_gt :: Lens' DescribeDataSources (Maybe Text) Source #

The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

describeDataSources_ne :: Lens' DescribeDataSources (Maybe Text) Source #

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

describeDataSources_nextToken :: Lens' DescribeDataSources (Maybe Text) Source #

The ID of the page in the paginated results.

describeDataSources_sortOrder :: Lens' DescribeDataSources (Maybe SortOrder) Source #

A two-value parameter that determines the sequence of the resulting list of DataSource.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

describeDataSources_limit :: Lens' DescribeDataSources (Maybe Natural) Source #

The maximum number of DataSource to include in the result.

describeDataSources_lt :: Lens' DescribeDataSources (Maybe Text) Source #

The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

describeDataSources_filterVariable :: Lens' DescribeDataSources (Maybe DataSourceFilterVariable) Source #

Use one of the following variables to filter a list of DataSource:

  • CreatedAt - Sets the search criteria to DataSource creation dates.
  • Status - Sets the search criteria to DataSource statuses.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

describeDataSources_le :: Lens' DescribeDataSources (Maybe Text) Source #

The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

describeDataSourcesResponse_results :: Lens' DescribeDataSourcesResponse (Maybe [DataSource]) Source #

A list of DataSource that meet the search criteria.

describeDataSourcesResponse_nextToken :: Lens' DescribeDataSourcesResponse (Maybe Text) Source #

An ID of the next page in the paginated results that indicates at least one more page follows.

Types

BatchPrediction

batchPrediction_status :: 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 perform 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.

batchPrediction_lastUpdatedAt :: Lens' BatchPrediction (Maybe UTCTime) Source #

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

batchPrediction_createdAt :: Lens' BatchPrediction (Maybe UTCTime) Source #

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

batchPrediction_inputDataLocationS3 :: Lens' BatchPrediction (Maybe Text) Source #

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

batchPrediction_mLModelId :: Lens' BatchPrediction (Maybe Text) Source #

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

batchPrediction_batchPredictionDataSourceId :: Lens' BatchPrediction (Maybe Text) Source #

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

batchPrediction_batchPredictionId :: 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.

batchPrediction_createdByIamUser :: 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.

batchPrediction_name :: Lens' BatchPrediction (Maybe Text) Source #

A user-supplied name or description of the BatchPrediction.

batchPrediction_message :: Lens' BatchPrediction (Maybe Text) Source #

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

batchPrediction_outputUri :: 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: ':', '//', '/./', '/../'.

DataSource

dataSource_status :: 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.

dataSource_numberOfFiles :: Lens' DataSource (Maybe Integer) Source #

The number of data files referenced by the DataSource.

dataSource_lastUpdatedAt :: Lens' DataSource (Maybe UTCTime) Source #

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

dataSource_createdAt :: Lens' DataSource (Maybe UTCTime) Source #

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

dataSource_dataSourceId :: Lens' DataSource (Maybe Text) Source #

The ID that is assigned to the DataSource during creation.

dataSource_dataSizeInBytes :: Lens' DataSource (Maybe Integer) Source #

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

dataSource_createdByIamUser :: 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.

dataSource_name :: Lens' DataSource (Maybe Text) Source #

A user-supplied name or description of the DataSource.

dataSource_dataLocationS3 :: 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.

dataSource_computeStatistics :: Lens' DataSource (Maybe Bool) Source #

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

dataSource_message :: Lens' DataSource (Maybe Text) Source #

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

dataSource_dataRearrangement :: Lens' DataSource (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

Evaluation

evaluation_status :: 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.

evaluation_performanceMetrics :: 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 Amazon Machine Learning Developer Guide.

evaluation_lastUpdatedAt :: Lens' Evaluation (Maybe UTCTime) Source #

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

evaluation_createdAt :: Lens' Evaluation (Maybe UTCTime) Source #

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

evaluation_inputDataLocationS3 :: 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.

evaluation_mLModelId :: Lens' Evaluation (Maybe Text) Source #

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

evaluation_createdByIamUser :: 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.

evaluation_name :: Lens' Evaluation (Maybe Text) Source #

A user-supplied name or description of the Evaluation.

evaluation_evaluationId :: Lens' Evaluation (Maybe Text) Source #

The ID that is assigned to the Evaluation at creation.

evaluation_message :: Lens' Evaluation (Maybe Text) Source #

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

evaluation_evaluationDataSourceId :: Lens' Evaluation (Maybe Text) Source #

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

MLModel

mLModel_status :: 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 didn't run to completion. The model isn't usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.

mLModel_lastUpdatedAt :: Lens' MLModel (Maybe UTCTime) Source #

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

mLModel_trainingParameters :: Lens' MLModel (Maybe (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.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 the 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.
  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in 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, which 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.

mLModel_scoreThresholdLastUpdatedAt :: Lens' MLModel (Maybe UTCTime) Source #

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

mLModel_createdAt :: Lens' MLModel (Maybe UTCTime) Source #

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

mLModel_inputDataLocationS3 :: Lens' MLModel (Maybe Text) Source #

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

mLModel_mLModelId :: Lens' MLModel (Maybe Text) Source #

The ID assigned to the MLModel at creation.

mLModel_algorithm :: 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.

mLModel_createdByIamUser :: 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.

mLModel_name :: Lens' MLModel (Maybe Text) Source #

A user-supplied name or description of the MLModel.

mLModel_endpointInfo :: Lens' MLModel (Maybe RealtimeEndpointInfo) Source #

The current endpoint of the MLModel.

mLModel_trainingDataSourceId :: Lens' MLModel (Maybe Text) Source #

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

mLModel_message :: Lens' MLModel (Maybe Text) Source #

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

mLModel_mLModelType :: Lens' MLModel (Maybe MLModelType) Source #

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 a child-friendly web site?".
  • MULTICLASS - Produces one of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?".

PerformanceMetrics

Prediction

prediction_predictedValue :: Lens' Prediction (Maybe Double) Source #

The prediction value for REGRESSION MLModel.

prediction_predictedLabel :: Lens' Prediction (Maybe Text) Source #

The prediction label for either a BINARY or MULTICLASS MLModel.

RDSDataSpec

rDSDataSpec_dataSchemaUri :: Lens' RDSDataSpec (Maybe Text) Source #

The Amazon S3 location of the DataSchema.

rDSDataSpec_dataSchema :: Lens' RDSDataSpec (Maybe Text) Source #

A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ "version": "1.0",

"recordAnnotationFieldName": "F1",

"recordWeightFieldName": "F2",

"targetFieldName": "F3",

"dataFormat": "CSV",

"dataFileContainsHeader": true,

"attributes": [

{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

"excludedVariableNames": [ "F6" ] }

rDSDataSpec_dataRearrangement :: Lens' RDSDataSpec (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}

    Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}

rDSDataSpec_databaseInformation :: Lens' RDSDataSpec RDSDatabase Source #

Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.

rDSDataSpec_selectSqlQuery :: Lens' RDSDataSpec Text Source #

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

rDSDataSpec_databaseCredentials :: Lens' RDSDataSpec RDSDatabaseCredentials Source #

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

rDSDataSpec_s3StagingLocation :: 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.

rDSDataSpec_resourceRole :: 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.

rDSDataSpec_serviceRole :: 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.

rDSDataSpec_subnetId :: 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.

rDSDataSpec_securityGroupIds :: 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.

RDSDatabase

RDSDatabaseCredentials

RDSMetadata

rDSMetadata_selectSqlQuery :: Lens' RDSMetadata (Maybe Text) Source #

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

rDSMetadata_dataPipelineId :: 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.

rDSMetadata_database :: Lens' RDSMetadata (Maybe RDSDatabase) Source #

The database details required to connect to an Amazon RDS.

rDSMetadata_resourceRole :: 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.

rDSMetadata_serviceRole :: 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.

RealtimeEndpointInfo

realtimeEndpointInfo_createdAt :: 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.

realtimeEndpointInfo_endpointUrl :: 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.

realtimeEndpointInfo_endpointStatus :: 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.

realtimeEndpointInfo_peakRequestsPerSecond :: Lens' RealtimeEndpointInfo (Maybe Int) Source #

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

RedshiftDataSpec

redshiftDataSpec_dataSchemaUri :: Lens' RedshiftDataSpec (Maybe Text) Source #

Describes the schema location for an Amazon Redshift DataSource.

redshiftDataSpec_dataSchema :: Lens' RedshiftDataSpec (Maybe Text) Source #

A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ "version": "1.0",

"recordAnnotationFieldName": "F1",

"recordWeightFieldName": "F2",

"targetFieldName": "F3",

"dataFormat": "CSV",

"dataFileContainsHeader": true,

"attributes": [

{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

"excludedVariableNames": [ "F6" ] }

redshiftDataSpec_dataRearrangement :: Lens' RedshiftDataSpec (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}

    Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}

redshiftDataSpec_databaseInformation :: Lens' RedshiftDataSpec RedshiftDatabase Source #

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

redshiftDataSpec_selectSqlQuery :: Lens' RedshiftDataSpec Text Source #

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

redshiftDataSpec_databaseCredentials :: Lens' RedshiftDataSpec RedshiftDatabaseCredentials Source #

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

redshiftDataSpec_s3StagingLocation :: Lens' RedshiftDataSpec Text Source #

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

RedshiftDatabase

RedshiftDatabaseCredentials

RedshiftMetadata

redshiftMetadata_selectSqlQuery :: Lens' RedshiftMetadata (Maybe Text) Source #

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

S3DataSpec

s3DataSpec_dataSchema :: Lens' S3DataSpec (Maybe Text) Source #

A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

You must provide either the DataSchema or the DataSchemaLocationS3.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ "version": "1.0",

"recordAnnotationFieldName": "F1",

"recordWeightFieldName": "F2",

"targetFieldName": "F3",

"dataFormat": "CSV",

"dataFileContainsHeader": true,

"attributes": [

{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

"excludedVariableNames": [ "F6" ] }

s3DataSpec_dataSchemaLocationS3 :: Lens' S3DataSpec (Maybe Text) Source #

Describes the schema location in Amazon S3. You must provide either the DataSchema or the DataSchemaLocationS3.

s3DataSpec_dataRearrangement :: Lens' S3DataSpec (Maybe Text) Source #

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}

    Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}

    Datasource for training: {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}

s3DataSpec_dataLocationS3 :: 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.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

tag_key :: Lens' Tag (Maybe Text) Source #

A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.