Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- IngestionMode
- ObjectiveSensitivity
- RecipeProvider
- TrainingMode
- Algorithm
- AlgorithmImage
- AutoMLConfig
- AutoMLResult
- BatchInferenceJob
- BatchInferenceJobConfig
- BatchInferenceJobInput
- BatchInferenceJobOutput
- BatchInferenceJobSummary
- Campaign
- CampaignConfig
- CampaignSummary
- CampaignUpdateSummary
- CategoricalHyperParameterRange
- ContinuousHyperParameterRange
- DataSource
- Dataset
- DatasetExportJob
- DatasetExportJobOutput
- DatasetExportJobSummary
- DatasetGroup
- DatasetGroupSummary
- DatasetImportJob
- DatasetImportJobSummary
- DatasetSchema
- DatasetSchemaSummary
- DatasetSummary
- DefaultCategoricalHyperParameterRange
- DefaultContinuousHyperParameterRange
- DefaultHyperParameterRanges
- DefaultIntegerHyperParameterRange
- EventTracker
- EventTrackerSummary
- FeatureTransformation
- Filter
- FilterSummary
- HPOConfig
- HPOObjective
- HPOResourceConfig
- HyperParameterRanges
- IntegerHyperParameterRange
- OptimizationObjective
- Recipe
- RecipeSummary
- S3DataConfig
- Solution
- SolutionConfig
- SolutionSummary
- SolutionVersion
- SolutionVersionSummary
- TunedHPOParams
Synopsis
- defaultService :: Service
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype IngestionMode where
- IngestionMode' { }
- pattern IngestionMode_ALL :: IngestionMode
- pattern IngestionMode_BULK :: IngestionMode
- pattern IngestionMode_PUT :: IngestionMode
- newtype ObjectiveSensitivity where
- newtype RecipeProvider where
- RecipeProvider' { }
- pattern RecipeProvider_SERVICE :: RecipeProvider
- newtype TrainingMode where
- TrainingMode' { }
- pattern TrainingMode_FULL :: TrainingMode
- pattern TrainingMode_UPDATE :: TrainingMode
- data Algorithm = Algorithm' {
- defaultHyperParameters :: Maybe (HashMap Text Text)
- algorithmArn :: Maybe Text
- trainingInputMode :: Maybe Text
- defaultHyperParameterRanges :: Maybe DefaultHyperParameterRanges
- algorithmImage :: Maybe AlgorithmImage
- lastUpdatedDateTime :: Maybe POSIX
- name :: Maybe Text
- creationDateTime :: Maybe POSIX
- defaultResourceConfig :: Maybe (HashMap Text Text)
- roleArn :: Maybe Text
- newAlgorithm :: Algorithm
- algorithm_defaultHyperParameters :: Lens' Algorithm (Maybe (HashMap Text Text))
- algorithm_algorithmArn :: Lens' Algorithm (Maybe Text)
- algorithm_trainingInputMode :: Lens' Algorithm (Maybe Text)
- algorithm_defaultHyperParameterRanges :: Lens' Algorithm (Maybe DefaultHyperParameterRanges)
- algorithm_algorithmImage :: Lens' Algorithm (Maybe AlgorithmImage)
- algorithm_lastUpdatedDateTime :: Lens' Algorithm (Maybe UTCTime)
- algorithm_name :: Lens' Algorithm (Maybe Text)
- algorithm_creationDateTime :: Lens' Algorithm (Maybe UTCTime)
- algorithm_defaultResourceConfig :: Lens' Algorithm (Maybe (HashMap Text Text))
- algorithm_roleArn :: Lens' Algorithm (Maybe Text)
- data AlgorithmImage = AlgorithmImage' {}
- newAlgorithmImage :: Text -> AlgorithmImage
- algorithmImage_name :: Lens' AlgorithmImage (Maybe Text)
- algorithmImage_dockerURI :: Lens' AlgorithmImage Text
- data AutoMLConfig = AutoMLConfig' {
- recipeList :: Maybe [Text]
- metricName :: Maybe Text
- newAutoMLConfig :: AutoMLConfig
- autoMLConfig_recipeList :: Lens' AutoMLConfig (Maybe [Text])
- autoMLConfig_metricName :: Lens' AutoMLConfig (Maybe Text)
- data AutoMLResult = AutoMLResult' {}
- newAutoMLResult :: AutoMLResult
- autoMLResult_bestRecipeArn :: Lens' AutoMLResult (Maybe Text)
- data BatchInferenceJob = BatchInferenceJob' {
- failureReason :: Maybe Text
- status :: Maybe Text
- jobOutput :: Maybe BatchInferenceJobOutput
- jobName :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- numResults :: Maybe Int
- batchInferenceJobConfig :: Maybe BatchInferenceJobConfig
- batchInferenceJobArn :: Maybe Text
- filterArn :: Maybe Text
- creationDateTime :: Maybe POSIX
- solutionVersionArn :: Maybe Text
- roleArn :: Maybe Text
- jobInput :: Maybe BatchInferenceJobInput
- newBatchInferenceJob :: BatchInferenceJob
- batchInferenceJob_failureReason :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_status :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_jobOutput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobOutput)
- batchInferenceJob_jobName :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_lastUpdatedDateTime :: Lens' BatchInferenceJob (Maybe UTCTime)
- batchInferenceJob_numResults :: Lens' BatchInferenceJob (Maybe Int)
- batchInferenceJob_batchInferenceJobConfig :: Lens' BatchInferenceJob (Maybe BatchInferenceJobConfig)
- batchInferenceJob_batchInferenceJobArn :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_filterArn :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_creationDateTime :: Lens' BatchInferenceJob (Maybe UTCTime)
- batchInferenceJob_solutionVersionArn :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_roleArn :: Lens' BatchInferenceJob (Maybe Text)
- batchInferenceJob_jobInput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobInput)
- data BatchInferenceJobConfig = BatchInferenceJobConfig' {}
- newBatchInferenceJobConfig :: BatchInferenceJobConfig
- batchInferenceJobConfig_itemExplorationConfig :: Lens' BatchInferenceJobConfig (Maybe (HashMap Text Text))
- data BatchInferenceJobInput = BatchInferenceJobInput' {}
- newBatchInferenceJobInput :: S3DataConfig -> BatchInferenceJobInput
- batchInferenceJobInput_s3DataSource :: Lens' BatchInferenceJobInput S3DataConfig
- data BatchInferenceJobOutput = BatchInferenceJobOutput' {}
- newBatchInferenceJobOutput :: S3DataConfig -> BatchInferenceJobOutput
- batchInferenceJobOutput_s3DataDestination :: Lens' BatchInferenceJobOutput S3DataConfig
- data BatchInferenceJobSummary = BatchInferenceJobSummary' {}
- newBatchInferenceJobSummary :: BatchInferenceJobSummary
- batchInferenceJobSummary_failureReason :: Lens' BatchInferenceJobSummary (Maybe Text)
- batchInferenceJobSummary_status :: Lens' BatchInferenceJobSummary (Maybe Text)
- batchInferenceJobSummary_jobName :: Lens' BatchInferenceJobSummary (Maybe Text)
- batchInferenceJobSummary_lastUpdatedDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime)
- batchInferenceJobSummary_batchInferenceJobArn :: Lens' BatchInferenceJobSummary (Maybe Text)
- batchInferenceJobSummary_creationDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime)
- batchInferenceJobSummary_solutionVersionArn :: Lens' BatchInferenceJobSummary (Maybe Text)
- data Campaign = Campaign' {
- failureReason :: Maybe Text
- status :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- campaignConfig :: Maybe CampaignConfig
- latestCampaignUpdate :: Maybe CampaignUpdateSummary
- name :: Maybe Text
- minProvisionedTPS :: Maybe Natural
- creationDateTime :: Maybe POSIX
- campaignArn :: Maybe Text
- solutionVersionArn :: Maybe Text
- newCampaign :: Campaign
- campaign_failureReason :: Lens' Campaign (Maybe Text)
- campaign_status :: Lens' Campaign (Maybe Text)
- campaign_lastUpdatedDateTime :: Lens' Campaign (Maybe UTCTime)
- campaign_campaignConfig :: Lens' Campaign (Maybe CampaignConfig)
- campaign_latestCampaignUpdate :: Lens' Campaign (Maybe CampaignUpdateSummary)
- campaign_name :: Lens' Campaign (Maybe Text)
- campaign_minProvisionedTPS :: Lens' Campaign (Maybe Natural)
- campaign_creationDateTime :: Lens' Campaign (Maybe UTCTime)
- campaign_campaignArn :: Lens' Campaign (Maybe Text)
- campaign_solutionVersionArn :: Lens' Campaign (Maybe Text)
- data CampaignConfig = CampaignConfig' {}
- newCampaignConfig :: CampaignConfig
- campaignConfig_itemExplorationConfig :: Lens' CampaignConfig (Maybe (HashMap Text Text))
- data CampaignSummary = CampaignSummary' {}
- newCampaignSummary :: CampaignSummary
- campaignSummary_failureReason :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_status :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_lastUpdatedDateTime :: Lens' CampaignSummary (Maybe UTCTime)
- campaignSummary_name :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_creationDateTime :: Lens' CampaignSummary (Maybe UTCTime)
- campaignSummary_campaignArn :: Lens' CampaignSummary (Maybe Text)
- data CampaignUpdateSummary = CampaignUpdateSummary' {}
- newCampaignUpdateSummary :: CampaignUpdateSummary
- campaignUpdateSummary_failureReason :: Lens' CampaignUpdateSummary (Maybe Text)
- campaignUpdateSummary_status :: Lens' CampaignUpdateSummary (Maybe Text)
- campaignUpdateSummary_lastUpdatedDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime)
- campaignUpdateSummary_campaignConfig :: Lens' CampaignUpdateSummary (Maybe CampaignConfig)
- campaignUpdateSummary_minProvisionedTPS :: Lens' CampaignUpdateSummary (Maybe Natural)
- campaignUpdateSummary_creationDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime)
- campaignUpdateSummary_solutionVersionArn :: Lens' CampaignUpdateSummary (Maybe Text)
- data CategoricalHyperParameterRange = CategoricalHyperParameterRange' {}
- newCategoricalHyperParameterRange :: CategoricalHyperParameterRange
- categoricalHyperParameterRange_values :: Lens' CategoricalHyperParameterRange (Maybe [Text])
- categoricalHyperParameterRange_name :: Lens' CategoricalHyperParameterRange (Maybe Text)
- data ContinuousHyperParameterRange = ContinuousHyperParameterRange' {}
- newContinuousHyperParameterRange :: ContinuousHyperParameterRange
- continuousHyperParameterRange_maxValue :: Lens' ContinuousHyperParameterRange (Maybe Double)
- continuousHyperParameterRange_name :: Lens' ContinuousHyperParameterRange (Maybe Text)
- continuousHyperParameterRange_minValue :: Lens' ContinuousHyperParameterRange (Maybe Double)
- data DataSource = DataSource' {}
- newDataSource :: DataSource
- dataSource_dataLocation :: Lens' DataSource (Maybe Text)
- data Dataset = Dataset' {}
- newDataset :: Dataset
- dataset_status :: Lens' Dataset (Maybe Text)
- dataset_datasetArn :: Lens' Dataset (Maybe Text)
- dataset_lastUpdatedDateTime :: Lens' Dataset (Maybe UTCTime)
- dataset_schemaArn :: Lens' Dataset (Maybe Text)
- dataset_name :: Lens' Dataset (Maybe Text)
- dataset_datasetType :: Lens' Dataset (Maybe Text)
- dataset_creationDateTime :: Lens' Dataset (Maybe UTCTime)
- dataset_datasetGroupArn :: Lens' Dataset (Maybe Text)
- data DatasetExportJob = DatasetExportJob' {}
- newDatasetExportJob :: DatasetExportJob
- datasetExportJob_failureReason :: Lens' DatasetExportJob (Maybe Text)
- datasetExportJob_status :: Lens' DatasetExportJob (Maybe Text)
- datasetExportJob_datasetExportJobArn :: Lens' DatasetExportJob (Maybe Text)
- datasetExportJob_datasetArn :: Lens' DatasetExportJob (Maybe Text)
- datasetExportJob_jobOutput :: Lens' DatasetExportJob (Maybe DatasetExportJobOutput)
- datasetExportJob_jobName :: Lens' DatasetExportJob (Maybe Text)
- datasetExportJob_lastUpdatedDateTime :: Lens' DatasetExportJob (Maybe UTCTime)
- datasetExportJob_ingestionMode :: Lens' DatasetExportJob (Maybe IngestionMode)
- datasetExportJob_creationDateTime :: Lens' DatasetExportJob (Maybe UTCTime)
- datasetExportJob_roleArn :: Lens' DatasetExportJob (Maybe Text)
- data DatasetExportJobOutput = DatasetExportJobOutput' {}
- newDatasetExportJobOutput :: S3DataConfig -> DatasetExportJobOutput
- datasetExportJobOutput_s3DataDestination :: Lens' DatasetExportJobOutput S3DataConfig
- data DatasetExportJobSummary = DatasetExportJobSummary' {}
- newDatasetExportJobSummary :: DatasetExportJobSummary
- datasetExportJobSummary_failureReason :: Lens' DatasetExportJobSummary (Maybe Text)
- datasetExportJobSummary_status :: Lens' DatasetExportJobSummary (Maybe Text)
- datasetExportJobSummary_datasetExportJobArn :: Lens' DatasetExportJobSummary (Maybe Text)
- datasetExportJobSummary_jobName :: Lens' DatasetExportJobSummary (Maybe Text)
- datasetExportJobSummary_lastUpdatedDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime)
- datasetExportJobSummary_creationDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime)
- data DatasetGroup = DatasetGroup' {}
- newDatasetGroup :: DatasetGroup
- datasetGroup_failureReason :: Lens' DatasetGroup (Maybe Text)
- datasetGroup_status :: Lens' DatasetGroup (Maybe Text)
- datasetGroup_kmsKeyArn :: Lens' DatasetGroup (Maybe Text)
- datasetGroup_lastUpdatedDateTime :: Lens' DatasetGroup (Maybe UTCTime)
- datasetGroup_name :: Lens' DatasetGroup (Maybe Text)
- datasetGroup_creationDateTime :: Lens' DatasetGroup (Maybe UTCTime)
- datasetGroup_datasetGroupArn :: Lens' DatasetGroup (Maybe Text)
- datasetGroup_roleArn :: Lens' DatasetGroup (Maybe Text)
- data DatasetGroupSummary = DatasetGroupSummary' {}
- newDatasetGroupSummary :: DatasetGroupSummary
- datasetGroupSummary_failureReason :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_status :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_lastUpdatedDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetGroupSummary_name :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_creationDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text)
- data DatasetImportJob = DatasetImportJob' {}
- newDatasetImportJob :: DatasetImportJob
- datasetImportJob_failureReason :: Lens' DatasetImportJob (Maybe Text)
- datasetImportJob_status :: Lens' DatasetImportJob (Maybe Text)
- datasetImportJob_datasetArn :: Lens' DatasetImportJob (Maybe Text)
- datasetImportJob_jobName :: Lens' DatasetImportJob (Maybe Text)
- datasetImportJob_lastUpdatedDateTime :: Lens' DatasetImportJob (Maybe UTCTime)
- datasetImportJob_datasetImportJobArn :: Lens' DatasetImportJob (Maybe Text)
- datasetImportJob_dataSource :: Lens' DatasetImportJob (Maybe DataSource)
- datasetImportJob_creationDateTime :: Lens' DatasetImportJob (Maybe UTCTime)
- datasetImportJob_roleArn :: Lens' DatasetImportJob (Maybe Text)
- data DatasetImportJobSummary = DatasetImportJobSummary' {}
- newDatasetImportJobSummary :: DatasetImportJobSummary
- datasetImportJobSummary_failureReason :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_jobName :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_lastUpdatedDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_creationDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- data DatasetSchema = DatasetSchema' {}
- newDatasetSchema :: DatasetSchema
- datasetSchema_lastUpdatedDateTime :: Lens' DatasetSchema (Maybe UTCTime)
- datasetSchema_schema :: Lens' DatasetSchema (Maybe Text)
- datasetSchema_schemaArn :: Lens' DatasetSchema (Maybe Text)
- datasetSchema_name :: Lens' DatasetSchema (Maybe Text)
- datasetSchema_creationDateTime :: Lens' DatasetSchema (Maybe UTCTime)
- data DatasetSchemaSummary = DatasetSchemaSummary' {}
- newDatasetSchemaSummary :: DatasetSchemaSummary
- datasetSchemaSummary_lastUpdatedDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime)
- datasetSchemaSummary_schemaArn :: Lens' DatasetSchemaSummary (Maybe Text)
- datasetSchemaSummary_name :: Lens' DatasetSchemaSummary (Maybe Text)
- datasetSchemaSummary_creationDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime)
- data DatasetSummary = DatasetSummary' {}
- newDatasetSummary :: DatasetSummary
- datasetSummary_status :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_lastUpdatedDateTime :: Lens' DatasetSummary (Maybe UTCTime)
- datasetSummary_name :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_datasetType :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_creationDateTime :: Lens' DatasetSummary (Maybe UTCTime)
- data DefaultCategoricalHyperParameterRange = DefaultCategoricalHyperParameterRange' {}
- newDefaultCategoricalHyperParameterRange :: DefaultCategoricalHyperParameterRange
- defaultCategoricalHyperParameterRange_isTunable :: Lens' DefaultCategoricalHyperParameterRange (Maybe Bool)
- defaultCategoricalHyperParameterRange_values :: Lens' DefaultCategoricalHyperParameterRange (Maybe [Text])
- defaultCategoricalHyperParameterRange_name :: Lens' DefaultCategoricalHyperParameterRange (Maybe Text)
- data DefaultContinuousHyperParameterRange = DefaultContinuousHyperParameterRange' {}
- newDefaultContinuousHyperParameterRange :: DefaultContinuousHyperParameterRange
- defaultContinuousHyperParameterRange_maxValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double)
- defaultContinuousHyperParameterRange_isTunable :: Lens' DefaultContinuousHyperParameterRange (Maybe Bool)
- defaultContinuousHyperParameterRange_name :: Lens' DefaultContinuousHyperParameterRange (Maybe Text)
- defaultContinuousHyperParameterRange_minValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double)
- data DefaultHyperParameterRanges = DefaultHyperParameterRanges' {}
- newDefaultHyperParameterRanges :: DefaultHyperParameterRanges
- defaultHyperParameterRanges_integerHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultIntegerHyperParameterRange])
- defaultHyperParameterRanges_categoricalHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultCategoricalHyperParameterRange])
- defaultHyperParameterRanges_continuousHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultContinuousHyperParameterRange])
- data DefaultIntegerHyperParameterRange = DefaultIntegerHyperParameterRange' {}
- newDefaultIntegerHyperParameterRange :: DefaultIntegerHyperParameterRange
- defaultIntegerHyperParameterRange_maxValue :: Lens' DefaultIntegerHyperParameterRange (Maybe Int)
- defaultIntegerHyperParameterRange_isTunable :: Lens' DefaultIntegerHyperParameterRange (Maybe Bool)
- defaultIntegerHyperParameterRange_name :: Lens' DefaultIntegerHyperParameterRange (Maybe Text)
- defaultIntegerHyperParameterRange_minValue :: Lens' DefaultIntegerHyperParameterRange (Maybe Int)
- data EventTracker = EventTracker' {}
- newEventTracker :: EventTracker
- eventTracker_status :: Lens' EventTracker (Maybe Text)
- eventTracker_trackingId :: Lens' EventTracker (Maybe Text)
- eventTracker_lastUpdatedDateTime :: Lens' EventTracker (Maybe UTCTime)
- eventTracker_accountId :: Lens' EventTracker (Maybe Text)
- eventTracker_name :: Lens' EventTracker (Maybe Text)
- eventTracker_creationDateTime :: Lens' EventTracker (Maybe UTCTime)
- eventTracker_datasetGroupArn :: Lens' EventTracker (Maybe Text)
- eventTracker_eventTrackerArn :: Lens' EventTracker (Maybe Text)
- data EventTrackerSummary = EventTrackerSummary' {}
- newEventTrackerSummary :: EventTrackerSummary
- eventTrackerSummary_status :: Lens' EventTrackerSummary (Maybe Text)
- eventTrackerSummary_lastUpdatedDateTime :: Lens' EventTrackerSummary (Maybe UTCTime)
- eventTrackerSummary_name :: Lens' EventTrackerSummary (Maybe Text)
- eventTrackerSummary_creationDateTime :: Lens' EventTrackerSummary (Maybe UTCTime)
- eventTrackerSummary_eventTrackerArn :: Lens' EventTrackerSummary (Maybe Text)
- data FeatureTransformation = FeatureTransformation' {}
- newFeatureTransformation :: FeatureTransformation
- featureTransformation_status :: Lens' FeatureTransformation (Maybe Text)
- featureTransformation_featureTransformationArn :: Lens' FeatureTransformation (Maybe Text)
- featureTransformation_lastUpdatedDateTime :: Lens' FeatureTransformation (Maybe UTCTime)
- featureTransformation_name :: Lens' FeatureTransformation (Maybe Text)
- featureTransformation_creationDateTime :: Lens' FeatureTransformation (Maybe UTCTime)
- featureTransformation_defaultParameters :: Lens' FeatureTransformation (Maybe (HashMap Text Text))
- data Filter = Filter' {}
- newFilter :: Filter
- filter_failureReason :: Lens' Filter (Maybe Text)
- filter_status :: Lens' Filter (Maybe Text)
- filter_filterExpression :: Lens' Filter (Maybe Text)
- filter_lastUpdatedDateTime :: Lens' Filter (Maybe UTCTime)
- filter_name :: Lens' Filter (Maybe Text)
- filter_filterArn :: Lens' Filter (Maybe Text)
- filter_creationDateTime :: Lens' Filter (Maybe UTCTime)
- filter_datasetGroupArn :: Lens' Filter (Maybe Text)
- data FilterSummary = FilterSummary' {}
- newFilterSummary :: FilterSummary
- filterSummary_failureReason :: Lens' FilterSummary (Maybe Text)
- filterSummary_status :: Lens' FilterSummary (Maybe Text)
- filterSummary_lastUpdatedDateTime :: Lens' FilterSummary (Maybe UTCTime)
- filterSummary_name :: Lens' FilterSummary (Maybe Text)
- filterSummary_filterArn :: Lens' FilterSummary (Maybe Text)
- filterSummary_creationDateTime :: Lens' FilterSummary (Maybe UTCTime)
- filterSummary_datasetGroupArn :: Lens' FilterSummary (Maybe Text)
- data HPOConfig = HPOConfig' {}
- newHPOConfig :: HPOConfig
- hPOConfig_algorithmHyperParameterRanges :: Lens' HPOConfig (Maybe HyperParameterRanges)
- hPOConfig_hpoResourceConfig :: Lens' HPOConfig (Maybe HPOResourceConfig)
- hPOConfig_hpoObjective :: Lens' HPOConfig (Maybe HPOObjective)
- data HPOObjective = HPOObjective' {
- metricName :: Maybe Text
- type' :: Maybe Text
- metricRegex :: Maybe Text
- newHPOObjective :: HPOObjective
- hPOObjective_metricName :: Lens' HPOObjective (Maybe Text)
- hPOObjective_type :: Lens' HPOObjective (Maybe Text)
- hPOObjective_metricRegex :: Lens' HPOObjective (Maybe Text)
- data HPOResourceConfig = HPOResourceConfig' {}
- newHPOResourceConfig :: HPOResourceConfig
- hPOResourceConfig_maxNumberOfTrainingJobs :: Lens' HPOResourceConfig (Maybe Text)
- hPOResourceConfig_maxParallelTrainingJobs :: Lens' HPOResourceConfig (Maybe Text)
- data HyperParameterRanges = HyperParameterRanges' {}
- newHyperParameterRanges :: HyperParameterRanges
- hyperParameterRanges_integerHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [IntegerHyperParameterRange])
- hyperParameterRanges_categoricalHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [CategoricalHyperParameterRange])
- hyperParameterRanges_continuousHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [ContinuousHyperParameterRange])
- data IntegerHyperParameterRange = IntegerHyperParameterRange' {}
- newIntegerHyperParameterRange :: IntegerHyperParameterRange
- integerHyperParameterRange_maxValue :: Lens' IntegerHyperParameterRange (Maybe Int)
- integerHyperParameterRange_name :: Lens' IntegerHyperParameterRange (Maybe Text)
- integerHyperParameterRange_minValue :: Lens' IntegerHyperParameterRange (Maybe Int)
- data OptimizationObjective = OptimizationObjective' {}
- newOptimizationObjective :: OptimizationObjective
- optimizationObjective_itemAttribute :: Lens' OptimizationObjective (Maybe Text)
- optimizationObjective_objectiveSensitivity :: Lens' OptimizationObjective (Maybe ObjectiveSensitivity)
- data Recipe = Recipe' {}
- newRecipe :: Recipe
- recipe_status :: Lens' Recipe (Maybe Text)
- recipe_algorithmArn :: Lens' Recipe (Maybe Text)
- recipe_recipeArn :: Lens' Recipe (Maybe Text)
- recipe_featureTransformationArn :: Lens' Recipe (Maybe Text)
- recipe_lastUpdatedDateTime :: Lens' Recipe (Maybe UTCTime)
- recipe_name :: Lens' Recipe (Maybe Text)
- recipe_creationDateTime :: Lens' Recipe (Maybe UTCTime)
- recipe_recipeType :: Lens' Recipe (Maybe Text)
- recipe_description :: Lens' Recipe (Maybe Text)
- data RecipeSummary = RecipeSummary' {}
- newRecipeSummary :: RecipeSummary
- recipeSummary_status :: Lens' RecipeSummary (Maybe Text)
- recipeSummary_recipeArn :: Lens' RecipeSummary (Maybe Text)
- recipeSummary_lastUpdatedDateTime :: Lens' RecipeSummary (Maybe UTCTime)
- recipeSummary_name :: Lens' RecipeSummary (Maybe Text)
- recipeSummary_creationDateTime :: Lens' RecipeSummary (Maybe UTCTime)
- data S3DataConfig = S3DataConfig' {}
- newS3DataConfig :: Text -> S3DataConfig
- s3DataConfig_kmsKeyArn :: Lens' S3DataConfig (Maybe Text)
- s3DataConfig_path :: Lens' S3DataConfig Text
- data Solution = Solution' {
- solutionArn :: Maybe Text
- status :: Maybe Text
- performAutoML :: Maybe Bool
- recipeArn :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- eventType :: Maybe Text
- name :: Maybe Text
- autoMLResult :: Maybe AutoMLResult
- creationDateTime :: Maybe POSIX
- datasetGroupArn :: Maybe Text
- latestSolutionVersion :: Maybe SolutionVersionSummary
- solutionConfig :: Maybe SolutionConfig
- performHPO :: Maybe Bool
- newSolution :: Solution
- solution_solutionArn :: Lens' Solution (Maybe Text)
- solution_status :: Lens' Solution (Maybe Text)
- solution_performAutoML :: Lens' Solution (Maybe Bool)
- solution_recipeArn :: Lens' Solution (Maybe Text)
- solution_lastUpdatedDateTime :: Lens' Solution (Maybe UTCTime)
- solution_eventType :: Lens' Solution (Maybe Text)
- solution_name :: Lens' Solution (Maybe Text)
- solution_autoMLResult :: Lens' Solution (Maybe AutoMLResult)
- solution_creationDateTime :: Lens' Solution (Maybe UTCTime)
- solution_datasetGroupArn :: Lens' Solution (Maybe Text)
- solution_latestSolutionVersion :: Lens' Solution (Maybe SolutionVersionSummary)
- solution_solutionConfig :: Lens' Solution (Maybe SolutionConfig)
- solution_performHPO :: Lens' Solution (Maybe Bool)
- data SolutionConfig = SolutionConfig' {}
- newSolutionConfig :: SolutionConfig
- solutionConfig_featureTransformationParameters :: Lens' SolutionConfig (Maybe (HashMap Text Text))
- solutionConfig_hpoConfig :: Lens' SolutionConfig (Maybe HPOConfig)
- solutionConfig_eventValueThreshold :: Lens' SolutionConfig (Maybe Text)
- solutionConfig_autoMLConfig :: Lens' SolutionConfig (Maybe AutoMLConfig)
- solutionConfig_algorithmHyperParameters :: Lens' SolutionConfig (Maybe (HashMap Text Text))
- solutionConfig_optimizationObjective :: Lens' SolutionConfig (Maybe OptimizationObjective)
- data SolutionSummary = SolutionSummary' {}
- newSolutionSummary :: SolutionSummary
- solutionSummary_solutionArn :: Lens' SolutionSummary (Maybe Text)
- solutionSummary_status :: Lens' SolutionSummary (Maybe Text)
- solutionSummary_lastUpdatedDateTime :: Lens' SolutionSummary (Maybe UTCTime)
- solutionSummary_name :: Lens' SolutionSummary (Maybe Text)
- solutionSummary_creationDateTime :: Lens' SolutionSummary (Maybe UTCTime)
- data SolutionVersion = SolutionVersion' {
- failureReason :: Maybe Text
- solutionArn :: Maybe Text
- status :: Maybe Text
- performAutoML :: Maybe Bool
- tunedHPOParams :: Maybe TunedHPOParams
- recipeArn :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- eventType :: Maybe Text
- creationDateTime :: Maybe POSIX
- datasetGroupArn :: Maybe Text
- trainingMode :: Maybe TrainingMode
- trainingHours :: Maybe Double
- solutionConfig :: Maybe SolutionConfig
- performHPO :: Maybe Bool
- solutionVersionArn :: Maybe Text
- newSolutionVersion :: SolutionVersion
- solutionVersion_failureReason :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_solutionArn :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_status :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_performAutoML :: Lens' SolutionVersion (Maybe Bool)
- solutionVersion_tunedHPOParams :: Lens' SolutionVersion (Maybe TunedHPOParams)
- solutionVersion_recipeArn :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_lastUpdatedDateTime :: Lens' SolutionVersion (Maybe UTCTime)
- solutionVersion_eventType :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_creationDateTime :: Lens' SolutionVersion (Maybe UTCTime)
- solutionVersion_datasetGroupArn :: Lens' SolutionVersion (Maybe Text)
- solutionVersion_trainingMode :: Lens' SolutionVersion (Maybe TrainingMode)
- solutionVersion_trainingHours :: Lens' SolutionVersion (Maybe Double)
- solutionVersion_solutionConfig :: Lens' SolutionVersion (Maybe SolutionConfig)
- solutionVersion_performHPO :: Lens' SolutionVersion (Maybe Bool)
- solutionVersion_solutionVersionArn :: Lens' SolutionVersion (Maybe Text)
- data SolutionVersionSummary = SolutionVersionSummary' {}
- newSolutionVersionSummary :: SolutionVersionSummary
- solutionVersionSummary_failureReason :: Lens' SolutionVersionSummary (Maybe Text)
- solutionVersionSummary_status :: Lens' SolutionVersionSummary (Maybe Text)
- solutionVersionSummary_lastUpdatedDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime)
- solutionVersionSummary_creationDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime)
- solutionVersionSummary_solutionVersionArn :: Lens' SolutionVersionSummary (Maybe Text)
- data TunedHPOParams = TunedHPOParams' {}
- newTunedHPOParams :: TunedHPOParams
- tunedHPOParams_algorithmHyperParameters :: Lens' TunedHPOParams (Maybe (HashMap Text Text))
Service Configuration
defaultService :: Service Source #
API version 2018-05-22
of the Amazon Personalize SDK configuration.
Errors
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The token is not valid.
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Provide a valid value for the field or parameter.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Could not find the specified resource.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit on the number of requests per second has been exceeded.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is in use.
IngestionMode
newtype IngestionMode Source #
pattern IngestionMode_ALL :: IngestionMode | |
pattern IngestionMode_BULK :: IngestionMode | |
pattern IngestionMode_PUT :: IngestionMode |
Instances
ObjectiveSensitivity
newtype ObjectiveSensitivity Source #
pattern ObjectiveSensitivity_HIGH :: ObjectiveSensitivity | |
pattern ObjectiveSensitivity_LOW :: ObjectiveSensitivity | |
pattern ObjectiveSensitivity_MEDIUM :: ObjectiveSensitivity | |
pattern ObjectiveSensitivity_OFF :: ObjectiveSensitivity |
Instances
RecipeProvider
newtype RecipeProvider Source #
pattern RecipeProvider_SERVICE :: RecipeProvider |
Instances
TrainingMode
newtype TrainingMode Source #
pattern TrainingMode_FULL :: TrainingMode | |
pattern TrainingMode_UPDATE :: TrainingMode |
Instances
Algorithm
Describes a custom algorithm.
See: newAlgorithm
smart constructor.
Algorithm' | |
|
Instances
newAlgorithm :: Algorithm Source #
Create a value of Algorithm
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultHyperParameters:Algorithm'
, algorithm_defaultHyperParameters
- Specifies the default hyperparameters.
$sel:algorithmArn:Algorithm'
, algorithm_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm.
$sel:trainingInputMode:Algorithm'
, algorithm_trainingInputMode
- The training input mode.
$sel:defaultHyperParameterRanges:Algorithm'
, algorithm_defaultHyperParameterRanges
- Specifies the default hyperparameters, their ranges, and whether they
are tunable. A tunable hyperparameter can have its value determined
during hyperparameter optimization (HPO).
$sel:algorithmImage:Algorithm'
, algorithm_algorithmImage
- The URI of the Docker container for the algorithm image.
$sel:lastUpdatedDateTime:Algorithm'
, algorithm_lastUpdatedDateTime
- The date and time (in Unix time) that the algorithm was last updated.
$sel:name:Algorithm'
, algorithm_name
- The name of the algorithm.
$sel:creationDateTime:Algorithm'
, algorithm_creationDateTime
- The date and time (in Unix time) that the algorithm was created.
$sel:defaultResourceConfig:Algorithm'
, algorithm_defaultResourceConfig
- Specifies the default maximum number of training jobs and parallel
training jobs.
$sel:roleArn:Algorithm'
, algorithm_roleArn
- The Amazon Resource Name (ARN) of the role.
algorithm_defaultHyperParameters :: Lens' Algorithm (Maybe (HashMap Text Text)) Source #
Specifies the default hyperparameters.
algorithm_algorithmArn :: Lens' Algorithm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm.
algorithm_defaultHyperParameterRanges :: Lens' Algorithm (Maybe DefaultHyperParameterRanges) Source #
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
algorithm_algorithmImage :: Lens' Algorithm (Maybe AlgorithmImage) Source #
The URI of the Docker container for the algorithm image.
algorithm_lastUpdatedDateTime :: Lens' Algorithm (Maybe UTCTime) Source #
The date and time (in Unix time) that the algorithm was last updated.
algorithm_creationDateTime :: Lens' Algorithm (Maybe UTCTime) Source #
The date and time (in Unix time) that the algorithm was created.
algorithm_defaultResourceConfig :: Lens' Algorithm (Maybe (HashMap Text Text)) Source #
Specifies the default maximum number of training jobs and parallel training jobs.
algorithm_roleArn :: Lens' Algorithm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the role.
AlgorithmImage
data AlgorithmImage Source #
Describes an algorithm image.
See: newAlgorithmImage
smart constructor.
Instances
Create a value of AlgorithmImage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AlgorithmImage'
, algorithmImage_name
- The name of the algorithm image.
$sel:dockerURI:AlgorithmImage'
, algorithmImage_dockerURI
- The URI of the Docker container for the algorithm image.
algorithmImage_name :: Lens' AlgorithmImage (Maybe Text) Source #
The name of the algorithm image.
algorithmImage_dockerURI :: Lens' AlgorithmImage Text Source #
The URI of the Docker container for the algorithm image.
AutoMLConfig
data AutoMLConfig Source #
When the solution performs AutoML (performAutoML
is true in
CreateSolution), Amazon Personalize determines which recipe, from the
specified list, optimizes the given metric. Amazon Personalize then uses
that recipe for the solution.
See: newAutoMLConfig
smart constructor.
AutoMLConfig' | |
|
Instances
newAutoMLConfig :: AutoMLConfig Source #
Create a value of AutoMLConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recipeList:AutoMLConfig'
, autoMLConfig_recipeList
- The list of candidate recipes.
$sel:metricName:AutoMLConfig'
, autoMLConfig_metricName
- The metric to optimize.
autoMLConfig_recipeList :: Lens' AutoMLConfig (Maybe [Text]) Source #
The list of candidate recipes.
autoMLConfig_metricName :: Lens' AutoMLConfig (Maybe Text) Source #
The metric to optimize.
AutoMLResult
data AutoMLResult Source #
When the solution performs AutoML (performAutoML
is true in
CreateSolution), specifies the recipe that best optimized the specified
metric.
See: newAutoMLResult
smart constructor.
AutoMLResult' | |
|
Instances
newAutoMLResult :: AutoMLResult Source #
Create a value of AutoMLResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bestRecipeArn:AutoMLResult'
, autoMLResult_bestRecipeArn
- The Amazon Resource Name (ARN) of the best recipe.
autoMLResult_bestRecipeArn :: Lens' AutoMLResult (Maybe Text) Source #
The Amazon Resource Name (ARN) of the best recipe.
BatchInferenceJob
data BatchInferenceJob Source #
Contains information on a batch inference job.
See: newBatchInferenceJob
smart constructor.
BatchInferenceJob' | |
|
Instances
newBatchInferenceJob :: BatchInferenceJob Source #
Create a value of BatchInferenceJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:BatchInferenceJob'
, batchInferenceJob_failureReason
- If the batch inference job failed, the reason for the failure.
$sel:status:BatchInferenceJob'
, batchInferenceJob_status
- The status of the batch inference job. The status is one of the
following values:
- PENDING
- IN PROGRESS
- ACTIVE
- CREATE FAILED
$sel:jobOutput:BatchInferenceJob'
, batchInferenceJob_jobOutput
- The Amazon S3 bucket that contains the output data generated by the
batch inference job.
$sel:jobName:BatchInferenceJob'
, batchInferenceJob_jobName
- The name of the batch inference job.
$sel:lastUpdatedDateTime:BatchInferenceJob'
, batchInferenceJob_lastUpdatedDateTime
- The time at which the batch inference job was last updated.
$sel:numResults:BatchInferenceJob'
, batchInferenceJob_numResults
- The number of recommendations generated by the batch inference job. This
number includes the error messages generated for failed input records.
$sel:batchInferenceJobConfig:BatchInferenceJob'
, batchInferenceJob_batchInferenceJobConfig
- A string to string map of the configuration details of a batch inference
job.
$sel:batchInferenceJobArn:BatchInferenceJob'
, batchInferenceJob_batchInferenceJobArn
- The Amazon Resource Name (ARN) of the batch inference job.
$sel:filterArn:BatchInferenceJob'
, batchInferenceJob_filterArn
- The ARN of the filter used on the batch inference job.
$sel:creationDateTime:BatchInferenceJob'
, batchInferenceJob_creationDateTime
- The time at which the batch inference job was created.
$sel:solutionVersionArn:BatchInferenceJob'
, batchInferenceJob_solutionVersionArn
- The Amazon Resource Name (ARN) of the solution version from which the
batch inference job was created.
$sel:roleArn:BatchInferenceJob'
, batchInferenceJob_roleArn
- The ARN of the Amazon Identity and Access Management (IAM) role that
requested the batch inference job.
$sel:jobInput:BatchInferenceJob'
, batchInferenceJob_jobInput
- The Amazon S3 path that leads to the input data used to generate the
batch inference job.
batchInferenceJob_failureReason :: Lens' BatchInferenceJob (Maybe Text) Source #
If the batch inference job failed, the reason for the failure.
batchInferenceJob_status :: Lens' BatchInferenceJob (Maybe Text) Source #
The status of the batch inference job. The status is one of the following values:
- PENDING
- IN PROGRESS
- ACTIVE
- CREATE FAILED
batchInferenceJob_jobOutput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobOutput) Source #
The Amazon S3 bucket that contains the output data generated by the batch inference job.
batchInferenceJob_jobName :: Lens' BatchInferenceJob (Maybe Text) Source #
The name of the batch inference job.
batchInferenceJob_lastUpdatedDateTime :: Lens' BatchInferenceJob (Maybe UTCTime) Source #
The time at which the batch inference job was last updated.
batchInferenceJob_numResults :: Lens' BatchInferenceJob (Maybe Int) Source #
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
batchInferenceJob_batchInferenceJobConfig :: Lens' BatchInferenceJob (Maybe BatchInferenceJobConfig) Source #
A string to string map of the configuration details of a batch inference job.
batchInferenceJob_batchInferenceJobArn :: Lens' BatchInferenceJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the batch inference job.
batchInferenceJob_filterArn :: Lens' BatchInferenceJob (Maybe Text) Source #
The ARN of the filter used on the batch inference job.
batchInferenceJob_creationDateTime :: Lens' BatchInferenceJob (Maybe UTCTime) Source #
The time at which the batch inference job was created.
batchInferenceJob_solutionVersionArn :: Lens' BatchInferenceJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
batchInferenceJob_roleArn :: Lens' BatchInferenceJob (Maybe Text) Source #
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
batchInferenceJob_jobInput :: Lens' BatchInferenceJob (Maybe BatchInferenceJobInput) Source #
The Amazon S3 path that leads to the input data used to generate the batch inference job.
BatchInferenceJobConfig
data BatchInferenceJobConfig Source #
The configuration details of a batch inference job.
See: newBatchInferenceJobConfig
smart constructor.
BatchInferenceJobConfig' | |
|
Instances
newBatchInferenceJobConfig :: BatchInferenceJobConfig Source #
Create a value of BatchInferenceJobConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemExplorationConfig:BatchInferenceJobConfig'
, batchInferenceJobConfig_itemExplorationConfig
- A string to string map specifying the exploration configuration
hyperparameters, including explorationWeight
and
explorationItemAgeCutOff
, you want to use to configure the amount of
item exploration Amazon Personalize uses when recommending items. See
User-Personalization.
batchInferenceJobConfig_itemExplorationConfig :: Lens' BatchInferenceJobConfig (Maybe (HashMap Text Text)) Source #
A string to string map specifying the exploration configuration
hyperparameters, including explorationWeight
and
explorationItemAgeCutOff
, you want to use to configure the amount of
item exploration Amazon Personalize uses when recommending items. See
User-Personalization.
BatchInferenceJobInput
data BatchInferenceJobInput Source #
The input configuration of a batch inference job.
See: newBatchInferenceJobInput
smart constructor.
BatchInferenceJobInput' | |
|
Instances
newBatchInferenceJobInput Source #
Create a value of BatchInferenceJobInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DataSource:BatchInferenceJobInput'
, batchInferenceJobInput_s3DataSource
- The URI of the Amazon S3 location that contains your input data. The
Amazon S3 bucket must be in the same region as the API endpoint you are
calling.
batchInferenceJobInput_s3DataSource :: Lens' BatchInferenceJobInput S3DataConfig Source #
The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
BatchInferenceJobOutput
data BatchInferenceJobOutput Source #
The output configuration parameters of a batch inference job.
See: newBatchInferenceJobOutput
smart constructor.
BatchInferenceJobOutput' | |
|
Instances
newBatchInferenceJobOutput Source #
Create a value of BatchInferenceJobOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DataDestination:BatchInferenceJobOutput'
, batchInferenceJobOutput_s3DataDestination
- Information on the Amazon S3 bucket in which the batch inference job's
output is stored.
batchInferenceJobOutput_s3DataDestination :: Lens' BatchInferenceJobOutput S3DataConfig Source #
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
BatchInferenceJobSummary
data BatchInferenceJobSummary Source #
A truncated version of the BatchInferenceJob datatype. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
See: newBatchInferenceJobSummary
smart constructor.
BatchInferenceJobSummary' | |
|
Instances
newBatchInferenceJobSummary :: BatchInferenceJobSummary Source #
Create a value of BatchInferenceJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:BatchInferenceJobSummary'
, batchInferenceJobSummary_failureReason
- If the batch inference job failed, the reason for the failure.
$sel:status:BatchInferenceJobSummary'
, batchInferenceJobSummary_status
- The status of the batch inference job. The status is one of the
following values:
- PENDING
- IN PROGRESS
- ACTIVE
- CREATE FAILED
$sel:jobName:BatchInferenceJobSummary'
, batchInferenceJobSummary_jobName
- The name of the batch inference job.
$sel:lastUpdatedDateTime:BatchInferenceJobSummary'
, batchInferenceJobSummary_lastUpdatedDateTime
- The time at which the batch inference job was last updated.
$sel:batchInferenceJobArn:BatchInferenceJobSummary'
, batchInferenceJobSummary_batchInferenceJobArn
- The Amazon Resource Name (ARN) of the batch inference job.
$sel:creationDateTime:BatchInferenceJobSummary'
, batchInferenceJobSummary_creationDateTime
- The time at which the batch inference job was created.
$sel:solutionVersionArn:BatchInferenceJobSummary'
, batchInferenceJobSummary_solutionVersionArn
- The ARN of the solution version used by the batch inference job.
batchInferenceJobSummary_failureReason :: Lens' BatchInferenceJobSummary (Maybe Text) Source #
If the batch inference job failed, the reason for the failure.
batchInferenceJobSummary_status :: Lens' BatchInferenceJobSummary (Maybe Text) Source #
The status of the batch inference job. The status is one of the following values:
- PENDING
- IN PROGRESS
- ACTIVE
- CREATE FAILED
batchInferenceJobSummary_jobName :: Lens' BatchInferenceJobSummary (Maybe Text) Source #
The name of the batch inference job.
batchInferenceJobSummary_lastUpdatedDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime) Source #
The time at which the batch inference job was last updated.
batchInferenceJobSummary_batchInferenceJobArn :: Lens' BatchInferenceJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the batch inference job.
batchInferenceJobSummary_creationDateTime :: Lens' BatchInferenceJobSummary (Maybe UTCTime) Source #
The time at which the batch inference job was created.
batchInferenceJobSummary_solutionVersionArn :: Lens' BatchInferenceJobSummary (Maybe Text) Source #
The ARN of the solution version used by the batch inference job.
Campaign
Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.
See: newCampaign
smart constructor.
Campaign' | |
|
Instances
newCampaign :: Campaign Source #
Create a value of Campaign
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:Campaign'
, campaign_failureReason
- If a campaign fails, the reason behind the failure.
$sel:status:Campaign'
, campaign_status
- The status of the campaign.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:lastUpdatedDateTime:Campaign'
, campaign_lastUpdatedDateTime
- The date and time (in Unix format) that the campaign was last updated.
$sel:campaignConfig:Campaign'
, campaign_campaignConfig
- The configuration details of a campaign.
$sel:latestCampaignUpdate:Campaign'
, campaign_latestCampaignUpdate
- Undocumented member.
$sel:name:Campaign'
, campaign_name
- The name of the campaign.
$sel:minProvisionedTPS:Campaign'
, campaign_minProvisionedTPS
- Specifies the requested minimum provisioned transactions
(recommendations) per second.
$sel:creationDateTime:Campaign'
, campaign_creationDateTime
- The date and time (in Unix format) that the campaign was created.
$sel:campaignArn:Campaign'
, campaign_campaignArn
- The Amazon Resource Name (ARN) of the campaign.
$sel:solutionVersionArn:Campaign'
, campaign_solutionVersionArn
- The Amazon Resource Name (ARN) of a specific version of the solution.
campaign_failureReason :: Lens' Campaign (Maybe Text) Source #
If a campaign fails, the reason behind the failure.
campaign_status :: Lens' Campaign (Maybe Text) Source #
The status of the campaign.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
campaign_lastUpdatedDateTime :: Lens' Campaign (Maybe UTCTime) Source #
The date and time (in Unix format) that the campaign was last updated.
campaign_campaignConfig :: Lens' Campaign (Maybe CampaignConfig) Source #
The configuration details of a campaign.
campaign_latestCampaignUpdate :: Lens' Campaign (Maybe CampaignUpdateSummary) Source #
Undocumented member.
campaign_minProvisionedTPS :: Lens' Campaign (Maybe Natural) Source #
Specifies the requested minimum provisioned transactions (recommendations) per second.
campaign_creationDateTime :: Lens' Campaign (Maybe UTCTime) Source #
The date and time (in Unix format) that the campaign was created.
campaign_campaignArn :: Lens' Campaign (Maybe Text) Source #
The Amazon Resource Name (ARN) of the campaign.
campaign_solutionVersionArn :: Lens' Campaign (Maybe Text) Source #
The Amazon Resource Name (ARN) of a specific version of the solution.
CampaignConfig
data CampaignConfig Source #
The configuration details of a campaign.
See: newCampaignConfig
smart constructor.
CampaignConfig' | |
|
Instances
newCampaignConfig :: CampaignConfig Source #
Create a value of CampaignConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemExplorationConfig:CampaignConfig'
, campaignConfig_itemExplorationConfig
- A string to string map specifying the exploration configuration
hyperparameters, including explorationWeight
and
explorationItemAgeCutOff
, you want to use to configure the amount of
item exploration Amazon Personalize uses when recommending items.
Provide itemExplorationConfig
data only if your solution uses the
User-Personalization
recipe.
campaignConfig_itemExplorationConfig :: Lens' CampaignConfig (Maybe (HashMap Text Text)) Source #
A string to string map specifying the exploration configuration
hyperparameters, including explorationWeight
and
explorationItemAgeCutOff
, you want to use to configure the amount of
item exploration Amazon Personalize uses when recommending items.
Provide itemExplorationConfig
data only if your solution uses the
User-Personalization
recipe.
CampaignSummary
data CampaignSummary Source #
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
See: newCampaignSummary
smart constructor.
CampaignSummary' | |
|
Instances
newCampaignSummary :: CampaignSummary Source #
Create a value of CampaignSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:CampaignSummary'
, campaignSummary_failureReason
- If a campaign fails, the reason behind the failure.
$sel:status:CampaignSummary'
, campaignSummary_status
- The status of the campaign.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:lastUpdatedDateTime:CampaignSummary'
, campaignSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the campaign was last updated.
$sel:name:CampaignSummary'
, campaignSummary_name
- The name of the campaign.
$sel:creationDateTime:CampaignSummary'
, campaignSummary_creationDateTime
- The date and time (in Unix time) that the campaign was created.
$sel:campaignArn:CampaignSummary'
, campaignSummary_campaignArn
- The Amazon Resource Name (ARN) of the campaign.
campaignSummary_failureReason :: Lens' CampaignSummary (Maybe Text) Source #
If a campaign fails, the reason behind the failure.
campaignSummary_status :: Lens' CampaignSummary (Maybe Text) Source #
The status of the campaign.
A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
campaignSummary_lastUpdatedDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the campaign was last updated.
campaignSummary_name :: Lens' CampaignSummary (Maybe Text) Source #
The name of the campaign.
campaignSummary_creationDateTime :: Lens' CampaignSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the campaign was created.
campaignSummary_campaignArn :: Lens' CampaignSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the campaign.
CampaignUpdateSummary
data CampaignUpdateSummary Source #
Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
See: newCampaignUpdateSummary
smart constructor.
CampaignUpdateSummary' | |
|
Instances
newCampaignUpdateSummary :: CampaignUpdateSummary Source #
Create a value of CampaignUpdateSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:CampaignUpdateSummary'
, campaignUpdateSummary_failureReason
- If a campaign update fails, the reason behind the failure.
$sel:status:CampaignUpdateSummary'
, campaignUpdateSummary_status
- The status of the campaign update.
A campaign update can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:lastUpdatedDateTime:CampaignUpdateSummary'
, campaignUpdateSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the campaign update was last
updated.
$sel:campaignConfig:CampaignUpdateSummary'
, campaignUpdateSummary_campaignConfig
- Undocumented member.
$sel:minProvisionedTPS:CampaignUpdateSummary'
, campaignUpdateSummary_minProvisionedTPS
- Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support.
$sel:creationDateTime:CampaignUpdateSummary'
, campaignUpdateSummary_creationDateTime
- The date and time (in Unix time) that the campaign update was created.
$sel:solutionVersionArn:CampaignUpdateSummary'
, campaignUpdateSummary_solutionVersionArn
- The Amazon Resource Name (ARN) of the deployed solution version.
campaignUpdateSummary_failureReason :: Lens' CampaignUpdateSummary (Maybe Text) Source #
If a campaign update fails, the reason behind the failure.
campaignUpdateSummary_status :: Lens' CampaignUpdateSummary (Maybe Text) Source #
The status of the campaign update.
A campaign update can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
campaignUpdateSummary_lastUpdatedDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the campaign update was last updated.
campaignUpdateSummary_campaignConfig :: Lens' CampaignUpdateSummary (Maybe CampaignConfig) Source #
Undocumented member.
campaignUpdateSummary_minProvisionedTPS :: Lens' CampaignUpdateSummary (Maybe Natural) Source #
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
campaignUpdateSummary_creationDateTime :: Lens' CampaignUpdateSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the campaign update was created.
campaignUpdateSummary_solutionVersionArn :: Lens' CampaignUpdateSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deployed solution version.
CategoricalHyperParameterRange
data CategoricalHyperParameterRange Source #
Provides the name and range of a categorical hyperparameter.
See: newCategoricalHyperParameterRange
smart constructor.
Instances
newCategoricalHyperParameterRange :: CategoricalHyperParameterRange Source #
Create a value of CategoricalHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:CategoricalHyperParameterRange'
, categoricalHyperParameterRange_values
- A list of the categories for the hyperparameter.
$sel:name:CategoricalHyperParameterRange'
, categoricalHyperParameterRange_name
- The name of the hyperparameter.
categoricalHyperParameterRange_values :: Lens' CategoricalHyperParameterRange (Maybe [Text]) Source #
A list of the categories for the hyperparameter.
categoricalHyperParameterRange_name :: Lens' CategoricalHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
ContinuousHyperParameterRange
data ContinuousHyperParameterRange Source #
Provides the name and range of a continuous hyperparameter.
See: newContinuousHyperParameterRange
smart constructor.
Instances
newContinuousHyperParameterRange :: ContinuousHyperParameterRange Source #
Create a value of ContinuousHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxValue:ContinuousHyperParameterRange'
, continuousHyperParameterRange_maxValue
- The maximum allowable value for the hyperparameter.
$sel:name:ContinuousHyperParameterRange'
, continuousHyperParameterRange_name
- The name of the hyperparameter.
$sel:minValue:ContinuousHyperParameterRange'
, continuousHyperParameterRange_minValue
- The minimum allowable value for the hyperparameter.
continuousHyperParameterRange_maxValue :: Lens' ContinuousHyperParameterRange (Maybe Double) Source #
The maximum allowable value for the hyperparameter.
continuousHyperParameterRange_name :: Lens' ContinuousHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
continuousHyperParameterRange_minValue :: Lens' ContinuousHyperParameterRange (Maybe Double) Source #
The minimum allowable value for the hyperparameter.
DataSource
data DataSource Source #
Describes the data source that contains the data to upload to a dataset.
See: newDataSource
smart constructor.
DataSource' | |
|
Instances
newDataSource :: DataSource Source #
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataLocation:DataSource'
, dataSource_dataLocation
- The path to the Amazon S3 bucket where the data that you want to upload
to your dataset is stored. For example:
s3://bucket-name/folder-name/
dataSource_dataLocation :: Lens' DataSource (Maybe Text) Source #
The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:
s3://bucket-name/folder-name/
Dataset
Provides metadata for a dataset.
See: newDataset
smart constructor.
Dataset' | |
|
Instances
newDataset :: Dataset Source #
Create a value of Dataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Dataset'
, dataset_status
- The status of the dataset.
A dataset can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:datasetArn:Dataset'
, dataset_datasetArn
- The Amazon Resource Name (ARN) of the dataset that you want metadata
for.
$sel:lastUpdatedDateTime:Dataset'
, dataset_lastUpdatedDateTime
- A time stamp that shows when the dataset was updated.
$sel:schemaArn:Dataset'
, dataset_schemaArn
- The ARN of the associated schema.
$sel:name:Dataset'
, dataset_name
- The name of the dataset.
$sel:datasetType:Dataset'
, dataset_datasetType
- One of the following values:
- Interactions
- Items
- Users
$sel:creationDateTime:Dataset'
, dataset_creationDateTime
- The creation date and time (in Unix time) of the dataset.
$sel:datasetGroupArn:Dataset'
, dataset_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
dataset_status :: Lens' Dataset (Maybe Text) Source #
The status of the dataset.
A dataset can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
dataset_datasetArn :: Lens' Dataset (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset that you want metadata for.
dataset_lastUpdatedDateTime :: Lens' Dataset (Maybe UTCTime) Source #
A time stamp that shows when the dataset was updated.
dataset_datasetType :: Lens' Dataset (Maybe Text) Source #
One of the following values:
- Interactions
- Items
- Users
dataset_creationDateTime :: Lens' Dataset (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the dataset.
dataset_datasetGroupArn :: Lens' Dataset (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
DatasetExportJob
data DatasetExportJob Source #
Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
See: newDatasetExportJob
smart constructor.
DatasetExportJob' | |
|
Instances
newDatasetExportJob :: DatasetExportJob Source #
Create a value of DatasetExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetExportJob'
, datasetExportJob_failureReason
- If a dataset export job fails, provides the reason why.
$sel:status:DatasetExportJob'
, datasetExportJob_status
- The status of the dataset export job.
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:datasetExportJobArn:DatasetExportJob'
, datasetExportJob_datasetExportJobArn
- The Amazon Resource Name (ARN) of the dataset export job.
$sel:datasetArn:DatasetExportJob'
, datasetExportJob_datasetArn
- The Amazon Resource Name (ARN) of the dataset to export.
$sel:jobOutput:DatasetExportJob'
, datasetExportJob_jobOutput
- The path to the Amazon S3 bucket where the job's output is stored. For
example:
s3://bucket-name/folder-name/
$sel:jobName:DatasetExportJob'
, datasetExportJob_jobName
- The name of the export job.
$sel:lastUpdatedDateTime:DatasetExportJob'
, datasetExportJob_lastUpdatedDateTime
- The date and time (in Unix time) the status of the dataset export job
was last updated.
$sel:ingestionMode:DatasetExportJob'
, datasetExportJob_ingestionMode
- The data to export, based on how you imported the data. You can choose
to export BULK
data that you imported using a dataset import job,
PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types.
The default value is PUT
.
$sel:creationDateTime:DatasetExportJob'
, datasetExportJob_creationDateTime
- The creation date and time (in Unix time) of the dataset export job.
$sel:roleArn:DatasetExportJob'
, datasetExportJob_roleArn
- The Amazon Resource Name (ARN) of the IAM service role that has
permissions to add data to your output Amazon S3 bucket.
datasetExportJob_failureReason :: Lens' DatasetExportJob (Maybe Text) Source #
If a dataset export job fails, provides the reason why.
datasetExportJob_status :: Lens' DatasetExportJob (Maybe Text) Source #
The status of the dataset export job.
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
datasetExportJob_datasetExportJobArn :: Lens' DatasetExportJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset export job.
datasetExportJob_datasetArn :: Lens' DatasetExportJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset to export.
datasetExportJob_jobOutput :: Lens' DatasetExportJob (Maybe DatasetExportJobOutput) Source #
The path to the Amazon S3 bucket where the job's output is stored. For example:
s3://bucket-name/folder-name/
datasetExportJob_jobName :: Lens' DatasetExportJob (Maybe Text) Source #
The name of the export job.
datasetExportJob_lastUpdatedDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #
The date and time (in Unix time) the status of the dataset export job was last updated.
datasetExportJob_ingestionMode :: Lens' DatasetExportJob (Maybe IngestionMode) Source #
The data to export, based on how you imported the data. You can choose
to export BULK
data that you imported using a dataset import job,
PUT
data that you imported incrementally (using the console,
PutEvents, PutUsers and PutItems operations), or ALL
for both types.
The default value is PUT
.
datasetExportJob_creationDateTime :: Lens' DatasetExportJob (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the dataset export job.
datasetExportJob_roleArn :: Lens' DatasetExportJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
DatasetExportJobOutput
data DatasetExportJobOutput Source #
The output configuration parameters of a dataset export job.
See: newDatasetExportJobOutput
smart constructor.
Instances
newDatasetExportJobOutput Source #
Create a value of DatasetExportJobOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DataDestination:DatasetExportJobOutput'
, datasetExportJobOutput_s3DataDestination
- Undocumented member.
datasetExportJobOutput_s3DataDestination :: Lens' DatasetExportJobOutput S3DataConfig Source #
Undocumented member.
DatasetExportJobSummary
data DatasetExportJobSummary Source #
Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.
See: newDatasetExportJobSummary
smart constructor.
DatasetExportJobSummary' | |
|
Instances
newDatasetExportJobSummary :: DatasetExportJobSummary Source #
Create a value of DatasetExportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetExportJobSummary'
, datasetExportJobSummary_failureReason
- If a dataset export job fails, the reason behind the failure.
$sel:status:DatasetExportJobSummary'
, datasetExportJobSummary_status
- The status of the dataset export job.
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:datasetExportJobArn:DatasetExportJobSummary'
, datasetExportJobSummary_datasetExportJobArn
- The Amazon Resource Name (ARN) of the dataset export job.
$sel:jobName:DatasetExportJobSummary'
, datasetExportJobSummary_jobName
- The name of the dataset export job.
$sel:lastUpdatedDateTime:DatasetExportJobSummary'
, datasetExportJobSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the dataset export job status was
last updated.
$sel:creationDateTime:DatasetExportJobSummary'
, datasetExportJobSummary_creationDateTime
- The date and time (in Unix time) that the dataset export job was
created.
datasetExportJobSummary_failureReason :: Lens' DatasetExportJobSummary (Maybe Text) Source #
If a dataset export job fails, the reason behind the failure.
datasetExportJobSummary_status :: Lens' DatasetExportJobSummary (Maybe Text) Source #
The status of the dataset export job.
A dataset export job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
datasetExportJobSummary_datasetExportJobArn :: Lens' DatasetExportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset export job.
datasetExportJobSummary_jobName :: Lens' DatasetExportJobSummary (Maybe Text) Source #
The name of the dataset export job.
datasetExportJobSummary_lastUpdatedDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset export job status was last updated.
datasetExportJobSummary_creationDateTime :: Lens' DatasetExportJobSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset export job was created.
DatasetGroup
data DatasetGroup Source #
A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.
See: newDatasetGroup
smart constructor.
DatasetGroup' | |
|
Instances
newDatasetGroup :: DatasetGroup Source #
Create a value of DatasetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetGroup'
, datasetGroup_failureReason
- If creating a dataset group fails, provides the reason why.
$sel:status:DatasetGroup'
, datasetGroup_status
- The current status of the dataset group.
A dataset group can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING
$sel:kmsKeyArn:DatasetGroup'
, datasetGroup_kmsKeyArn
- The Amazon Resource Name (ARN) of the Key Management Service (KMS) key
used to encrypt the datasets.
$sel:lastUpdatedDateTime:DatasetGroup'
, datasetGroup_lastUpdatedDateTime
- The last update date and time (in Unix time) of the dataset group.
$sel:name:DatasetGroup'
, datasetGroup_name
- The name of the dataset group.
$sel:creationDateTime:DatasetGroup'
, datasetGroup_creationDateTime
- The creation date and time (in Unix time) of the dataset group.
$sel:datasetGroupArn:DatasetGroup'
, datasetGroup_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
$sel:roleArn:DatasetGroup'
, datasetGroup_roleArn
- The ARN of the IAM role that has permissions to create the dataset
group.
datasetGroup_failureReason :: Lens' DatasetGroup (Maybe Text) Source #
If creating a dataset group fails, provides the reason why.
datasetGroup_status :: Lens' DatasetGroup (Maybe Text) Source #
The current status of the dataset group.
A dataset group can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING
datasetGroup_kmsKeyArn :: Lens' DatasetGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
datasetGroup_lastUpdatedDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #
The last update date and time (in Unix time) of the dataset group.
datasetGroup_name :: Lens' DatasetGroup (Maybe Text) Source #
The name of the dataset group.
datasetGroup_creationDateTime :: Lens' DatasetGroup (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the dataset group.
datasetGroup_datasetGroupArn :: Lens' DatasetGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
datasetGroup_roleArn :: Lens' DatasetGroup (Maybe Text) Source #
The ARN of the IAM role that has permissions to create the dataset group.
DatasetGroupSummary
data DatasetGroupSummary Source #
Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
See: newDatasetGroupSummary
smart constructor.
DatasetGroupSummary' | |
|
Instances
newDatasetGroupSummary :: DatasetGroupSummary Source #
Create a value of DatasetGroupSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetGroupSummary'
, datasetGroupSummary_failureReason
- If creating a dataset group fails, the reason behind the failure.
$sel:status:DatasetGroupSummary'
, datasetGroupSummary_status
- The status of the dataset group.
A dataset group can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING
$sel:lastUpdatedDateTime:DatasetGroupSummary'
, datasetGroupSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the dataset group was last
updated.
$sel:name:DatasetGroupSummary'
, datasetGroupSummary_name
- The name of the dataset group.
$sel:creationDateTime:DatasetGroupSummary'
, datasetGroupSummary_creationDateTime
- The date and time (in Unix time) that the dataset group was created.
$sel:datasetGroupArn:DatasetGroupSummary'
, datasetGroupSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
datasetGroupSummary_failureReason :: Lens' DatasetGroupSummary (Maybe Text) Source #
If creating a dataset group fails, the reason behind the failure.
datasetGroupSummary_status :: Lens' DatasetGroupSummary (Maybe Text) Source #
The status of the dataset group.
A dataset group can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING
datasetGroupSummary_lastUpdatedDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset group was last updated.
datasetGroupSummary_name :: Lens' DatasetGroupSummary (Maybe Text) Source #
The name of the dataset group.
datasetGroupSummary_creationDateTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset group was created.
datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
DatasetImportJob
data DatasetImportJob Source #
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
See: newDatasetImportJob
smart constructor.
DatasetImportJob' | |
|
Instances
newDatasetImportJob :: DatasetImportJob Source #
Create a value of DatasetImportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetImportJob'
, datasetImportJob_failureReason
- If a dataset import job fails, provides the reason why.
$sel:status:DatasetImportJob'
, datasetImportJob_status
- The status of the dataset import job.
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:datasetArn:DatasetImportJob'
, datasetImportJob_datasetArn
- The Amazon Resource Name (ARN) of the dataset that receives the imported
data.
$sel:jobName:DatasetImportJob'
, datasetImportJob_jobName
- The name of the import job.
$sel:lastUpdatedDateTime:DatasetImportJob'
, datasetImportJob_lastUpdatedDateTime
- The date and time (in Unix time) the dataset was last updated.
$sel:datasetImportJobArn:DatasetImportJob'
, datasetImportJob_datasetImportJobArn
- The ARN of the dataset import job.
$sel:dataSource:DatasetImportJob'
, datasetImportJob_dataSource
- The Amazon S3 bucket that contains the training data to import.
$sel:creationDateTime:DatasetImportJob'
, datasetImportJob_creationDateTime
- The creation date and time (in Unix time) of the dataset import job.
$sel:roleArn:DatasetImportJob'
, datasetImportJob_roleArn
- The ARN of the IAM role that has permissions to read from the Amazon S3
data source.
datasetImportJob_failureReason :: Lens' DatasetImportJob (Maybe Text) Source #
If a dataset import job fails, provides the reason why.
datasetImportJob_status :: Lens' DatasetImportJob (Maybe Text) Source #
The status of the dataset import job.
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
datasetImportJob_datasetArn :: Lens' DatasetImportJob (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset that receives the imported data.
datasetImportJob_jobName :: Lens' DatasetImportJob (Maybe Text) Source #
The name of the import job.
datasetImportJob_lastUpdatedDateTime :: Lens' DatasetImportJob (Maybe UTCTime) Source #
The date and time (in Unix time) the dataset was last updated.
datasetImportJob_datasetImportJobArn :: Lens' DatasetImportJob (Maybe Text) Source #
The ARN of the dataset import job.
datasetImportJob_dataSource :: Lens' DatasetImportJob (Maybe DataSource) Source #
The Amazon S3 bucket that contains the training data to import.
datasetImportJob_creationDateTime :: Lens' DatasetImportJob (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the dataset import job.
datasetImportJob_roleArn :: Lens' DatasetImportJob (Maybe Text) Source #
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
DatasetImportJobSummary
data DatasetImportJobSummary Source #
Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
See: newDatasetImportJobSummary
smart constructor.
DatasetImportJobSummary' | |
|
Instances
newDatasetImportJobSummary :: DatasetImportJobSummary Source #
Create a value of DatasetImportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:DatasetImportJobSummary'
, datasetImportJobSummary_failureReason
- If a dataset import job fails, the reason behind the failure.
$sel:status:DatasetImportJobSummary'
, datasetImportJobSummary_status
- The status of the dataset import job.
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:jobName:DatasetImportJobSummary'
, datasetImportJobSummary_jobName
- The name of the dataset import job.
$sel:lastUpdatedDateTime:DatasetImportJobSummary'
, datasetImportJobSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the dataset import job status was
last updated.
$sel:datasetImportJobArn:DatasetImportJobSummary'
, datasetImportJobSummary_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
$sel:creationDateTime:DatasetImportJobSummary'
, datasetImportJobSummary_creationDateTime
- The date and time (in Unix time) that the dataset import job was
created.
datasetImportJobSummary_failureReason :: Lens' DatasetImportJobSummary (Maybe Text) Source #
If a dataset import job fails, the reason behind the failure.
datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The status of the dataset import job.
A dataset import job can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
datasetImportJobSummary_jobName :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The name of the dataset import job.
datasetImportJobSummary_lastUpdatedDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset import job status was last updated.
datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job.
datasetImportJobSummary_creationDateTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset import job was created.
DatasetSchema
data DatasetSchema Source #
Describes the schema for a dataset. For more information on schemas, see CreateSchema.
See: newDatasetSchema
smart constructor.
DatasetSchema' | |
|
Instances
newDatasetSchema :: DatasetSchema Source #
Create a value of DatasetSchema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedDateTime:DatasetSchema'
, datasetSchema_lastUpdatedDateTime
- The date and time (in Unix time) that the schema was last updated.
$sel:schema:DatasetSchema'
, datasetSchema_schema
- The schema.
$sel:schemaArn:DatasetSchema'
, datasetSchema_schemaArn
- The Amazon Resource Name (ARN) of the schema.
$sel:name:DatasetSchema'
, datasetSchema_name
- The name of the schema.
$sel:creationDateTime:DatasetSchema'
, datasetSchema_creationDateTime
- The date and time (in Unix time) that the schema was created.
datasetSchema_lastUpdatedDateTime :: Lens' DatasetSchema (Maybe UTCTime) Source #
The date and time (in Unix time) that the schema was last updated.
datasetSchema_schema :: Lens' DatasetSchema (Maybe Text) Source #
The schema.
datasetSchema_schemaArn :: Lens' DatasetSchema (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schema.
datasetSchema_name :: Lens' DatasetSchema (Maybe Text) Source #
The name of the schema.
datasetSchema_creationDateTime :: Lens' DatasetSchema (Maybe UTCTime) Source #
The date and time (in Unix time) that the schema was created.
DatasetSchemaSummary
data DatasetSchemaSummary Source #
Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
See: newDatasetSchemaSummary
smart constructor.
DatasetSchemaSummary' | |
|
Instances
newDatasetSchemaSummary :: DatasetSchemaSummary Source #
Create a value of DatasetSchemaSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedDateTime:DatasetSchemaSummary'
, datasetSchemaSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the schema was last updated.
$sel:schemaArn:DatasetSchemaSummary'
, datasetSchemaSummary_schemaArn
- The Amazon Resource Name (ARN) of the schema.
$sel:name:DatasetSchemaSummary'
, datasetSchemaSummary_name
- The name of the schema.
$sel:creationDateTime:DatasetSchemaSummary'
, datasetSchemaSummary_creationDateTime
- The date and time (in Unix time) that the schema was created.
datasetSchemaSummary_lastUpdatedDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the schema was last updated.
datasetSchemaSummary_schemaArn :: Lens' DatasetSchemaSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the schema.
datasetSchemaSummary_name :: Lens' DatasetSchemaSummary (Maybe Text) Source #
The name of the schema.
datasetSchemaSummary_creationDateTime :: Lens' DatasetSchemaSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the schema was created.
DatasetSummary
data DatasetSummary Source #
Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
See: newDatasetSummary
smart constructor.
DatasetSummary' | |
|
Instances
newDatasetSummary :: DatasetSummary Source #
Create a value of DatasetSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DatasetSummary'
, datasetSummary_status
- The status of the dataset.
A dataset can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:datasetArn:DatasetSummary'
, datasetSummary_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:lastUpdatedDateTime:DatasetSummary'
, datasetSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the dataset was last updated.
$sel:name:DatasetSummary'
, datasetSummary_name
- The name of the dataset.
$sel:datasetType:DatasetSummary'
, datasetSummary_datasetType
- The dataset type. One of the following values:
- Interactions
- Items
- Users
- Event-Interactions
$sel:creationDateTime:DatasetSummary'
, datasetSummary_creationDateTime
- The date and time (in Unix time) that the dataset was created.
datasetSummary_status :: Lens' DatasetSummary (Maybe Text) Source #
The status of the dataset.
A dataset can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
datasetSummary_lastUpdatedDateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset was last updated.
datasetSummary_name :: Lens' DatasetSummary (Maybe Text) Source #
The name of the dataset.
datasetSummary_datasetType :: Lens' DatasetSummary (Maybe Text) Source #
The dataset type. One of the following values:
- Interactions
- Items
- Users
- Event-Interactions
datasetSummary_creationDateTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the dataset was created.
DefaultCategoricalHyperParameterRange
data DefaultCategoricalHyperParameterRange Source #
Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
See: newDefaultCategoricalHyperParameterRange
smart constructor.
Instances
newDefaultCategoricalHyperParameterRange :: DefaultCategoricalHyperParameterRange Source #
Create a value of DefaultCategoricalHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isTunable:DefaultCategoricalHyperParameterRange'
, defaultCategoricalHyperParameterRange_isTunable
- Whether the hyperparameter is tunable.
$sel:values:DefaultCategoricalHyperParameterRange'
, defaultCategoricalHyperParameterRange_values
- A list of the categories for the hyperparameter.
$sel:name:DefaultCategoricalHyperParameterRange'
, defaultCategoricalHyperParameterRange_name
- The name of the hyperparameter.
defaultCategoricalHyperParameterRange_isTunable :: Lens' DefaultCategoricalHyperParameterRange (Maybe Bool) Source #
Whether the hyperparameter is tunable.
defaultCategoricalHyperParameterRange_values :: Lens' DefaultCategoricalHyperParameterRange (Maybe [Text]) Source #
A list of the categories for the hyperparameter.
defaultCategoricalHyperParameterRange_name :: Lens' DefaultCategoricalHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
DefaultContinuousHyperParameterRange
data DefaultContinuousHyperParameterRange Source #
Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
See: newDefaultContinuousHyperParameterRange
smart constructor.
Instances
newDefaultContinuousHyperParameterRange :: DefaultContinuousHyperParameterRange Source #
Create a value of DefaultContinuousHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxValue:DefaultContinuousHyperParameterRange'
, defaultContinuousHyperParameterRange_maxValue
- The maximum allowable value for the hyperparameter.
$sel:isTunable:DefaultContinuousHyperParameterRange'
, defaultContinuousHyperParameterRange_isTunable
- Whether the hyperparameter is tunable.
$sel:name:DefaultContinuousHyperParameterRange'
, defaultContinuousHyperParameterRange_name
- The name of the hyperparameter.
$sel:minValue:DefaultContinuousHyperParameterRange'
, defaultContinuousHyperParameterRange_minValue
- The minimum allowable value for the hyperparameter.
defaultContinuousHyperParameterRange_maxValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double) Source #
The maximum allowable value for the hyperparameter.
defaultContinuousHyperParameterRange_isTunable :: Lens' DefaultContinuousHyperParameterRange (Maybe Bool) Source #
Whether the hyperparameter is tunable.
defaultContinuousHyperParameterRange_name :: Lens' DefaultContinuousHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
defaultContinuousHyperParameterRange_minValue :: Lens' DefaultContinuousHyperParameterRange (Maybe Double) Source #
The minimum allowable value for the hyperparameter.
DefaultHyperParameterRanges
data DefaultHyperParameterRanges Source #
Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.
See: newDefaultHyperParameterRanges
smart constructor.
DefaultHyperParameterRanges' | |
|
Instances
newDefaultHyperParameterRanges :: DefaultHyperParameterRanges Source #
Create a value of DefaultHyperParameterRanges
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:integerHyperParameterRanges:DefaultHyperParameterRanges'
, defaultHyperParameterRanges_integerHyperParameterRanges
- The integer-valued hyperparameters and their default ranges.
$sel:categoricalHyperParameterRanges:DefaultHyperParameterRanges'
, defaultHyperParameterRanges_categoricalHyperParameterRanges
- The categorical hyperparameters and their default ranges.
$sel:continuousHyperParameterRanges:DefaultHyperParameterRanges'
, defaultHyperParameterRanges_continuousHyperParameterRanges
- The continuous hyperparameters and their default ranges.
defaultHyperParameterRanges_integerHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultIntegerHyperParameterRange]) Source #
The integer-valued hyperparameters and their default ranges.
defaultHyperParameterRanges_categoricalHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultCategoricalHyperParameterRange]) Source #
The categorical hyperparameters and their default ranges.
defaultHyperParameterRanges_continuousHyperParameterRanges :: Lens' DefaultHyperParameterRanges (Maybe [DefaultContinuousHyperParameterRange]) Source #
The continuous hyperparameters and their default ranges.
DefaultIntegerHyperParameterRange
data DefaultIntegerHyperParameterRange Source #
Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
See: newDefaultIntegerHyperParameterRange
smart constructor.
Instances
newDefaultIntegerHyperParameterRange :: DefaultIntegerHyperParameterRange Source #
Create a value of DefaultIntegerHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxValue:DefaultIntegerHyperParameterRange'
, defaultIntegerHyperParameterRange_maxValue
- The maximum allowable value for the hyperparameter.
$sel:isTunable:DefaultIntegerHyperParameterRange'
, defaultIntegerHyperParameterRange_isTunable
- Indicates whether the hyperparameter is tunable.
$sel:name:DefaultIntegerHyperParameterRange'
, defaultIntegerHyperParameterRange_name
- The name of the hyperparameter.
$sel:minValue:DefaultIntegerHyperParameterRange'
, defaultIntegerHyperParameterRange_minValue
- The minimum allowable value for the hyperparameter.
defaultIntegerHyperParameterRange_maxValue :: Lens' DefaultIntegerHyperParameterRange (Maybe Int) Source #
The maximum allowable value for the hyperparameter.
defaultIntegerHyperParameterRange_isTunable :: Lens' DefaultIntegerHyperParameterRange (Maybe Bool) Source #
Indicates whether the hyperparameter is tunable.
defaultIntegerHyperParameterRange_name :: Lens' DefaultIntegerHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
defaultIntegerHyperParameterRange_minValue :: Lens' DefaultIntegerHyperParameterRange (Maybe Int) Source #
The minimum allowable value for the hyperparameter.
EventTracker
data EventTracker Source #
Provides information about an event tracker.
See: newEventTracker
smart constructor.
EventTracker' | |
|
Instances
newEventTracker :: EventTracker Source #
Create a value of EventTracker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EventTracker'
, eventTracker_status
- The status of the event tracker.
An event tracker can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:trackingId:EventTracker'
, eventTracker_trackingId
- The ID of the event tracker. Include this ID in requests to the
PutEvents
API.
$sel:lastUpdatedDateTime:EventTracker'
, eventTracker_lastUpdatedDateTime
- The date and time (in Unix time) that the event tracker was last
updated.
$sel:accountId:EventTracker'
, eventTracker_accountId
- The Amazon Web Services account that owns the event tracker.
$sel:name:EventTracker'
, eventTracker_name
- The name of the event tracker.
$sel:creationDateTime:EventTracker'
, eventTracker_creationDateTime
- The date and time (in Unix format) that the event tracker was created.
$sel:datasetGroupArn:EventTracker'
, eventTracker_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that receives the
event data.
$sel:eventTrackerArn:EventTracker'
, eventTracker_eventTrackerArn
- The ARN of the event tracker.
eventTracker_status :: Lens' EventTracker (Maybe Text) Source #
The status of the event tracker.
An event tracker can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
eventTracker_trackingId :: Lens' EventTracker (Maybe Text) Source #
The ID of the event tracker. Include this ID in requests to the PutEvents API.
eventTracker_lastUpdatedDateTime :: Lens' EventTracker (Maybe UTCTime) Source #
The date and time (in Unix time) that the event tracker was last updated.
eventTracker_accountId :: Lens' EventTracker (Maybe Text) Source #
The Amazon Web Services account that owns the event tracker.
eventTracker_name :: Lens' EventTracker (Maybe Text) Source #
The name of the event tracker.
eventTracker_creationDateTime :: Lens' EventTracker (Maybe UTCTime) Source #
The date and time (in Unix format) that the event tracker was created.
eventTracker_datasetGroupArn :: Lens' EventTracker (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
eventTracker_eventTrackerArn :: Lens' EventTracker (Maybe Text) Source #
The ARN of the event tracker.
EventTrackerSummary
data EventTrackerSummary Source #
Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
See: newEventTrackerSummary
smart constructor.
EventTrackerSummary' | |
|
Instances
newEventTrackerSummary :: EventTrackerSummary Source #
Create a value of EventTrackerSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:EventTrackerSummary'
, eventTrackerSummary_status
- The status of the event tracker.
An event tracker can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:lastUpdatedDateTime:EventTrackerSummary'
, eventTrackerSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the event tracker was last
updated.
$sel:name:EventTrackerSummary'
, eventTrackerSummary_name
- The name of the event tracker.
$sel:creationDateTime:EventTrackerSummary'
, eventTrackerSummary_creationDateTime
- The date and time (in Unix time) that the event tracker was created.
$sel:eventTrackerArn:EventTrackerSummary'
, eventTrackerSummary_eventTrackerArn
- The Amazon Resource Name (ARN) of the event tracker.
eventTrackerSummary_status :: Lens' EventTrackerSummary (Maybe Text) Source #
The status of the event tracker.
An event tracker can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
eventTrackerSummary_lastUpdatedDateTime :: Lens' EventTrackerSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the event tracker was last updated.
eventTrackerSummary_name :: Lens' EventTrackerSummary (Maybe Text) Source #
The name of the event tracker.
eventTrackerSummary_creationDateTime :: Lens' EventTrackerSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the event tracker was created.
eventTrackerSummary_eventTrackerArn :: Lens' EventTrackerSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the event tracker.
FeatureTransformation
data FeatureTransformation Source #
Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.
See: newFeatureTransformation
smart constructor.
FeatureTransformation' | |
|
Instances
newFeatureTransformation :: FeatureTransformation Source #
Create a value of FeatureTransformation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:FeatureTransformation'
, featureTransformation_status
- The status of the feature transformation.
A feature transformation can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:featureTransformationArn:FeatureTransformation'
, featureTransformation_featureTransformationArn
- The Amazon Resource Name (ARN) of the FeatureTransformation object.
$sel:lastUpdatedDateTime:FeatureTransformation'
, featureTransformation_lastUpdatedDateTime
- The last update date and time (in Unix time) of the feature
transformation.
$sel:name:FeatureTransformation'
, featureTransformation_name
- The name of the feature transformation.
$sel:creationDateTime:FeatureTransformation'
, featureTransformation_creationDateTime
- The creation date and time (in Unix time) of the feature transformation.
$sel:defaultParameters:FeatureTransformation'
, featureTransformation_defaultParameters
- Provides the default parameters for feature transformation.
featureTransformation_status :: Lens' FeatureTransformation (Maybe Text) Source #
The status of the feature transformation.
A feature transformation can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
featureTransformation_featureTransformationArn :: Lens' FeatureTransformation (Maybe Text) Source #
The Amazon Resource Name (ARN) of the FeatureTransformation object.
featureTransformation_lastUpdatedDateTime :: Lens' FeatureTransformation (Maybe UTCTime) Source #
The last update date and time (in Unix time) of the feature transformation.
featureTransformation_name :: Lens' FeatureTransformation (Maybe Text) Source #
The name of the feature transformation.
featureTransformation_creationDateTime :: Lens' FeatureTransformation (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the feature transformation.
featureTransformation_defaultParameters :: Lens' FeatureTransformation (Maybe (HashMap Text Text)) Source #
Provides the default parameters for feature transformation.
Filter
Contains information on a recommendation filter, including its ARN, status, and filter expression.
See: newFilter
smart constructor.
Filter' | |
|
Instances
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:Filter'
, filter_failureReason
- If the filter failed, the reason for its failure.
$sel:status:Filter'
, filter_status
- The status of the filter.
$sel:filterExpression:Filter'
, filter_filterExpression
- Specifies the type of item interactions to filter out of recommendation
results. The filter expression must follow specific format rules. For
information about filter expression structure and syntax, see
filter-expressions.
$sel:lastUpdatedDateTime:Filter'
, filter_lastUpdatedDateTime
- The time at which the filter was last updated.
$sel:name:Filter'
, filter_name
- The name of the filter.
$sel:filterArn:Filter'
, filter_filterArn
- The ARN of the filter.
$sel:creationDateTime:Filter'
, filter_creationDateTime
- The time at which the filter was created.
$sel:datasetGroupArn:Filter'
, filter_datasetGroupArn
- The ARN of the dataset group to which the filter belongs.
filter_failureReason :: Lens' Filter (Maybe Text) Source #
If the filter failed, the reason for its failure.
filter_filterExpression :: Lens' Filter (Maybe Text) Source #
Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.
filter_lastUpdatedDateTime :: Lens' Filter (Maybe UTCTime) Source #
The time at which the filter was last updated.
filter_creationDateTime :: Lens' Filter (Maybe UTCTime) Source #
The time at which the filter was created.
filter_datasetGroupArn :: Lens' Filter (Maybe Text) Source #
The ARN of the dataset group to which the filter belongs.
FilterSummary
data FilterSummary Source #
A short summary of a filter's attributes.
See: newFilterSummary
smart constructor.
FilterSummary' | |
|
Instances
newFilterSummary :: FilterSummary Source #
Create a value of FilterSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:FilterSummary'
, filterSummary_failureReason
- If the filter failed, the reason for the failure.
$sel:status:FilterSummary'
, filterSummary_status
- The status of the filter.
$sel:lastUpdatedDateTime:FilterSummary'
, filterSummary_lastUpdatedDateTime
- The time at which the filter was last updated.
$sel:name:FilterSummary'
, filterSummary_name
- The name of the filter.
$sel:filterArn:FilterSummary'
, filterSummary_filterArn
- The ARN of the filter.
$sel:creationDateTime:FilterSummary'
, filterSummary_creationDateTime
- The time at which the filter was created.
$sel:datasetGroupArn:FilterSummary'
, filterSummary_datasetGroupArn
- The ARN of the dataset group to which the filter belongs.
filterSummary_failureReason :: Lens' FilterSummary (Maybe Text) Source #
If the filter failed, the reason for the failure.
filterSummary_status :: Lens' FilterSummary (Maybe Text) Source #
The status of the filter.
filterSummary_lastUpdatedDateTime :: Lens' FilterSummary (Maybe UTCTime) Source #
The time at which the filter was last updated.
filterSummary_name :: Lens' FilterSummary (Maybe Text) Source #
The name of the filter.
filterSummary_filterArn :: Lens' FilterSummary (Maybe Text) Source #
The ARN of the filter.
filterSummary_creationDateTime :: Lens' FilterSummary (Maybe UTCTime) Source #
The time at which the filter was created.
filterSummary_datasetGroupArn :: Lens' FilterSummary (Maybe Text) Source #
The ARN of the dataset group to which the filter belongs.
HPOConfig
Describes the properties for hyperparameter optimization (HPO).
See: newHPOConfig
smart constructor.
HPOConfig' | |
|
Instances
newHPOConfig :: HPOConfig Source #
Create a value of HPOConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmHyperParameterRanges:HPOConfig'
, hPOConfig_algorithmHyperParameterRanges
- The hyperparameters and their allowable ranges.
$sel:hpoResourceConfig:HPOConfig'
, hPOConfig_hpoResourceConfig
- Describes the resource configuration for HPO.
$sel:hpoObjective:HPOConfig'
, hPOConfig_hpoObjective
- The metric to optimize during HPO.
Amazon Personalize doesn't support configuring the hpoObjective
at
this time.
hPOConfig_algorithmHyperParameterRanges :: Lens' HPOConfig (Maybe HyperParameterRanges) Source #
The hyperparameters and their allowable ranges.
hPOConfig_hpoResourceConfig :: Lens' HPOConfig (Maybe HPOResourceConfig) Source #
Describes the resource configuration for HPO.
hPOConfig_hpoObjective :: Lens' HPOConfig (Maybe HPOObjective) Source #
The metric to optimize during HPO.
Amazon Personalize doesn't support configuring the hpoObjective
at
this time.
HPOObjective
data HPOObjective Source #
The metric to optimize during hyperparameter optimization (HPO).
Amazon Personalize doesn't support configuring the hpoObjective
at
this time.
See: newHPOObjective
smart constructor.
HPOObjective' | |
|
Instances
newHPOObjective :: HPOObjective Source #
Create a value of HPOObjective
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:HPOObjective'
, hPOObjective_metricName
- The name of the metric.
$sel:type':HPOObjective'
, hPOObjective_type
- The type of the metric. Valid values are Maximize
and Minimize
.
$sel:metricRegex:HPOObjective'
, hPOObjective_metricRegex
- A regular expression for finding the metric in the training job logs.
hPOObjective_metricName :: Lens' HPOObjective (Maybe Text) Source #
The name of the metric.
hPOObjective_type :: Lens' HPOObjective (Maybe Text) Source #
The type of the metric. Valid values are Maximize
and Minimize
.
hPOObjective_metricRegex :: Lens' HPOObjective (Maybe Text) Source #
A regular expression for finding the metric in the training job logs.
HPOResourceConfig
data HPOResourceConfig Source #
Describes the resource configuration for hyperparameter optimization (HPO).
See: newHPOResourceConfig
smart constructor.
HPOResourceConfig' | |
|
Instances
newHPOResourceConfig :: HPOResourceConfig Source #
Create a value of HPOResourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxNumberOfTrainingJobs:HPOResourceConfig'
, hPOResourceConfig_maxNumberOfTrainingJobs
- The maximum number of training jobs when you create a solution version.
The maximum value for maxNumberOfTrainingJobs
is 40
.
$sel:maxParallelTrainingJobs:HPOResourceConfig'
, hPOResourceConfig_maxParallelTrainingJobs
- The maximum number of parallel training jobs when you create a solution
version. The maximum value for maxParallelTrainingJobs
is 10
.
hPOResourceConfig_maxNumberOfTrainingJobs :: Lens' HPOResourceConfig (Maybe Text) Source #
The maximum number of training jobs when you create a solution version.
The maximum value for maxNumberOfTrainingJobs
is 40
.
hPOResourceConfig_maxParallelTrainingJobs :: Lens' HPOResourceConfig (Maybe Text) Source #
The maximum number of parallel training jobs when you create a solution
version. The maximum value for maxParallelTrainingJobs
is 10
.
HyperParameterRanges
data HyperParameterRanges Source #
Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.
See: newHyperParameterRanges
smart constructor.
HyperParameterRanges' | |
|
Instances
newHyperParameterRanges :: HyperParameterRanges Source #
Create a value of HyperParameterRanges
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:integerHyperParameterRanges:HyperParameterRanges'
, hyperParameterRanges_integerHyperParameterRanges
- The integer-valued hyperparameters and their ranges.
$sel:categoricalHyperParameterRanges:HyperParameterRanges'
, hyperParameterRanges_categoricalHyperParameterRanges
- The categorical hyperparameters and their ranges.
$sel:continuousHyperParameterRanges:HyperParameterRanges'
, hyperParameterRanges_continuousHyperParameterRanges
- The continuous hyperparameters and their ranges.
hyperParameterRanges_integerHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [IntegerHyperParameterRange]) Source #
The integer-valued hyperparameters and their ranges.
hyperParameterRanges_categoricalHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [CategoricalHyperParameterRange]) Source #
The categorical hyperparameters and their ranges.
hyperParameterRanges_continuousHyperParameterRanges :: Lens' HyperParameterRanges (Maybe [ContinuousHyperParameterRange]) Source #
The continuous hyperparameters and their ranges.
IntegerHyperParameterRange
data IntegerHyperParameterRange Source #
Provides the name and range of an integer-valued hyperparameter.
See: newIntegerHyperParameterRange
smart constructor.
Instances
newIntegerHyperParameterRange :: IntegerHyperParameterRange Source #
Create a value of IntegerHyperParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxValue:IntegerHyperParameterRange'
, integerHyperParameterRange_maxValue
- The maximum allowable value for the hyperparameter.
$sel:name:IntegerHyperParameterRange'
, integerHyperParameterRange_name
- The name of the hyperparameter.
$sel:minValue:IntegerHyperParameterRange'
, integerHyperParameterRange_minValue
- The minimum allowable value for the hyperparameter.
integerHyperParameterRange_maxValue :: Lens' IntegerHyperParameterRange (Maybe Int) Source #
The maximum allowable value for the hyperparameter.
integerHyperParameterRange_name :: Lens' IntegerHyperParameterRange (Maybe Text) Source #
The name of the hyperparameter.
integerHyperParameterRange_minValue :: Lens' IntegerHyperParameterRange (Maybe Int) Source #
The minimum allowable value for the hyperparameter.
OptimizationObjective
data OptimizationObjective Source #
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
See: newOptimizationObjective
smart constructor.
OptimizationObjective' | |
|
Instances
newOptimizationObjective :: OptimizationObjective Source #
Create a value of OptimizationObjective
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemAttribute:OptimizationObjective'
, optimizationObjective_itemAttribute
- The numerical metadata column in an Items dataset related to the
optimization objective. For example, VIDEO_LENGTH (to maximize streaming
minutes), or PRICE (to maximize revenue).
$sel:objectiveSensitivity:OptimizationObjective'
, optimizationObjective_objectiveSensitivity
- Specifies how Amazon Personalize balances the importance of your
optimization objective versus relevance.
optimizationObjective_itemAttribute :: Lens' OptimizationObjective (Maybe Text) Source #
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
optimizationObjective_objectiveSensitivity :: Lens' OptimizationObjective (Maybe ObjectiveSensitivity) Source #
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
Recipe
Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.
See: newRecipe
smart constructor.
Recipe' | |
|
Instances
Create a value of Recipe
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Recipe'
, recipe_status
- The status of the recipe.
$sel:algorithmArn:Recipe'
, recipe_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize
uses to train the model.
$sel:recipeArn:Recipe'
, recipe_recipeArn
- The Amazon Resource Name (ARN) of the recipe.
$sel:featureTransformationArn:Recipe'
, recipe_featureTransformationArn
- The ARN of the FeatureTransformation object.
$sel:lastUpdatedDateTime:Recipe'
, recipe_lastUpdatedDateTime
- The date and time (in Unix format) that the recipe was last updated.
$sel:name:Recipe'
, recipe_name
- The name of the recipe.
$sel:creationDateTime:Recipe'
, recipe_creationDateTime
- The date and time (in Unix format) that the recipe was created.
$sel:recipeType:Recipe'
, recipe_recipeType
- One of the following values:
- PERSONALIZED_RANKING
- RELATED_ITEMS
- USER_PERSONALIZATION
$sel:description:Recipe'
, recipe_description
- The description of the recipe.
recipe_algorithmArn :: Lens' Recipe (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
recipe_featureTransformationArn :: Lens' Recipe (Maybe Text) Source #
The ARN of the FeatureTransformation object.
recipe_lastUpdatedDateTime :: Lens' Recipe (Maybe UTCTime) Source #
The date and time (in Unix format) that the recipe was last updated.
recipe_creationDateTime :: Lens' Recipe (Maybe UTCTime) Source #
The date and time (in Unix format) that the recipe was created.
recipe_recipeType :: Lens' Recipe (Maybe Text) Source #
One of the following values:
- PERSONALIZED_RANKING
- RELATED_ITEMS
- USER_PERSONALIZATION
RecipeSummary
data RecipeSummary Source #
Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
See: newRecipeSummary
smart constructor.
RecipeSummary' | |
|
Instances
newRecipeSummary :: RecipeSummary Source #
Create a value of RecipeSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:RecipeSummary'
, recipeSummary_status
- The status of the recipe.
$sel:recipeArn:RecipeSummary'
, recipeSummary_recipeArn
- The Amazon Resource Name (ARN) of the recipe.
$sel:lastUpdatedDateTime:RecipeSummary'
, recipeSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the recipe was last updated.
$sel:name:RecipeSummary'
, recipeSummary_name
- The name of the recipe.
$sel:creationDateTime:RecipeSummary'
, recipeSummary_creationDateTime
- The date and time (in Unix time) that the recipe was created.
recipeSummary_status :: Lens' RecipeSummary (Maybe Text) Source #
The status of the recipe.
recipeSummary_recipeArn :: Lens' RecipeSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the recipe.
recipeSummary_lastUpdatedDateTime :: Lens' RecipeSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the recipe was last updated.
recipeSummary_name :: Lens' RecipeSummary (Maybe Text) Source #
The name of the recipe.
recipeSummary_creationDateTime :: Lens' RecipeSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the recipe was created.
S3DataConfig
data S3DataConfig Source #
The configuration details of an Amazon S3 input or output bucket.
See: newS3DataConfig
smart constructor.
Instances
Create a value of S3DataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyArn:S3DataConfig'
, s3DataConfig_kmsKeyArn
- The Amazon Resource Name (ARN) of the Key Management Service (KMS) key
that Amazon Personalize uses to encrypt or decrypt the input and output
files of a batch inference job.
$sel:path:S3DataConfig'
, s3DataConfig_path
- The file path of the Amazon S3 bucket.
s3DataConfig_kmsKeyArn :: Lens' S3DataConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
s3DataConfig_path :: Lens' S3DataConfig Text Source #
The file path of the Amazon S3 bucket.
Solution
An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.
See: newSolution
smart constructor.
Solution' | |
|
Instances
newSolution :: Solution Source #
Create a value of Solution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:solutionArn:Solution'
, solution_solutionArn
- The ARN of the solution.
$sel:status:Solution'
, solution_status
- The status of the solution.
A solution can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:performAutoML:Solution'
, solution_performAutoML
- When true, Amazon Personalize performs a search for the best
USER_PERSONALIZATION recipe from the list specified in the solution
configuration (recipeArn
must not be specified). When false (the
default), Amazon Personalize uses recipeArn
for training.
$sel:recipeArn:Solution'
, solution_recipeArn
- The ARN of the recipe used to create the solution.
$sel:lastUpdatedDateTime:Solution'
, solution_lastUpdatedDateTime
- The date and time (in Unix time) that the solution was last updated.
$sel:eventType:Solution'
, solution_eventType
- The event type (for example, 'click' or 'like') that is used for
training the model. If no eventType
is provided, Amazon Personalize
uses all interactions for training with equal weight regardless of type.
$sel:name:Solution'
, solution_name
- The name of the solution.
$sel:autoMLResult:Solution'
, solution_autoMLResult
- When performAutoML
is true, specifies the best recipe found.
$sel:creationDateTime:Solution'
, solution_creationDateTime
- The creation date and time (in Unix time) of the solution.
$sel:datasetGroupArn:Solution'
, solution_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that provides the
training data.
$sel:latestSolutionVersion:Solution'
, solution_latestSolutionVersion
- Describes the latest version of the solution, including the status and
the ARN.
$sel:solutionConfig:Solution'
, solution_solutionConfig
- Describes the configuration properties for the solution.
$sel:performHPO:Solution'
, solution_performHPO
- Whether to perform hyperparameter optimization (HPO) on the chosen
recipe. The default is false
.
solution_status :: Lens' Solution (Maybe Text) Source #
The status of the solution.
A solution can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
solution_performAutoML :: Lens' Solution (Maybe Bool) Source #
When true, Amazon Personalize performs a search for the best
USER_PERSONALIZATION recipe from the list specified in the solution
configuration (recipeArn
must not be specified). When false (the
default), Amazon Personalize uses recipeArn
for training.
solution_recipeArn :: Lens' Solution (Maybe Text) Source #
The ARN of the recipe used to create the solution.
solution_lastUpdatedDateTime :: Lens' Solution (Maybe UTCTime) Source #
The date and time (in Unix time) that the solution was last updated.
solution_eventType :: Lens' Solution (Maybe Text) Source #
The event type (for example, 'click' or 'like') that is used for
training the model. If no eventType
is provided, Amazon Personalize
uses all interactions for training with equal weight regardless of type.
solution_autoMLResult :: Lens' Solution (Maybe AutoMLResult) Source #
When performAutoML
is true, specifies the best recipe found.
solution_creationDateTime :: Lens' Solution (Maybe UTCTime) Source #
The creation date and time (in Unix time) of the solution.
solution_datasetGroupArn :: Lens' Solution (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
solution_latestSolutionVersion :: Lens' Solution (Maybe SolutionVersionSummary) Source #
Describes the latest version of the solution, including the status and the ARN.
solution_solutionConfig :: Lens' Solution (Maybe SolutionConfig) Source #
Describes the configuration properties for the solution.
solution_performHPO :: Lens' Solution (Maybe Bool) Source #
Whether to perform hyperparameter optimization (HPO) on the chosen
recipe. The default is false
.
SolutionConfig
data SolutionConfig Source #
Describes the configuration properties for the solution.
See: newSolutionConfig
smart constructor.
SolutionConfig' | |
|
Instances
newSolutionConfig :: SolutionConfig Source #
Create a value of SolutionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureTransformationParameters:SolutionConfig'
, solutionConfig_featureTransformationParameters
- Lists the feature transformation parameters.
$sel:hpoConfig:SolutionConfig'
, solutionConfig_hpoConfig
- Describes the properties for hyperparameter optimization (HPO).
$sel:eventValueThreshold:SolutionConfig'
, solutionConfig_eventValueThreshold
- Only events with a value greater than or equal to this threshold are
used for training a model.
$sel:autoMLConfig:SolutionConfig'
, solutionConfig_autoMLConfig
- The AutoMLConfig object containing a list of recipes to search when
AutoML is performed.
$sel:algorithmHyperParameters:SolutionConfig'
, solutionConfig_algorithmHyperParameters
- Lists the hyperparameter names and ranges.
$sel:optimizationObjective:SolutionConfig'
, solutionConfig_optimizationObjective
- Describes the additional objective for the solution, such as maximizing
streaming minutes or increasing revenue. For more information see
Optimizing a solution.
solutionConfig_featureTransformationParameters :: Lens' SolutionConfig (Maybe (HashMap Text Text)) Source #
Lists the feature transformation parameters.
solutionConfig_hpoConfig :: Lens' SolutionConfig (Maybe HPOConfig) Source #
Describes the properties for hyperparameter optimization (HPO).
solutionConfig_eventValueThreshold :: Lens' SolutionConfig (Maybe Text) Source #
Only events with a value greater than or equal to this threshold are used for training a model.
solutionConfig_autoMLConfig :: Lens' SolutionConfig (Maybe AutoMLConfig) Source #
The AutoMLConfig object containing a list of recipes to search when AutoML is performed.
solutionConfig_algorithmHyperParameters :: Lens' SolutionConfig (Maybe (HashMap Text Text)) Source #
Lists the hyperparameter names and ranges.
solutionConfig_optimizationObjective :: Lens' SolutionConfig (Maybe OptimizationObjective) Source #
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see Optimizing a solution.
SolutionSummary
data SolutionSummary Source #
Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
See: newSolutionSummary
smart constructor.
SolutionSummary' | |
|
Instances
newSolutionSummary :: SolutionSummary Source #
Create a value of SolutionSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:solutionArn:SolutionSummary'
, solutionSummary_solutionArn
- The Amazon Resource Name (ARN) of the solution.
$sel:status:SolutionSummary'
, solutionSummary_status
- The status of the solution.
A solution can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
$sel:lastUpdatedDateTime:SolutionSummary'
, solutionSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the solution was last updated.
$sel:name:SolutionSummary'
, solutionSummary_name
- The name of the solution.
$sel:creationDateTime:SolutionSummary'
, solutionSummary_creationDateTime
- The date and time (in Unix time) that the solution was created.
solutionSummary_solutionArn :: Lens' SolutionSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the solution.
solutionSummary_status :: Lens' SolutionSummary (Maybe Text) Source #
The status of the solution.
A solution can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
solutionSummary_lastUpdatedDateTime :: Lens' SolutionSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the solution was last updated.
solutionSummary_name :: Lens' SolutionSummary (Maybe Text) Source #
The name of the solution.
solutionSummary_creationDateTime :: Lens' SolutionSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the solution was created.
SolutionVersion
data SolutionVersion Source #
An object that provides information about a specific version of a Solution.
See: newSolutionVersion
smart constructor.
SolutionVersion' | |
|
Instances
newSolutionVersion :: SolutionVersion Source #
Create a value of SolutionVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:SolutionVersion'
, solutionVersion_failureReason
- If training a solution version fails, the reason for the failure.
$sel:solutionArn:SolutionVersion'
, solutionVersion_solutionArn
- The ARN of the solution.
$sel:status:SolutionVersion'
, solutionVersion_status
- The status of the solution version.
A solution version can be in one of the following states:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
- CREATE STOPPING
- CREATE STOPPED
$sel:performAutoML:SolutionVersion'
, solutionVersion_performAutoML
- When true, Amazon Personalize searches for the most optimal recipe
according to the solution configuration. When false (the default),
Amazon Personalize uses recipeArn
.
$sel:tunedHPOParams:SolutionVersion'
, solutionVersion_tunedHPOParams
- If hyperparameter optimization was performed, contains the
hyperparameter values of the best performing model.
$sel:recipeArn:SolutionVersion'
, solutionVersion_recipeArn
- The ARN of the recipe used in the solution.
$sel:lastUpdatedDateTime:SolutionVersion'
, solutionVersion_lastUpdatedDateTime
- The date and time (in Unix time) that the solution was last updated.
$sel:eventType:SolutionVersion'
, solutionVersion_eventType
- The event type (for example, 'click' or 'like') that is used for
training the model.
$sel:creationDateTime:SolutionVersion'
, solutionVersion_creationDateTime
- The date and time (in Unix time) that this version of the solution was
created.
$sel:datasetGroupArn:SolutionVersion'
, solutionVersion_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group providing the
training data.
$sel:trainingMode:SolutionVersion'
, solutionVersion_trainingMode
- The scope of training to be performed when creating the solution
version. The FULL
option trains the solution version based on the
entirety of the input solution's training data, while the UPDATE
option processes only the data that has changed in comparison to the
input solution. Choose UPDATE
when you want to incrementally update
your solution version instead of creating an entirely new one.
The UPDATE
option can only be used when you already have an active
solution version created from the input solution using the FULL
option
and the input solution was trained with the
User-Personalization
recipe or the
HRNN-Coldstart
recipe.
$sel:trainingHours:SolutionVersion'
, solutionVersion_trainingHours
- The time used to train the model. You are billed for the time it takes
to train a model. This field is visible only after Amazon Personalize
successfully trains a model.
$sel:solutionConfig:SolutionVersion'
, solutionVersion_solutionConfig
- Describes the configuration properties for the solution.
$sel:performHPO:SolutionVersion'
, solutionVersion_performHPO
- Whether to perform hyperparameter optimization (HPO) on the chosen
recipe. The default is false
.
$sel:solutionVersionArn:SolutionVersion'
, solutionVersion_solutionVersionArn
- The ARN of the solution version.
solutionVersion_failureReason :: Lens' SolutionVersion (Maybe Text) Source #
If training a solution version fails, the reason for the failure.
solutionVersion_solutionArn :: Lens' SolutionVersion (Maybe Text) Source #
The ARN of the solution.
solutionVersion_status :: Lens' SolutionVersion (Maybe Text) Source #
The status of the solution version.
A solution version can be in one of the following states:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
- CREATE STOPPING
- CREATE STOPPED
solutionVersion_performAutoML :: Lens' SolutionVersion (Maybe Bool) Source #
When true, Amazon Personalize searches for the most optimal recipe
according to the solution configuration. When false (the default),
Amazon Personalize uses recipeArn
.
solutionVersion_tunedHPOParams :: Lens' SolutionVersion (Maybe TunedHPOParams) Source #
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
solutionVersion_recipeArn :: Lens' SolutionVersion (Maybe Text) Source #
The ARN of the recipe used in the solution.
solutionVersion_lastUpdatedDateTime :: Lens' SolutionVersion (Maybe UTCTime) Source #
The date and time (in Unix time) that the solution was last updated.
solutionVersion_eventType :: Lens' SolutionVersion (Maybe Text) Source #
The event type (for example, 'click' or 'like') that is used for training the model.
solutionVersion_creationDateTime :: Lens' SolutionVersion (Maybe UTCTime) Source #
The date and time (in Unix time) that this version of the solution was created.
solutionVersion_datasetGroupArn :: Lens' SolutionVersion (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group providing the training data.
solutionVersion_trainingMode :: Lens' SolutionVersion (Maybe TrainingMode) Source #
The scope of training to be performed when creating the solution
version. The FULL
option trains the solution version based on the
entirety of the input solution's training data, while the UPDATE
option processes only the data that has changed in comparison to the
input solution. Choose UPDATE
when you want to incrementally update
your solution version instead of creating an entirely new one.
The UPDATE
option can only be used when you already have an active
solution version created from the input solution using the FULL
option
and the input solution was trained with the
User-Personalization
recipe or the
HRNN-Coldstart
recipe.
solutionVersion_trainingHours :: Lens' SolutionVersion (Maybe Double) Source #
The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
solutionVersion_solutionConfig :: Lens' SolutionVersion (Maybe SolutionConfig) Source #
Describes the configuration properties for the solution.
solutionVersion_performHPO :: Lens' SolutionVersion (Maybe Bool) Source #
Whether to perform hyperparameter optimization (HPO) on the chosen
recipe. The default is false
.
solutionVersion_solutionVersionArn :: Lens' SolutionVersion (Maybe Text) Source #
The ARN of the solution version.
SolutionVersionSummary
data SolutionVersionSummary Source #
Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
See: newSolutionVersionSummary
smart constructor.
SolutionVersionSummary' | |
|
Instances
newSolutionVersionSummary :: SolutionVersionSummary Source #
Create a value of SolutionVersionSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:SolutionVersionSummary'
, solutionVersionSummary_failureReason
- If a solution version fails, the reason behind the failure.
$sel:status:SolutionVersionSummary'
, solutionVersionSummary_status
- The status of the solution version.
A solution version can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
$sel:lastUpdatedDateTime:SolutionVersionSummary'
, solutionVersionSummary_lastUpdatedDateTime
- The date and time (in Unix time) that the solution version was last
updated.
$sel:creationDateTime:SolutionVersionSummary'
, solutionVersionSummary_creationDateTime
- The date and time (in Unix time) that this version of a solution was
created.
$sel:solutionVersionArn:SolutionVersionSummary'
, solutionVersionSummary_solutionVersionArn
- The Amazon Resource Name (ARN) of the solution version.
solutionVersionSummary_failureReason :: Lens' SolutionVersionSummary (Maybe Text) Source #
If a solution version fails, the reason behind the failure.
solutionVersionSummary_status :: Lens' SolutionVersionSummary (Maybe Text) Source #
The status of the solution version.
A solution version can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
solutionVersionSummary_lastUpdatedDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that the solution version was last updated.
solutionVersionSummary_creationDateTime :: Lens' SolutionVersionSummary (Maybe UTCTime) Source #
The date and time (in Unix time) that this version of a solution was created.
solutionVersionSummary_solutionVersionArn :: Lens' SolutionVersionSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the solution version.
TunedHPOParams
data TunedHPOParams Source #
If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
See: newTunedHPOParams
smart constructor.
TunedHPOParams' | |
|
Instances
newTunedHPOParams :: TunedHPOParams Source #
Create a value of TunedHPOParams
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmHyperParameters:TunedHPOParams'
, tunedHPOParams_algorithmHyperParameters
- A list of the hyperparameter values of the best performing model.
tunedHPOParams_algorithmHyperParameters :: Lens' TunedHPOParams (Maybe (HashMap Text Text)) Source #
A list of the hyperparameter values of the best performing model.