| 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 |
Amazonka.Personalize
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListDatasetGroups (Paginated)
- CreateBatchInferenceJob
- CreateFilter
- CreateDatasetImportJob
- DescribeSolution
- DescribeDatasetExportJob
- DeleteCampaign
- UpdateCampaign
- ListCampaigns (Paginated)
- DescribeDataset
- CreateSolutionVersion
- StopSolutionVersionCreation
- CreateCampaign
- DescribeFilter
- ListEventTrackers (Paginated)
- CreateDatasetExportJob
- CreateSolution
- DeleteEventTracker
- DescribeDatasetImportJob
- ListSchemas (Paginated)
- CreateEventTracker
- DeleteSolution
- DescribeCampaign
- DeleteDataset
- CreateDataset
- DescribeSolutionVersion
- DescribeEventTracker
- ListDatasetImportJobs (Paginated)
- DeleteFilter
- ListBatchInferenceJobs (Paginated)
- ListFilters (Paginated)
- DeleteDatasetGroup
- DescribeSchema
- DescribeAlgorithm
- ListSolutionVersions (Paginated)
- DescribeBatchInferenceJob
- CreateSchema
- DescribeRecipe
- ListSolutions (Paginated)
- ListDatasetExportJobs (Paginated)
- DescribeDatasetGroup
- DescribeFeatureTransformation
- GetSolutionMetrics
- DeleteSchema
- ListDatasets (Paginated)
- CreateDatasetGroup
- ListRecipes (Paginated)
- Types
- 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
Description
Derived from API version 2018-05-22 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
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
- data ListDatasetGroups = ListDatasetGroups' (Maybe Text) (Maybe Natural)
- newListDatasetGroups :: ListDatasetGroups
- data ListDatasetGroupsResponse = ListDatasetGroupsResponse' (Maybe Text) (Maybe [DatasetGroupSummary]) Int
- newListDatasetGroupsResponse :: Int -> ListDatasetGroupsResponse
- data CreateBatchInferenceJob = CreateBatchInferenceJob' (Maybe Int) (Maybe BatchInferenceJobConfig) (Maybe Text) Text Text BatchInferenceJobInput BatchInferenceJobOutput Text
- newCreateBatchInferenceJob :: Text -> Text -> BatchInferenceJobInput -> BatchInferenceJobOutput -> Text -> CreateBatchInferenceJob
- data CreateBatchInferenceJobResponse = CreateBatchInferenceJobResponse' (Maybe Text) Int
- newCreateBatchInferenceJobResponse :: Int -> CreateBatchInferenceJobResponse
- data CreateFilter = CreateFilter' Text Text (Sensitive Text)
- newCreateFilter :: Text -> Text -> Text -> CreateFilter
- data CreateFilterResponse = CreateFilterResponse' (Maybe Text) Int
- newCreateFilterResponse :: Int -> CreateFilterResponse
- data CreateDatasetImportJob = CreateDatasetImportJob' Text Text DataSource Text
- newCreateDatasetImportJob :: Text -> Text -> DataSource -> Text -> CreateDatasetImportJob
- data CreateDatasetImportJobResponse = CreateDatasetImportJobResponse' (Maybe Text) Int
- newCreateDatasetImportJobResponse :: Int -> CreateDatasetImportJobResponse
- data DescribeSolution = DescribeSolution' Text
- newDescribeSolution :: Text -> DescribeSolution
- data DescribeSolutionResponse = DescribeSolutionResponse' (Maybe Solution) Int
- newDescribeSolutionResponse :: Int -> DescribeSolutionResponse
- data DescribeDatasetExportJob = DescribeDatasetExportJob' Text
- newDescribeDatasetExportJob :: Text -> DescribeDatasetExportJob
- data DescribeDatasetExportJobResponse = DescribeDatasetExportJobResponse' (Maybe DatasetExportJob) Int
- newDescribeDatasetExportJobResponse :: Int -> DescribeDatasetExportJobResponse
- data DeleteCampaign = DeleteCampaign' Text
- newDeleteCampaign :: Text -> DeleteCampaign
- data DeleteCampaignResponse = DeleteCampaignResponse' {
- newDeleteCampaignResponse :: DeleteCampaignResponse
- data UpdateCampaign = UpdateCampaign' (Maybe CampaignConfig) (Maybe Natural) (Maybe Text) Text
- newUpdateCampaign :: Text -> UpdateCampaign
- data UpdateCampaignResponse = UpdateCampaignResponse' (Maybe Text) Int
- newUpdateCampaignResponse :: Int -> UpdateCampaignResponse
- data ListCampaigns = ListCampaigns' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListCampaigns :: ListCampaigns
- data ListCampaignsResponse = ListCampaignsResponse' (Maybe [CampaignSummary]) (Maybe Text) Int
- newListCampaignsResponse :: Int -> ListCampaignsResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe Dataset) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data CreateSolutionVersion = CreateSolutionVersion' (Maybe TrainingMode) Text
- newCreateSolutionVersion :: Text -> CreateSolutionVersion
- data CreateSolutionVersionResponse = CreateSolutionVersionResponse' (Maybe Text) Int
- newCreateSolutionVersionResponse :: Int -> CreateSolutionVersionResponse
- data StopSolutionVersionCreation = StopSolutionVersionCreation' Text
- newStopSolutionVersionCreation :: Text -> StopSolutionVersionCreation
- data StopSolutionVersionCreationResponse = StopSolutionVersionCreationResponse' {
- newStopSolutionVersionCreationResponse :: StopSolutionVersionCreationResponse
- data CreateCampaign = CreateCampaign' (Maybe CampaignConfig) (Maybe Natural) Text Text
- newCreateCampaign :: Text -> Text -> CreateCampaign
- data CreateCampaignResponse = CreateCampaignResponse' (Maybe Text) Int
- newCreateCampaignResponse :: Int -> CreateCampaignResponse
- data DescribeFilter = DescribeFilter' Text
- newDescribeFilter :: Text -> DescribeFilter
- data DescribeFilterResponse = DescribeFilterResponse' (Maybe Filter) Int
- newDescribeFilterResponse :: Int -> DescribeFilterResponse
- data ListEventTrackers = ListEventTrackers' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListEventTrackers :: ListEventTrackers
- data ListEventTrackersResponse = ListEventTrackersResponse' (Maybe [EventTrackerSummary]) (Maybe Text) Int
- newListEventTrackersResponse :: Int -> ListEventTrackersResponse
- data CreateDatasetExportJob = CreateDatasetExportJob' (Maybe IngestionMode) Text Text Text DatasetExportJobOutput
- newCreateDatasetExportJob :: Text -> Text -> Text -> DatasetExportJobOutput -> CreateDatasetExportJob
- data CreateDatasetExportJobResponse = CreateDatasetExportJobResponse' (Maybe Text) Int
- newCreateDatasetExportJobResponse :: Int -> CreateDatasetExportJobResponse
- data CreateSolution = CreateSolution' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe SolutionConfig) (Maybe Bool) Text Text
- newCreateSolution :: Text -> Text -> CreateSolution
- data CreateSolutionResponse = CreateSolutionResponse' (Maybe Text) Int
- newCreateSolutionResponse :: Int -> CreateSolutionResponse
- data DeleteEventTracker = DeleteEventTracker' Text
- newDeleteEventTracker :: Text -> DeleteEventTracker
- data DeleteEventTrackerResponse = DeleteEventTrackerResponse' {
- newDeleteEventTrackerResponse :: DeleteEventTrackerResponse
- data DescribeDatasetImportJob = DescribeDatasetImportJob' Text
- newDescribeDatasetImportJob :: Text -> DescribeDatasetImportJob
- data DescribeDatasetImportJobResponse = DescribeDatasetImportJobResponse' (Maybe DatasetImportJob) Int
- newDescribeDatasetImportJobResponse :: Int -> DescribeDatasetImportJobResponse
- data ListSchemas = ListSchemas' (Maybe Text) (Maybe Natural)
- newListSchemas :: ListSchemas
- data ListSchemasResponse = ListSchemasResponse' (Maybe [DatasetSchemaSummary]) (Maybe Text) Int
- newListSchemasResponse :: Int -> ListSchemasResponse
- data CreateEventTracker = CreateEventTracker' Text Text
- newCreateEventTracker :: Text -> Text -> CreateEventTracker
- data CreateEventTrackerResponse = CreateEventTrackerResponse' (Maybe Text) (Maybe Text) Int
- newCreateEventTrackerResponse :: Int -> CreateEventTrackerResponse
- data DeleteSolution = DeleteSolution' Text
- newDeleteSolution :: Text -> DeleteSolution
- data DeleteSolutionResponse = DeleteSolutionResponse' {
- newDeleteSolutionResponse :: DeleteSolutionResponse
- data DescribeCampaign = DescribeCampaign' Text
- newDescribeCampaign :: Text -> DescribeCampaign
- data DescribeCampaignResponse = DescribeCampaignResponse' (Maybe Campaign) Int
- newDescribeCampaignResponse :: Int -> DescribeCampaignResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' {
- newDeleteDatasetResponse :: DeleteDatasetResponse
- data CreateDataset = CreateDataset' Text Text Text Text
- newCreateDataset :: Text -> Text -> Text -> Text -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe Text) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data DescribeSolutionVersion = DescribeSolutionVersion' Text
- newDescribeSolutionVersion :: Text -> DescribeSolutionVersion
- data DescribeSolutionVersionResponse = DescribeSolutionVersionResponse' (Maybe SolutionVersion) Int
- newDescribeSolutionVersionResponse :: Int -> DescribeSolutionVersionResponse
- data DescribeEventTracker = DescribeEventTracker' Text
- newDescribeEventTracker :: Text -> DescribeEventTracker
- data DescribeEventTrackerResponse = DescribeEventTrackerResponse' (Maybe EventTracker) Int
- newDescribeEventTrackerResponse :: Int -> DescribeEventTrackerResponse
- data ListDatasetImportJobs = ListDatasetImportJobs' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListDatasetImportJobs :: ListDatasetImportJobs
- data ListDatasetImportJobsResponse = ListDatasetImportJobsResponse' (Maybe [DatasetImportJobSummary]) (Maybe Text) Int
- newListDatasetImportJobsResponse :: Int -> ListDatasetImportJobsResponse
- data DeleteFilter = DeleteFilter' Text
- newDeleteFilter :: Text -> DeleteFilter
- data DeleteFilterResponse = DeleteFilterResponse' {
- newDeleteFilterResponse :: DeleteFilterResponse
- data ListBatchInferenceJobs = ListBatchInferenceJobs' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListBatchInferenceJobs :: ListBatchInferenceJobs
- data ListBatchInferenceJobsResponse = ListBatchInferenceJobsResponse' (Maybe [BatchInferenceJobSummary]) (Maybe Text) Int
- newListBatchInferenceJobsResponse :: Int -> ListBatchInferenceJobsResponse
- data ListFilters = ListFilters' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListFilters :: ListFilters
- data ListFiltersResponse = ListFiltersResponse' (Maybe [FilterSummary]) (Maybe Text) Int
- newListFiltersResponse :: Int -> ListFiltersResponse
- data DeleteDatasetGroup = DeleteDatasetGroup' Text
- newDeleteDatasetGroup :: Text -> DeleteDatasetGroup
- data DeleteDatasetGroupResponse = DeleteDatasetGroupResponse' {
- newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse
- data DescribeSchema = DescribeSchema' Text
- newDescribeSchema :: Text -> DescribeSchema
- data DescribeSchemaResponse = DescribeSchemaResponse' (Maybe DatasetSchema) Int
- newDescribeSchemaResponse :: Int -> DescribeSchemaResponse
- data DescribeAlgorithm = DescribeAlgorithm' Text
- newDescribeAlgorithm :: Text -> DescribeAlgorithm
- data DescribeAlgorithmResponse = DescribeAlgorithmResponse' (Maybe Algorithm) Int
- newDescribeAlgorithmResponse :: Int -> DescribeAlgorithmResponse
- data ListSolutionVersions = ListSolutionVersions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListSolutionVersions :: ListSolutionVersions
- data ListSolutionVersionsResponse = ListSolutionVersionsResponse' (Maybe Text) (Maybe [SolutionVersionSummary]) Int
- newListSolutionVersionsResponse :: Int -> ListSolutionVersionsResponse
- data DescribeBatchInferenceJob = DescribeBatchInferenceJob' Text
- newDescribeBatchInferenceJob :: Text -> DescribeBatchInferenceJob
- data DescribeBatchInferenceJobResponse = DescribeBatchInferenceJobResponse' (Maybe BatchInferenceJob) Int
- newDescribeBatchInferenceJobResponse :: Int -> DescribeBatchInferenceJobResponse
- data CreateSchema = CreateSchema' Text Text
- newCreateSchema :: Text -> Text -> CreateSchema
- data CreateSchemaResponse = CreateSchemaResponse' (Maybe Text) Int
- newCreateSchemaResponse :: Int -> CreateSchemaResponse
- data DescribeRecipe = DescribeRecipe' Text
- newDescribeRecipe :: Text -> DescribeRecipe
- data DescribeRecipeResponse = DescribeRecipeResponse' (Maybe Recipe) Int
- newDescribeRecipeResponse :: Int -> DescribeRecipeResponse
- data ListSolutions = ListSolutions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListSolutions :: ListSolutions
- data ListSolutionsResponse = ListSolutionsResponse' (Maybe Text) (Maybe [SolutionSummary]) Int
- newListSolutionsResponse :: Int -> ListSolutionsResponse
- data ListDatasetExportJobs = ListDatasetExportJobs' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListDatasetExportJobs :: ListDatasetExportJobs
- data ListDatasetExportJobsResponse = ListDatasetExportJobsResponse' (Maybe Text) (Maybe [DatasetExportJobSummary]) Int
- newListDatasetExportJobsResponse :: Int -> ListDatasetExportJobsResponse
- data DescribeDatasetGroup = DescribeDatasetGroup' Text
- newDescribeDatasetGroup :: Text -> DescribeDatasetGroup
- data DescribeDatasetGroupResponse = DescribeDatasetGroupResponse' (Maybe DatasetGroup) Int
- newDescribeDatasetGroupResponse :: Int -> DescribeDatasetGroupResponse
- data DescribeFeatureTransformation = DescribeFeatureTransformation' Text
- newDescribeFeatureTransformation :: Text -> DescribeFeatureTransformation
- data DescribeFeatureTransformationResponse = DescribeFeatureTransformationResponse' (Maybe FeatureTransformation) Int
- newDescribeFeatureTransformationResponse :: Int -> DescribeFeatureTransformationResponse
- data GetSolutionMetrics = GetSolutionMetrics' Text
- newGetSolutionMetrics :: Text -> GetSolutionMetrics
- data GetSolutionMetricsResponse = GetSolutionMetricsResponse' (Maybe (HashMap Text Double)) (Maybe Text) Int
- newGetSolutionMetricsResponse :: Int -> GetSolutionMetricsResponse
- data DeleteSchema = DeleteSchema' Text
- newDeleteSchema :: Text -> DeleteSchema
- data DeleteSchemaResponse = DeleteSchemaResponse' {
- newDeleteSchemaResponse :: DeleteSchemaResponse
- data ListDatasets = ListDatasets' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Text) (Maybe [DatasetSummary]) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data CreateDatasetGroup = CreateDatasetGroup' (Maybe Text) (Maybe Text) Text
- newCreateDatasetGroup :: Text -> CreateDatasetGroup
- data CreateDatasetGroupResponse = CreateDatasetGroupResponse' (Maybe Text) Int
- newCreateDatasetGroupResponse :: Int -> CreateDatasetGroupResponse
- data ListRecipes = ListRecipes' (Maybe Text) (Maybe Natural) (Maybe RecipeProvider)
- newListRecipes :: ListRecipes
- data ListRecipesResponse = ListRecipesResponse' (Maybe Text) (Maybe [RecipeSummary]) Int
- newListRecipesResponse :: Int -> ListRecipesResponse
- 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' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe DefaultHyperParameterRanges) (Maybe AlgorithmImage) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe Text)
- newAlgorithm :: Algorithm
- data AlgorithmImage = AlgorithmImage' (Maybe Text) Text
- newAlgorithmImage :: Text -> AlgorithmImage
- data AutoMLConfig = AutoMLConfig' (Maybe [Text]) (Maybe Text)
- newAutoMLConfig :: AutoMLConfig
- data AutoMLResult = AutoMLResult' (Maybe Text)
- newAutoMLResult :: AutoMLResult
- data BatchInferenceJob = BatchInferenceJob' (Maybe Text) (Maybe Text) (Maybe BatchInferenceJobOutput) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe BatchInferenceJobConfig) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe BatchInferenceJobInput)
- newBatchInferenceJob :: BatchInferenceJob
- data BatchInferenceJobConfig = BatchInferenceJobConfig' (Maybe (HashMap Text Text))
- newBatchInferenceJobConfig :: BatchInferenceJobConfig
- data BatchInferenceJobInput = BatchInferenceJobInput' S3DataConfig
- newBatchInferenceJobInput :: S3DataConfig -> BatchInferenceJobInput
- data BatchInferenceJobOutput = BatchInferenceJobOutput' S3DataConfig
- newBatchInferenceJobOutput :: S3DataConfig -> BatchInferenceJobOutput
- data BatchInferenceJobSummary = BatchInferenceJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newBatchInferenceJobSummary :: BatchInferenceJobSummary
- data Campaign = Campaign' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CampaignConfig) (Maybe CampaignUpdateSummary) (Maybe Text) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newCampaign :: Campaign
- data CampaignConfig = CampaignConfig' (Maybe (HashMap Text Text))
- newCampaignConfig :: CampaignConfig
- data CampaignSummary = CampaignSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newCampaignSummary :: CampaignSummary
- data CampaignUpdateSummary = CampaignUpdateSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CampaignConfig) (Maybe Natural) (Maybe POSIX) (Maybe Text)
- newCampaignUpdateSummary :: CampaignUpdateSummary
- data CategoricalHyperParameterRange = CategoricalHyperParameterRange' (Maybe [Text]) (Maybe Text)
- newCategoricalHyperParameterRange :: CategoricalHyperParameterRange
- data ContinuousHyperParameterRange = ContinuousHyperParameterRange' (Maybe Double) (Maybe Text) (Maybe Double)
- newContinuousHyperParameterRange :: ContinuousHyperParameterRange
- data DataSource = DataSource' (Maybe Text)
- newDataSource :: DataSource
- data Dataset = Dataset' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newDataset :: Dataset
- data DatasetExportJob = DatasetExportJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetExportJobOutput) (Maybe Text) (Maybe POSIX) (Maybe IngestionMode) (Maybe POSIX) (Maybe Text)
- newDatasetExportJob :: DatasetExportJob
- data DatasetExportJobOutput = DatasetExportJobOutput' S3DataConfig
- newDatasetExportJobOutput :: S3DataConfig -> DatasetExportJobOutput
- data DatasetExportJobSummary = DatasetExportJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newDatasetExportJobSummary :: DatasetExportJobSummary
- data DatasetGroup = DatasetGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDatasetGroup :: DatasetGroup
- data DatasetGroupSummary = DatasetGroupSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newDatasetGroupSummary :: DatasetGroupSummary
- data DatasetImportJob = DatasetImportJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe DataSource) (Maybe POSIX) (Maybe Text)
- newDatasetImportJob :: DatasetImportJob
- data DatasetImportJobSummary = DatasetImportJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newDatasetImportJobSummary :: DatasetImportJobSummary
- data DatasetSchema = DatasetSchema' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetSchema :: DatasetSchema
- data DatasetSchemaSummary = DatasetSchemaSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetSchemaSummary :: DatasetSchemaSummary
- data DatasetSummary = DatasetSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetSummary :: DatasetSummary
- data DefaultCategoricalHyperParameterRange = DefaultCategoricalHyperParameterRange' (Maybe Bool) (Maybe [Text]) (Maybe Text)
- newDefaultCategoricalHyperParameterRange :: DefaultCategoricalHyperParameterRange
- data DefaultContinuousHyperParameterRange = DefaultContinuousHyperParameterRange' (Maybe Double) (Maybe Bool) (Maybe Text) (Maybe Double)
- newDefaultContinuousHyperParameterRange :: DefaultContinuousHyperParameterRange
- data DefaultHyperParameterRanges = DefaultHyperParameterRanges' (Maybe [DefaultIntegerHyperParameterRange]) (Maybe [DefaultCategoricalHyperParameterRange]) (Maybe [DefaultContinuousHyperParameterRange])
- newDefaultHyperParameterRanges :: DefaultHyperParameterRanges
- data DefaultIntegerHyperParameterRange = DefaultIntegerHyperParameterRange' (Maybe Int) (Maybe Bool) (Maybe Text) (Maybe Int)
- newDefaultIntegerHyperParameterRange :: DefaultIntegerHyperParameterRange
- data EventTracker = EventTracker' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newEventTracker :: EventTracker
- data EventTrackerSummary = EventTrackerSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newEventTrackerSummary :: EventTrackerSummary
- data FeatureTransformation = FeatureTransformation' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text Text))
- newFeatureTransformation :: FeatureTransformation
- data Filter = Filter' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newFilter :: Filter
- data FilterSummary = FilterSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newFilterSummary :: FilterSummary
- data HPOConfig = HPOConfig' (Maybe HyperParameterRanges) (Maybe HPOResourceConfig) (Maybe HPOObjective)
- newHPOConfig :: HPOConfig
- data HPOObjective = HPOObjective' (Maybe Text) (Maybe Text) (Maybe Text)
- newHPOObjective :: HPOObjective
- data HPOResourceConfig = HPOResourceConfig' (Maybe Text) (Maybe Text)
- newHPOResourceConfig :: HPOResourceConfig
- data HyperParameterRanges = HyperParameterRanges' (Maybe [IntegerHyperParameterRange]) (Maybe [CategoricalHyperParameterRange]) (Maybe [ContinuousHyperParameterRange])
- newHyperParameterRanges :: HyperParameterRanges
- data IntegerHyperParameterRange = IntegerHyperParameterRange' (Maybe Int) (Maybe Text) (Maybe Int)
- newIntegerHyperParameterRange :: IntegerHyperParameterRange
- data OptimizationObjective = OptimizationObjective' (Maybe Text) (Maybe ObjectiveSensitivity)
- newOptimizationObjective :: OptimizationObjective
- data Recipe = Recipe' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newRecipe :: Recipe
- data RecipeSummary = RecipeSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newRecipeSummary :: RecipeSummary
- data S3DataConfig = S3DataConfig' (Maybe Text) Text
- newS3DataConfig :: Text -> S3DataConfig
- data Solution = Solution' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe AutoMLResult) (Maybe POSIX) (Maybe Text) (Maybe SolutionVersionSummary) (Maybe SolutionConfig) (Maybe Bool)
- newSolution :: Solution
- data SolutionConfig = SolutionConfig' (Maybe (HashMap Text Text)) (Maybe HPOConfig) (Maybe Text) (Maybe AutoMLConfig) (Maybe (HashMap Text Text)) (Maybe OptimizationObjective)
- newSolutionConfig :: SolutionConfig
- data SolutionSummary = SolutionSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX)
- newSolutionSummary :: SolutionSummary
- data SolutionVersion = SolutionVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe TunedHPOParams) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe TrainingMode) (Maybe Double) (Maybe SolutionConfig) (Maybe Bool) (Maybe Text)
- newSolutionVersion :: SolutionVersion
- data SolutionVersionSummary = SolutionVersionSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newSolutionVersionSummary :: SolutionVersionSummary
- data TunedHPOParams = TunedHPOParams' (Maybe (HashMap Text Text))
- newTunedHPOParams :: TunedHPOParams
Service Configuration
defaultService :: Service Source #
API version 2018-05-22 of the Amazon Personalize SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Personalize.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The token is not valid.
InvalidInputException
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Provide a valid value for the field or parameter.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Could not find the specified resource.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit on the number of requests per second has been exceeded.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource is in use.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListDatasetGroups (Paginated)
data ListDatasetGroups Source #
See: newListDatasetGroups smart constructor.
Constructors
| ListDatasetGroups' (Maybe Text) (Maybe Natural) |
Instances
newListDatasetGroups :: ListDatasetGroups Source #
Create a value of ListDatasetGroups 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:nextToken:ListDatasetGroups', listDatasetGroups_nextToken - A token returned from the previous call to ListDatasetGroups for
getting the next set of dataset groups (if they exist).
$sel:maxResults:ListDatasetGroups', listDatasetGroups_maxResults - The maximum number of dataset groups to return.
data ListDatasetGroupsResponse Source #
See: newListDatasetGroupsResponse smart constructor.
Constructors
| ListDatasetGroupsResponse' (Maybe Text) (Maybe [DatasetGroupSummary]) Int |
Instances
newListDatasetGroupsResponse Source #
Create a value of ListDatasetGroupsResponse 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:nextToken:ListDatasetGroups', listDatasetGroupsResponse_nextToken - A token for getting the next set of dataset groups (if they exist).
$sel:datasetGroups:ListDatasetGroupsResponse', listDatasetGroupsResponse_datasetGroups - The list of your dataset groups.
$sel:httpStatus:ListDatasetGroupsResponse', listDatasetGroupsResponse_httpStatus - The response's http status code.
CreateBatchInferenceJob
data CreateBatchInferenceJob Source #
See: newCreateBatchInferenceJob smart constructor.
Constructors
| CreateBatchInferenceJob' (Maybe Int) (Maybe BatchInferenceJobConfig) (Maybe Text) Text Text BatchInferenceJobInput BatchInferenceJobOutput Text |
Instances
newCreateBatchInferenceJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> BatchInferenceJobInput | |
| -> BatchInferenceJobOutput | |
| -> Text | |
| -> CreateBatchInferenceJob |
Create a value of CreateBatchInferenceJob 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:numResults:CreateBatchInferenceJob', createBatchInferenceJob_numResults - The number of recommendations to retreive.
$sel:batchInferenceJobConfig:CreateBatchInferenceJob', createBatchInferenceJob_batchInferenceJobConfig - The configuration details of a batch inference job.
$sel:filterArn:CreateBatchInferenceJob', createBatchInferenceJob_filterArn - The ARN of the filter to apply to the batch inference job. For more
information on using filters, see
Filtering Batch Recommendations..
$sel:jobName:CreateBatchInferenceJob', createBatchInferenceJob_jobName - The name of the batch inference job to create.
$sel:solutionVersionArn:CreateBatchInferenceJob', createBatchInferenceJob_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version that will be used
to generate the batch inference recommendations.
$sel:jobInput:CreateBatchInferenceJob', createBatchInferenceJob_jobInput - The Amazon S3 path that leads to the input file to base your
recommendations on. The input material must be in JSON format.
$sel:jobOutput:CreateBatchInferenceJob', createBatchInferenceJob_jobOutput - The path to the Amazon S3 bucket where the job's output will be stored.
$sel:roleArn:CreateBatchInferenceJob', createBatchInferenceJob_roleArn - The ARN of the Amazon Identity and Access Management role that has
permissions to read and write to your input and output Amazon S3 buckets
respectively.
data CreateBatchInferenceJobResponse Source #
See: newCreateBatchInferenceJobResponse smart constructor.
Constructors
| CreateBatchInferenceJobResponse' (Maybe Text) Int |
Instances
newCreateBatchInferenceJobResponse Source #
Create a value of CreateBatchInferenceJobResponse 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:batchInferenceJobArn:CreateBatchInferenceJobResponse', createBatchInferenceJobResponse_batchInferenceJobArn - The ARN of the batch inference job.
$sel:httpStatus:CreateBatchInferenceJobResponse', createBatchInferenceJobResponse_httpStatus - The response's http status code.
CreateFilter
data CreateFilter Source #
See: newCreateFilter smart constructor.
Constructors
| CreateFilter' Text Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateFilter |
Create a value of CreateFilter 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:CreateFilter', createFilter_name - The name of the filter to create.
$sel:datasetGroupArn:CreateFilter', createFilter_datasetGroupArn - The ARN of the dataset group that the filter will belong to.
$sel:filterExpression:CreateFilter', createFilter_filterExpression - The filter expression defines which items are included or excluded from
recommendations. Filter expression must follow specific format rules.
For information about filter expression structure and syntax, see
filter-expressions.
data CreateFilterResponse Source #
See: newCreateFilterResponse smart constructor.
Constructors
| CreateFilterResponse' (Maybe Text) Int |
Instances
newCreateFilterResponse Source #
Arguments
| :: Int | |
| -> CreateFilterResponse |
Create a value of CreateFilterResponse 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:filterArn:CreateFilterResponse', createFilterResponse_filterArn - The ARN of the new filter.
$sel:httpStatus:CreateFilterResponse', createFilterResponse_httpStatus - The response's http status code.
CreateDatasetImportJob
data CreateDatasetImportJob Source #
See: newCreateDatasetImportJob smart constructor.
Constructors
| CreateDatasetImportJob' Text Text DataSource Text |
Instances
newCreateDatasetImportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> DataSource | |
| -> Text | |
| -> CreateDatasetImportJob |
Create a value of CreateDatasetImportJob 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:jobName:CreateDatasetImportJob', createDatasetImportJob_jobName - The name for the dataset import job.
$sel:datasetArn:CreateDatasetImportJob', createDatasetImportJob_datasetArn - The ARN of the dataset that receives the imported data.
$sel:dataSource:CreateDatasetImportJob', createDatasetImportJob_dataSource - The Amazon S3 bucket that contains the training data to import.
$sel:roleArn:CreateDatasetImportJob', createDatasetImportJob_roleArn - The ARN of the IAM role that has permissions to read from the Amazon S3
data source.
data CreateDatasetImportJobResponse Source #
See: newCreateDatasetImportJobResponse smart constructor.
Constructors
| CreateDatasetImportJobResponse' (Maybe Text) Int |
Instances
newCreateDatasetImportJobResponse Source #
Create a value of CreateDatasetImportJobResponse 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:datasetImportJobArn:CreateDatasetImportJobResponse', createDatasetImportJobResponse_datasetImportJobArn - The ARN of the dataset import job.
$sel:httpStatus:CreateDatasetImportJobResponse', createDatasetImportJobResponse_httpStatus - The response's http status code.
DescribeSolution
data DescribeSolution Source #
See: newDescribeSolution smart constructor.
Constructors
| DescribeSolution' Text |
Instances
Arguments
| :: Text | |
| -> DescribeSolution |
Create a value of DescribeSolution 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:DescribeSolution', describeSolution_solutionArn - The Amazon Resource Name (ARN) of the solution to describe.
data DescribeSolutionResponse Source #
See: newDescribeSolutionResponse smart constructor.
Constructors
| DescribeSolutionResponse' (Maybe Solution) Int |
Instances
newDescribeSolutionResponse Source #
Create a value of DescribeSolutionResponse 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:solution:DescribeSolutionResponse', describeSolutionResponse_solution - An object that describes the solution.
$sel:httpStatus:DescribeSolutionResponse', describeSolutionResponse_httpStatus - The response's http status code.
DescribeDatasetExportJob
data DescribeDatasetExportJob Source #
See: newDescribeDatasetExportJob smart constructor.
Constructors
| DescribeDatasetExportJob' Text |
Instances
newDescribeDatasetExportJob Source #
Create a value of DescribeDatasetExportJob 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:datasetExportJobArn:DescribeDatasetExportJob', describeDatasetExportJob_datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job to describe.
data DescribeDatasetExportJobResponse Source #
See: newDescribeDatasetExportJobResponse smart constructor.
Constructors
| DescribeDatasetExportJobResponse' (Maybe DatasetExportJob) Int |
Instances
newDescribeDatasetExportJobResponse Source #
Create a value of DescribeDatasetExportJobResponse 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:datasetExportJob:DescribeDatasetExportJobResponse', describeDatasetExportJobResponse_datasetExportJob - Information about the dataset export job, including the status.
The status is one of the following values:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
$sel:httpStatus:DescribeDatasetExportJobResponse', describeDatasetExportJobResponse_httpStatus - The response's http status code.
DeleteCampaign
data DeleteCampaign Source #
See: newDeleteCampaign smart constructor.
Constructors
| DeleteCampaign' Text |
Instances
Arguments
| :: Text | |
| -> DeleteCampaign |
Create a value of DeleteCampaign 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:campaignArn:DeleteCampaign', deleteCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign to delete.
data DeleteCampaignResponse Source #
See: newDeleteCampaignResponse smart constructor.
Constructors
| DeleteCampaignResponse' | |
Instances
newDeleteCampaignResponse :: DeleteCampaignResponse Source #
Create a value of DeleteCampaignResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateCampaign
data UpdateCampaign Source #
See: newUpdateCampaign smart constructor.
Constructors
| UpdateCampaign' (Maybe CampaignConfig) (Maybe Natural) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateCampaign |
Create a value of UpdateCampaign 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:campaignConfig:UpdateCampaign', updateCampaign_campaignConfig - The configuration details of a campaign.
$sel:minProvisionedTPS:UpdateCampaign', updateCampaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support.
$sel:solutionVersionArn:UpdateCampaign', updateCampaign_solutionVersionArn - The ARN of a new solution version to deploy.
$sel:campaignArn:UpdateCampaign', updateCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.
data UpdateCampaignResponse Source #
See: newUpdateCampaignResponse smart constructor.
Constructors
| UpdateCampaignResponse' (Maybe Text) Int |
Instances
newUpdateCampaignResponse Source #
Create a value of UpdateCampaignResponse 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:campaignArn:UpdateCampaign', updateCampaignResponse_campaignArn - The same campaign ARN as given in the request.
$sel:httpStatus:UpdateCampaignResponse', updateCampaignResponse_httpStatus - The response's http status code.
ListCampaigns (Paginated)
data ListCampaigns Source #
See: newListCampaigns smart constructor.
Instances
newListCampaigns :: ListCampaigns Source #
Create a value of ListCampaigns 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:ListCampaigns', listCampaigns_solutionArn - The Amazon Resource Name (ARN) of the solution to list the campaigns
for. When a solution is not specified, all the campaigns associated with
the account are listed.
$sel:nextToken:ListCampaigns', listCampaigns_nextToken - A token returned from the previous call to ListCampaigns for getting
the next set of campaigns (if they exist).
$sel:maxResults:ListCampaigns', listCampaigns_maxResults - The maximum number of campaigns to return.
data ListCampaignsResponse Source #
See: newListCampaignsResponse smart constructor.
Constructors
| ListCampaignsResponse' (Maybe [CampaignSummary]) (Maybe Text) Int |
Instances
newListCampaignsResponse Source #
Create a value of ListCampaignsResponse 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:campaigns:ListCampaignsResponse', listCampaignsResponse_campaigns - A list of the campaigns.
$sel:nextToken:ListCampaigns', listCampaignsResponse_nextToken - A token for getting the next set of campaigns (if they exist).
$sel:httpStatus:ListCampaignsResponse', listCampaignsResponse_httpStatus - The response's http status code.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDataset |
Create a value of DescribeDataset 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:datasetArn:DescribeDataset', describeDataset_datasetArn - The Amazon Resource Name (ARN) of the dataset to describe.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' (Maybe Dataset) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse 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:dataset:DescribeDatasetResponse', describeDatasetResponse_dataset - A listing of the dataset's properties.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
CreateSolutionVersion
data CreateSolutionVersion Source #
See: newCreateSolutionVersion smart constructor.
Constructors
| CreateSolutionVersion' (Maybe TrainingMode) Text |
Instances
newCreateSolutionVersion Source #
Create a value of CreateSolutionVersion 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:trainingMode:CreateSolutionVersion', createSolutionVersion_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:solutionArn:CreateSolutionVersion', createSolutionVersion_solutionArn - The Amazon Resource Name (ARN) of the solution containing the training
configuration information.
data CreateSolutionVersionResponse Source #
See: newCreateSolutionVersionResponse smart constructor.
Constructors
| CreateSolutionVersionResponse' (Maybe Text) Int |
Instances
newCreateSolutionVersionResponse Source #
Create a value of CreateSolutionVersionResponse 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:solutionVersionArn:CreateSolutionVersionResponse', createSolutionVersionResponse_solutionVersionArn - The ARN of the new solution version.
$sel:httpStatus:CreateSolutionVersionResponse', createSolutionVersionResponse_httpStatus - The response's http status code.
StopSolutionVersionCreation
data StopSolutionVersionCreation Source #
See: newStopSolutionVersionCreation smart constructor.
Constructors
| StopSolutionVersionCreation' Text |
Instances
newStopSolutionVersionCreation Source #
Create a value of StopSolutionVersionCreation 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:solutionVersionArn:StopSolutionVersionCreation', stopSolutionVersionCreation_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version you want to stop
creating.
data StopSolutionVersionCreationResponse Source #
See: newStopSolutionVersionCreationResponse smart constructor.
Constructors
| StopSolutionVersionCreationResponse' | |
Instances
newStopSolutionVersionCreationResponse :: StopSolutionVersionCreationResponse Source #
Create a value of StopSolutionVersionCreationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateCampaign
data CreateCampaign Source #
See: newCreateCampaign smart constructor.
Constructors
| CreateCampaign' (Maybe CampaignConfig) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateCampaign |
Create a value of CreateCampaign 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:campaignConfig:CreateCampaign', createCampaign_campaignConfig - The configuration details of a campaign.
$sel:minProvisionedTPS:CreateCampaign', createCampaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions
(recommendations) per second that Amazon Personalize will support.
$sel:name:CreateCampaign', createCampaign_name - A name for the new campaign. The campaign name must be unique within
your account.
$sel:solutionVersionArn:CreateCampaign', createCampaign_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version to deploy.
data CreateCampaignResponse Source #
See: newCreateCampaignResponse smart constructor.
Constructors
| CreateCampaignResponse' (Maybe Text) Int |
Instances
newCreateCampaignResponse Source #
Create a value of CreateCampaignResponse 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:campaignArn:CreateCampaignResponse', createCampaignResponse_campaignArn - The Amazon Resource Name (ARN) of the campaign.
$sel:httpStatus:CreateCampaignResponse', createCampaignResponse_httpStatus - The response's http status code.
DescribeFilter
data DescribeFilter Source #
See: newDescribeFilter smart constructor.
Constructors
| DescribeFilter' Text |
Instances
Arguments
| :: Text | |
| -> DescribeFilter |
Create a value of DescribeFilter 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:filterArn:DescribeFilter', describeFilter_filterArn - The ARN of the filter to describe.
data DescribeFilterResponse Source #
See: newDescribeFilterResponse smart constructor.
Constructors
| DescribeFilterResponse' (Maybe Filter) Int |
Instances
newDescribeFilterResponse Source #
Create a value of DescribeFilterResponse 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:filter':DescribeFilterResponse', describeFilterResponse_filter - The filter's details.
$sel:httpStatus:DescribeFilterResponse', describeFilterResponse_httpStatus - The response's http status code.
ListEventTrackers (Paginated)
data ListEventTrackers Source #
See: newListEventTrackers smart constructor.
Instances
newListEventTrackers :: ListEventTrackers Source #
Create a value of ListEventTrackers 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:nextToken:ListEventTrackers', listEventTrackers_nextToken - A token returned from the previous call to ListEventTrackers for
getting the next set of event trackers (if they exist).
$sel:datasetGroupArn:ListEventTrackers', listEventTrackers_datasetGroupArn - The ARN of a dataset group used to filter the response.
$sel:maxResults:ListEventTrackers', listEventTrackers_maxResults - The maximum number of event trackers to return.
data ListEventTrackersResponse Source #
See: newListEventTrackersResponse smart constructor.
Constructors
| ListEventTrackersResponse' (Maybe [EventTrackerSummary]) (Maybe Text) Int |
Instances
newListEventTrackersResponse Source #
Create a value of ListEventTrackersResponse 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:eventTrackers:ListEventTrackersResponse', listEventTrackersResponse_eventTrackers - A list of event trackers.
$sel:nextToken:ListEventTrackers', listEventTrackersResponse_nextToken - A token for getting the next set of event trackers (if they exist).
$sel:httpStatus:ListEventTrackersResponse', listEventTrackersResponse_httpStatus - The response's http status code.
CreateDatasetExportJob
data CreateDatasetExportJob Source #
See: newCreateDatasetExportJob smart constructor.
Constructors
| CreateDatasetExportJob' (Maybe IngestionMode) Text Text Text DatasetExportJobOutput |
Instances
newCreateDatasetExportJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DatasetExportJobOutput | |
| -> CreateDatasetExportJob |
Create a value of CreateDatasetExportJob 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:ingestionMode:CreateDatasetExportJob', createDatasetExportJob_ingestionMode - The data to export, based on how you imported the data. You can choose
to export only BULK data that you imported using a dataset import job,
only 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:jobName:CreateDatasetExportJob', createDatasetExportJob_jobName - The name for the dataset export job.
$sel:datasetArn:CreateDatasetExportJob', createDatasetExportJob_datasetArn - The Amazon Resource Name (ARN) of the dataset that contains the data to
export.
$sel:roleArn:CreateDatasetExportJob', createDatasetExportJob_roleArn - The Amazon Resource Name (ARN) of the IAM service role that has
permissions to add data to your output Amazon S3 bucket.
$sel:jobOutput:CreateDatasetExportJob', createDatasetExportJob_jobOutput - The path to the Amazon S3 bucket where the job's output is stored.
data CreateDatasetExportJobResponse Source #
See: newCreateDatasetExportJobResponse smart constructor.
Constructors
| CreateDatasetExportJobResponse' (Maybe Text) Int |
Instances
newCreateDatasetExportJobResponse Source #
Create a value of CreateDatasetExportJobResponse 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:datasetExportJobArn:CreateDatasetExportJobResponse', createDatasetExportJobResponse_datasetExportJobArn - The Amazon Resource Name (ARN) of the dataset export job.
$sel:httpStatus:CreateDatasetExportJobResponse', createDatasetExportJobResponse_httpStatus - The response's http status code.
CreateSolution
data CreateSolution Source #
See: newCreateSolution smart constructor.
Constructors
| CreateSolution' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe SolutionConfig) (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSolution |
Create a value of CreateSolution 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:performAutoML:CreateSolution', createSolution_performAutoML - Whether to perform automated machine learning (AutoML). The default is
false. For this case, you must specify recipeArn.
When set to true, Amazon Personalize analyzes your training data and
selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In
this case, you must omit recipeArn. Amazon Personalize determines the
optimal recipe by running tests with different values for the
hyperparameters. AutoML lengthens the training process as compared to
selecting a specific recipe.
$sel:recipeArn:CreateSolution', createSolution_recipeArn - The ARN of the recipe to use for model training. Only specified when
performAutoML is false.
$sel:eventType:CreateSolution', createSolution_eventType - When your have multiple event types (using an EVENT_TYPE schema
field), this parameter specifies which event type (for example,
'click' or 'like') is used for training the model.
If you do not provide an eventType, Amazon Personalize will use all
interactions for training with equal weight regardless of type.
$sel:solutionConfig:CreateSolution', createSolution_solutionConfig - The configuration to use with the solution. When performAutoML is set
to true, Amazon Personalize only evaluates the autoMLConfig section of
the solution configuration.
Amazon Personalize doesn't support configuring the hpoObjective at
this time.
$sel:performHPO:CreateSolution', createSolution_performHPO - Whether to perform hyperparameter optimization (HPO) on the specified or
selected recipe. The default is false.
When performing AutoML, this parameter is always true and you should
not set it to false.
$sel:name:CreateSolution', createSolution_name - The name for the solution.
$sel:datasetGroupArn:CreateSolution', createSolution_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that provides the
training data.
data CreateSolutionResponse Source #
See: newCreateSolutionResponse smart constructor.
Constructors
| CreateSolutionResponse' (Maybe Text) Int |
Instances
newCreateSolutionResponse Source #
Create a value of CreateSolutionResponse 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:CreateSolutionResponse', createSolutionResponse_solutionArn - The ARN of the solution.
$sel:httpStatus:CreateSolutionResponse', createSolutionResponse_httpStatus - The response's http status code.
DeleteEventTracker
data DeleteEventTracker Source #
See: newDeleteEventTracker smart constructor.
Constructors
| DeleteEventTracker' Text |
Instances
newDeleteEventTracker Source #
Create a value of DeleteEventTracker 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:eventTrackerArn:DeleteEventTracker', deleteEventTracker_eventTrackerArn - The Amazon Resource Name (ARN) of the event tracker to delete.
data DeleteEventTrackerResponse Source #
See: newDeleteEventTrackerResponse smart constructor.
Constructors
| DeleteEventTrackerResponse' | |
Instances
newDeleteEventTrackerResponse :: DeleteEventTrackerResponse Source #
Create a value of DeleteEventTrackerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDatasetImportJob
data DescribeDatasetImportJob Source #
See: newDescribeDatasetImportJob smart constructor.
Constructors
| DescribeDatasetImportJob' Text |
Instances
newDescribeDatasetImportJob Source #
Create a value of DescribeDatasetImportJob 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:datasetImportJobArn:DescribeDatasetImportJob', describeDatasetImportJob_datasetImportJobArn - The Amazon Resource Name (ARN) of the dataset import job to describe.
data DescribeDatasetImportJobResponse Source #
See: newDescribeDatasetImportJobResponse smart constructor.
Constructors
| DescribeDatasetImportJobResponse' (Maybe DatasetImportJob) Int |
Instances
newDescribeDatasetImportJobResponse Source #
Create a value of DescribeDatasetImportJobResponse 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:datasetImportJob:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_datasetImportJob - Information about the dataset import job, including the status.
The status is one of the following values:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
$sel:httpStatus:DescribeDatasetImportJobResponse', describeDatasetImportJobResponse_httpStatus - The response's http status code.
ListSchemas (Paginated)
data ListSchemas Source #
See: newListSchemas smart constructor.
Constructors
| ListSchemas' (Maybe Text) (Maybe Natural) |
Instances
newListSchemas :: ListSchemas Source #
Create a value of ListSchemas 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:nextToken:ListSchemas', listSchemas_nextToken - A token returned from the previous call to ListSchemas for getting the
next set of schemas (if they exist).
$sel:maxResults:ListSchemas', listSchemas_maxResults - The maximum number of schemas to return.
data ListSchemasResponse Source #
See: newListSchemasResponse smart constructor.
Constructors
| ListSchemasResponse' (Maybe [DatasetSchemaSummary]) (Maybe Text) Int |
Instances
newListSchemasResponse Source #
Arguments
| :: Int | |
| -> ListSchemasResponse |
Create a value of ListSchemasResponse 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:schemas:ListSchemasResponse', listSchemasResponse_schemas - A list of schemas.
$sel:nextToken:ListSchemas', listSchemasResponse_nextToken - A token used to get the next set of schemas (if they exist).
$sel:httpStatus:ListSchemasResponse', listSchemasResponse_httpStatus - The response's http status code.
CreateEventTracker
data CreateEventTracker Source #
See: newCreateEventTracker smart constructor.
Constructors
| CreateEventTracker' Text Text |
Instances
newCreateEventTracker Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateEventTracker |
Create a value of CreateEventTracker 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:CreateEventTracker', createEventTracker_name - The name for the event tracker.
$sel:datasetGroupArn:CreateEventTracker', createEventTracker_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that receives the
event data.
data CreateEventTrackerResponse Source #
See: newCreateEventTrackerResponse smart constructor.
Instances
newCreateEventTrackerResponse Source #
Create a value of CreateEventTrackerResponse 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:trackingId:CreateEventTrackerResponse', createEventTrackerResponse_trackingId - The ID of the event tracker. Include this ID in requests to the
PutEvents
API.
$sel:eventTrackerArn:CreateEventTrackerResponse', createEventTrackerResponse_eventTrackerArn - The ARN of the event tracker.
$sel:httpStatus:CreateEventTrackerResponse', createEventTrackerResponse_httpStatus - The response's http status code.
DeleteSolution
data DeleteSolution Source #
See: newDeleteSolution smart constructor.
Constructors
| DeleteSolution' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSolution |
Create a value of DeleteSolution 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:DeleteSolution', deleteSolution_solutionArn - The ARN of the solution to delete.
data DeleteSolutionResponse Source #
See: newDeleteSolutionResponse smart constructor.
Constructors
| DeleteSolutionResponse' | |
Instances
newDeleteSolutionResponse :: DeleteSolutionResponse Source #
Create a value of DeleteSolutionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeCampaign
data DescribeCampaign Source #
See: newDescribeCampaign smart constructor.
Constructors
| DescribeCampaign' Text |
Instances
Arguments
| :: Text | |
| -> DescribeCampaign |
Create a value of DescribeCampaign 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:campaignArn:DescribeCampaign', describeCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.
data DescribeCampaignResponse Source #
See: newDescribeCampaignResponse smart constructor.
Constructors
| DescribeCampaignResponse' (Maybe Campaign) Int |
Instances
newDescribeCampaignResponse Source #
Create a value of DescribeCampaignResponse 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:campaign:DescribeCampaignResponse', describeCampaignResponse_campaign - The properties of the campaign.
$sel:httpStatus:DescribeCampaignResponse', describeCampaignResponse_httpStatus - The response's http status code.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDataset |
Create a value of DeleteDataset 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:datasetArn:DeleteDataset', deleteDataset_datasetArn - The Amazon Resource Name (ARN) of the dataset to delete.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' | |
Instances
newDeleteDatasetResponse :: DeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateDataset
data CreateDataset Source #
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' Text Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateDataset |
Create a value of CreateDataset 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:CreateDataset', createDataset_name - The name for the dataset.
$sel:schemaArn:CreateDataset', createDataset_schemaArn - The ARN of the schema to associate with the dataset. The schema defines
the dataset fields.
$sel:datasetGroupArn:CreateDataset', createDataset_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group to add the dataset
to.
$sel:datasetType:CreateDataset', createDataset_datasetType - The type of dataset.
One of the following (case insensitive) values:
- Interactions
- Items
- Users
data CreateDatasetResponse Source #
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' (Maybe Text) Int |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse 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:datasetArn:CreateDatasetResponse', createDatasetResponse_datasetArn - The ARN of the dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
DescribeSolutionVersion
data DescribeSolutionVersion Source #
See: newDescribeSolutionVersion smart constructor.
Constructors
| DescribeSolutionVersion' Text |
Instances
newDescribeSolutionVersion Source #
Create a value of DescribeSolutionVersion 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:solutionVersionArn:DescribeSolutionVersion', describeSolutionVersion_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version.
data DescribeSolutionVersionResponse Source #
See: newDescribeSolutionVersionResponse smart constructor.
Constructors
| DescribeSolutionVersionResponse' (Maybe SolutionVersion) Int |
Instances
newDescribeSolutionVersionResponse Source #
Create a value of DescribeSolutionVersionResponse 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:solutionVersion:DescribeSolutionVersionResponse', describeSolutionVersionResponse_solutionVersion - The solution version.
$sel:httpStatus:DescribeSolutionVersionResponse', describeSolutionVersionResponse_httpStatus - The response's http status code.
DescribeEventTracker
data DescribeEventTracker Source #
See: newDescribeEventTracker smart constructor.
Constructors
| DescribeEventTracker' Text |
Instances
newDescribeEventTracker Source #
Create a value of DescribeEventTracker 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:eventTrackerArn:DescribeEventTracker', describeEventTracker_eventTrackerArn - The Amazon Resource Name (ARN) of the event tracker to describe.
data DescribeEventTrackerResponse Source #
See: newDescribeEventTrackerResponse smart constructor.
Constructors
| DescribeEventTrackerResponse' (Maybe EventTracker) Int |
Instances
newDescribeEventTrackerResponse Source #
Create a value of DescribeEventTrackerResponse 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:eventTracker:DescribeEventTrackerResponse', describeEventTrackerResponse_eventTracker - An object that describes the event tracker.
$sel:httpStatus:DescribeEventTrackerResponse', describeEventTrackerResponse_httpStatus - The response's http status code.
ListDatasetImportJobs (Paginated)
data ListDatasetImportJobs Source #
See: newListDatasetImportJobs smart constructor.
Instances
newListDatasetImportJobs :: ListDatasetImportJobs Source #
Create a value of ListDatasetImportJobs 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:datasetArn:ListDatasetImportJobs', listDatasetImportJobs_datasetArn - The Amazon Resource Name (ARN) of the dataset to list the dataset import
jobs for.
$sel:nextToken:ListDatasetImportJobs', listDatasetImportJobs_nextToken - A token returned from the previous call to ListDatasetImportJobs for
getting the next set of dataset import jobs (if they exist).
$sel:maxResults:ListDatasetImportJobs', listDatasetImportJobs_maxResults - The maximum number of dataset import jobs to return.
data ListDatasetImportJobsResponse Source #
See: newListDatasetImportJobsResponse smart constructor.
Constructors
| ListDatasetImportJobsResponse' (Maybe [DatasetImportJobSummary]) (Maybe Text) Int |
Instances
newListDatasetImportJobsResponse Source #
Create a value of ListDatasetImportJobsResponse 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:datasetImportJobs:ListDatasetImportJobsResponse', listDatasetImportJobsResponse_datasetImportJobs - The list of dataset import jobs.
$sel:nextToken:ListDatasetImportJobs', listDatasetImportJobsResponse_nextToken - A token for getting the next set of dataset import jobs (if they exist).
$sel:httpStatus:ListDatasetImportJobsResponse', listDatasetImportJobsResponse_httpStatus - The response's http status code.
DeleteFilter
data DeleteFilter Source #
See: newDeleteFilter smart constructor.
Constructors
| DeleteFilter' Text |
Instances
Arguments
| :: Text | |
| -> DeleteFilter |
Create a value of DeleteFilter 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:filterArn:DeleteFilter', deleteFilter_filterArn - The ARN of the filter to delete.
data DeleteFilterResponse Source #
See: newDeleteFilterResponse smart constructor.
Constructors
| DeleteFilterResponse' | |
Instances
newDeleteFilterResponse :: DeleteFilterResponse Source #
Create a value of DeleteFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListBatchInferenceJobs (Paginated)
data ListBatchInferenceJobs Source #
See: newListBatchInferenceJobs smart constructor.
Instances
newListBatchInferenceJobs :: ListBatchInferenceJobs Source #
Create a value of ListBatchInferenceJobs 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:nextToken:ListBatchInferenceJobs', listBatchInferenceJobs_nextToken - The token to request the next page of results.
$sel:maxResults:ListBatchInferenceJobs', listBatchInferenceJobs_maxResults - The maximum number of batch inference job results to return in each
page. The default value is 100.
$sel:solutionVersionArn:ListBatchInferenceJobs', listBatchInferenceJobs_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version from which the
batch inference jobs were created.
data ListBatchInferenceJobsResponse Source #
See: newListBatchInferenceJobsResponse smart constructor.
Constructors
| ListBatchInferenceJobsResponse' (Maybe [BatchInferenceJobSummary]) (Maybe Text) Int |
Instances
newListBatchInferenceJobsResponse Source #
Create a value of ListBatchInferenceJobsResponse 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:batchInferenceJobs:ListBatchInferenceJobsResponse', listBatchInferenceJobsResponse_batchInferenceJobs - A list containing information on each job that is returned.
$sel:nextToken:ListBatchInferenceJobs', listBatchInferenceJobsResponse_nextToken - The token to use to retrieve the next page of results. The value is
null when there are no more results to return.
$sel:httpStatus:ListBatchInferenceJobsResponse', listBatchInferenceJobsResponse_httpStatus - The response's http status code.
ListFilters (Paginated)
data ListFilters Source #
See: newListFilters smart constructor.
Instances
newListFilters :: ListFilters Source #
Create a value of ListFilters 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:nextToken:ListFilters', listFilters_nextToken - A token returned from the previous call to ListFilters for getting the
next set of filters (if they exist).
$sel:datasetGroupArn:ListFilters', listFilters_datasetGroupArn - The ARN of the dataset group that contains the filters.
$sel:maxResults:ListFilters', listFilters_maxResults - The maximum number of filters to return.
data ListFiltersResponse Source #
See: newListFiltersResponse smart constructor.
Constructors
| ListFiltersResponse' (Maybe [FilterSummary]) (Maybe Text) Int |
Instances
newListFiltersResponse Source #
Arguments
| :: Int | |
| -> ListFiltersResponse |
Create a value of ListFiltersResponse 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:filters:ListFiltersResponse', listFiltersResponse_filters - A list of returned filters.
$sel:nextToken:ListFilters', listFiltersResponse_nextToken - A token for getting the next set of filters (if they exist).
$sel:httpStatus:ListFiltersResponse', listFiltersResponse_httpStatus - The response's http status code.
DeleteDatasetGroup
data DeleteDatasetGroup Source #
See: newDeleteDatasetGroup smart constructor.
Constructors
| DeleteDatasetGroup' Text |
Instances
newDeleteDatasetGroup Source #
Create a value of DeleteDatasetGroup 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:datasetGroupArn:DeleteDatasetGroup', deleteDatasetGroup_datasetGroupArn - The ARN of the dataset group to delete.
data DeleteDatasetGroupResponse Source #
See: newDeleteDatasetGroupResponse smart constructor.
Constructors
| DeleteDatasetGroupResponse' | |
Instances
newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse Source #
Create a value of DeleteDatasetGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeSchema
data DescribeSchema Source #
See: newDescribeSchema smart constructor.
Constructors
| DescribeSchema' Text |
Instances
Arguments
| :: Text | |
| -> DescribeSchema |
Create a value of DescribeSchema 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:schemaArn:DescribeSchema', describeSchema_schemaArn - The Amazon Resource Name (ARN) of the schema to retrieve.
data DescribeSchemaResponse Source #
See: newDescribeSchemaResponse smart constructor.
Constructors
| DescribeSchemaResponse' (Maybe DatasetSchema) Int |
Instances
newDescribeSchemaResponse Source #
Create a value of DescribeSchemaResponse 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:schema:DescribeSchemaResponse', describeSchemaResponse_schema - The requested schema.
$sel:httpStatus:DescribeSchemaResponse', describeSchemaResponse_httpStatus - The response's http status code.
DescribeAlgorithm
data DescribeAlgorithm Source #
See: newDescribeAlgorithm smart constructor.
Constructors
| DescribeAlgorithm' Text |
Instances
Arguments
| :: Text | |
| -> DescribeAlgorithm |
Create a value of DescribeAlgorithm 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:algorithmArn:DescribeAlgorithm', describeAlgorithm_algorithmArn - The Amazon Resource Name (ARN) of the algorithm to describe.
data DescribeAlgorithmResponse Source #
See: newDescribeAlgorithmResponse smart constructor.
Constructors
| DescribeAlgorithmResponse' (Maybe Algorithm) Int |
Instances
newDescribeAlgorithmResponse Source #
Create a value of DescribeAlgorithmResponse 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:algorithm:DescribeAlgorithmResponse', describeAlgorithmResponse_algorithm - A listing of the properties of the algorithm.
$sel:httpStatus:DescribeAlgorithmResponse', describeAlgorithmResponse_httpStatus - The response's http status code.
ListSolutionVersions (Paginated)
data ListSolutionVersions Source #
See: newListSolutionVersions smart constructor.
Instances
newListSolutionVersions :: ListSolutionVersions Source #
Create a value of ListSolutionVersions 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:ListSolutionVersions', listSolutionVersions_solutionArn - The Amazon Resource Name (ARN) of the solution.
$sel:nextToken:ListSolutionVersions', listSolutionVersions_nextToken - A token returned from the previous call to ListSolutionVersions for
getting the next set of solution versions (if they exist).
$sel:maxResults:ListSolutionVersions', listSolutionVersions_maxResults - The maximum number of solution versions to return.
data ListSolutionVersionsResponse Source #
See: newListSolutionVersionsResponse smart constructor.
Constructors
| ListSolutionVersionsResponse' (Maybe Text) (Maybe [SolutionVersionSummary]) Int |
Instances
newListSolutionVersionsResponse Source #
Create a value of ListSolutionVersionsResponse 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:nextToken:ListSolutionVersions', listSolutionVersionsResponse_nextToken - A token for getting the next set of solution versions (if they exist).
$sel:solutionVersions:ListSolutionVersionsResponse', listSolutionVersionsResponse_solutionVersions - A list of solution versions describing the version properties.
$sel:httpStatus:ListSolutionVersionsResponse', listSolutionVersionsResponse_httpStatus - The response's http status code.
DescribeBatchInferenceJob
data DescribeBatchInferenceJob Source #
See: newDescribeBatchInferenceJob smart constructor.
Constructors
| DescribeBatchInferenceJob' Text |
Instances
newDescribeBatchInferenceJob Source #
Create a value of DescribeBatchInferenceJob 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:batchInferenceJobArn:DescribeBatchInferenceJob', describeBatchInferenceJob_batchInferenceJobArn - The ARN of the batch inference job to describe.
data DescribeBatchInferenceJobResponse Source #
See: newDescribeBatchInferenceJobResponse smart constructor.
Constructors
| DescribeBatchInferenceJobResponse' (Maybe BatchInferenceJob) Int |
Instances
newDescribeBatchInferenceJobResponse Source #
Arguments
| :: Int | |
| -> DescribeBatchInferenceJobResponse |
Create a value of DescribeBatchInferenceJobResponse 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:batchInferenceJob:DescribeBatchInferenceJobResponse', describeBatchInferenceJobResponse_batchInferenceJob - Information on the specified batch inference job.
$sel:httpStatus:DescribeBatchInferenceJobResponse', describeBatchInferenceJobResponse_httpStatus - The response's http status code.
CreateSchema
data CreateSchema Source #
See: newCreateSchema smart constructor.
Constructors
| CreateSchema' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateSchema |
Create a value of CreateSchema 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:CreateSchema', createSchema_name - The name for the schema.
$sel:schema:CreateSchema', createSchema_schema - A schema in Avro JSON format.
data CreateSchemaResponse Source #
See: newCreateSchemaResponse smart constructor.
Constructors
| CreateSchemaResponse' (Maybe Text) Int |
Instances
newCreateSchemaResponse Source #
Arguments
| :: Int | |
| -> CreateSchemaResponse |
Create a value of CreateSchemaResponse 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:schemaArn:CreateSchemaResponse', createSchemaResponse_schemaArn - The Amazon Resource Name (ARN) of the created schema.
$sel:httpStatus:CreateSchemaResponse', createSchemaResponse_httpStatus - The response's http status code.
DescribeRecipe
data DescribeRecipe Source #
See: newDescribeRecipe smart constructor.
Constructors
| DescribeRecipe' Text |
Instances
Arguments
| :: Text | |
| -> DescribeRecipe |
Create a value of DescribeRecipe 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:recipeArn:DescribeRecipe', describeRecipe_recipeArn - The Amazon Resource Name (ARN) of the recipe to describe.
data DescribeRecipeResponse Source #
See: newDescribeRecipeResponse smart constructor.
Constructors
| DescribeRecipeResponse' (Maybe Recipe) Int |
Instances
newDescribeRecipeResponse Source #
Create a value of DescribeRecipeResponse 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:recipe:DescribeRecipeResponse', describeRecipeResponse_recipe - An object that describes the recipe.
$sel:httpStatus:DescribeRecipeResponse', describeRecipeResponse_httpStatus - The response's http status code.
ListSolutions (Paginated)
data ListSolutions Source #
See: newListSolutions smart constructor.
Instances
newListSolutions :: ListSolutions Source #
Create a value of ListSolutions 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:nextToken:ListSolutions', listSolutions_nextToken - A token returned from the previous call to ListSolutions for getting
the next set of solutions (if they exist).
$sel:datasetGroupArn:ListSolutions', listSolutions_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.
$sel:maxResults:ListSolutions', listSolutions_maxResults - The maximum number of solutions to return.
data ListSolutionsResponse Source #
See: newListSolutionsResponse smart constructor.
Constructors
| ListSolutionsResponse' (Maybe Text) (Maybe [SolutionSummary]) Int |
Instances
newListSolutionsResponse Source #
Create a value of ListSolutionsResponse 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:nextToken:ListSolutions', listSolutionsResponse_nextToken - A token for getting the next set of solutions (if they exist).
$sel:solutions:ListSolutionsResponse', listSolutionsResponse_solutions - A list of the current solutions.
$sel:httpStatus:ListSolutionsResponse', listSolutionsResponse_httpStatus - The response's http status code.
ListDatasetExportJobs (Paginated)
data ListDatasetExportJobs Source #
See: newListDatasetExportJobs smart constructor.
Instances
newListDatasetExportJobs :: ListDatasetExportJobs Source #
Create a value of ListDatasetExportJobs 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:datasetArn:ListDatasetExportJobs', listDatasetExportJobs_datasetArn - The Amazon Resource Name (ARN) of the dataset to list the dataset export
jobs for.
$sel:nextToken:ListDatasetExportJobs', listDatasetExportJobs_nextToken - A token returned from the previous call to ListDatasetExportJobs for
getting the next set of dataset export jobs (if they exist).
$sel:maxResults:ListDatasetExportJobs', listDatasetExportJobs_maxResults - The maximum number of dataset export jobs to return.
data ListDatasetExportJobsResponse Source #
See: newListDatasetExportJobsResponse smart constructor.
Constructors
| ListDatasetExportJobsResponse' (Maybe Text) (Maybe [DatasetExportJobSummary]) Int |
Instances
newListDatasetExportJobsResponse Source #
Create a value of ListDatasetExportJobsResponse 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:nextToken:ListDatasetExportJobs', listDatasetExportJobsResponse_nextToken - A token for getting the next set of dataset export jobs (if they exist).
$sel:datasetExportJobs:ListDatasetExportJobsResponse', listDatasetExportJobsResponse_datasetExportJobs - The list of dataset export jobs.
$sel:httpStatus:ListDatasetExportJobsResponse', listDatasetExportJobsResponse_httpStatus - The response's http status code.
DescribeDatasetGroup
data DescribeDatasetGroup Source #
See: newDescribeDatasetGroup smart constructor.
Constructors
| DescribeDatasetGroup' Text |
Instances
newDescribeDatasetGroup Source #
Create a value of DescribeDatasetGroup 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:datasetGroupArn:DescribeDatasetGroup', describeDatasetGroup_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group to describe.
data DescribeDatasetGroupResponse Source #
See: newDescribeDatasetGroupResponse smart constructor.
Constructors
| DescribeDatasetGroupResponse' (Maybe DatasetGroup) Int |
Instances
newDescribeDatasetGroupResponse Source #
Create a value of DescribeDatasetGroupResponse 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:datasetGroup:DescribeDatasetGroupResponse', describeDatasetGroupResponse_datasetGroup - A listing of the dataset group's properties.
$sel:httpStatus:DescribeDatasetGroupResponse', describeDatasetGroupResponse_httpStatus - The response's http status code.
DescribeFeatureTransformation
data DescribeFeatureTransformation Source #
See: newDescribeFeatureTransformation smart constructor.
Constructors
| DescribeFeatureTransformation' Text |
Instances
newDescribeFeatureTransformation Source #
Arguments
| :: Text |
|
| -> DescribeFeatureTransformation |
Create a value of DescribeFeatureTransformation 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:featureTransformationArn:DescribeFeatureTransformation', describeFeatureTransformation_featureTransformationArn - The Amazon Resource Name (ARN) of the feature transformation to
describe.
data DescribeFeatureTransformationResponse Source #
See: newDescribeFeatureTransformationResponse smart constructor.
Constructors
| DescribeFeatureTransformationResponse' (Maybe FeatureTransformation) Int |
Instances
newDescribeFeatureTransformationResponse Source #
Arguments
| :: Int | |
| -> DescribeFeatureTransformationResponse |
Create a value of DescribeFeatureTransformationResponse 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:featureTransformation:DescribeFeatureTransformationResponse', describeFeatureTransformationResponse_featureTransformation - A listing of the FeatureTransformation properties.
$sel:httpStatus:DescribeFeatureTransformationResponse', describeFeatureTransformationResponse_httpStatus - The response's http status code.
GetSolutionMetrics
data GetSolutionMetrics Source #
See: newGetSolutionMetrics smart constructor.
Constructors
| GetSolutionMetrics' Text |
Instances
newGetSolutionMetrics Source #
Create a value of GetSolutionMetrics 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:solutionVersionArn:GetSolutionMetrics', getSolutionMetrics_solutionVersionArn - The Amazon Resource Name (ARN) of the solution version for which to get
metrics.
data GetSolutionMetricsResponse Source #
See: newGetSolutionMetricsResponse smart constructor.
Instances
newGetSolutionMetricsResponse Source #
Create a value of GetSolutionMetricsResponse 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:metrics:GetSolutionMetricsResponse', getSolutionMetricsResponse_metrics - The metrics for the solution version.
$sel:solutionVersionArn:GetSolutionMetrics', getSolutionMetricsResponse_solutionVersionArn - The same solution version ARN as specified in the request.
$sel:httpStatus:GetSolutionMetricsResponse', getSolutionMetricsResponse_httpStatus - The response's http status code.
DeleteSchema
data DeleteSchema Source #
See: newDeleteSchema smart constructor.
Constructors
| DeleteSchema' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSchema |
Create a value of DeleteSchema 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:schemaArn:DeleteSchema', deleteSchema_schemaArn - The Amazon Resource Name (ARN) of the schema to delete.
data DeleteSchemaResponse Source #
See: newDeleteSchemaResponse smart constructor.
Constructors
| DeleteSchemaResponse' | |
Instances
newDeleteSchemaResponse :: DeleteSchemaResponse Source #
Create a value of DeleteSchemaResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets smart constructor.
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets 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:nextToken:ListDatasets', listDatasets_nextToken - A token returned from the previous call to ListDatasetImportJobs for
getting the next set of dataset import jobs (if they exist).
$sel:datasetGroupArn:ListDatasets', listDatasets_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the
datasets to list.
$sel:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of datasets to return.
data ListDatasetsResponse Source #
See: newListDatasetsResponse smart constructor.
Constructors
| ListDatasetsResponse' (Maybe Text) (Maybe [DatasetSummary]) Int |
Instances
newListDatasetsResponse Source #
Arguments
| :: Int | |
| -> ListDatasetsResponse |
Create a value of ListDatasetsResponse 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:nextToken:ListDatasets', listDatasetsResponse_nextToken - A token for getting the next set of datasets (if they exist).
$sel:datasets:ListDatasetsResponse', listDatasetsResponse_datasets - An array of Dataset objects. Each object provides metadata
information.
$sel:httpStatus:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.
CreateDatasetGroup
data CreateDatasetGroup Source #
See: newCreateDatasetGroup smart constructor.
Instances
newCreateDatasetGroup Source #
Arguments
| :: Text | |
| -> CreateDatasetGroup |
Create a value of CreateDatasetGroup 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:CreateDatasetGroup', createDatasetGroup_kmsKeyArn - The Amazon Resource Name (ARN) of a Key Management Service (KMS) key
used to encrypt the datasets.
$sel:roleArn:CreateDatasetGroup', createDatasetGroup_roleArn - The ARN of the Identity and Access Management (IAM) role that has
permissions to access the Key Management Service (KMS) key. Supplying an
IAM role is only valid when also specifying a KMS key.
$sel:name:CreateDatasetGroup', createDatasetGroup_name - The name for the new dataset group.
data CreateDatasetGroupResponse Source #
See: newCreateDatasetGroupResponse smart constructor.
Constructors
| CreateDatasetGroupResponse' (Maybe Text) Int |
Instances
newCreateDatasetGroupResponse Source #
Create a value of CreateDatasetGroupResponse 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:datasetGroupArn:CreateDatasetGroupResponse', createDatasetGroupResponse_datasetGroupArn - The Amazon Resource Name (ARN) of the new dataset group.
$sel:httpStatus:CreateDatasetGroupResponse', createDatasetGroupResponse_httpStatus - The response's http status code.
ListRecipes (Paginated)
data ListRecipes Source #
See: newListRecipes smart constructor.
Constructors
| ListRecipes' (Maybe Text) (Maybe Natural) (Maybe RecipeProvider) |
Instances
newListRecipes :: ListRecipes Source #
Create a value of ListRecipes 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:nextToken:ListRecipes', listRecipes_nextToken - A token returned from the previous call to ListRecipes for getting the
next set of recipes (if they exist).
$sel:maxResults:ListRecipes', listRecipes_maxResults - The maximum number of recipes to return.
$sel:recipeProvider:ListRecipes', listRecipes_recipeProvider - The default is SERVICE.
data ListRecipesResponse Source #
See: newListRecipesResponse smart constructor.
Constructors
| ListRecipesResponse' (Maybe Text) (Maybe [RecipeSummary]) Int |
Instances
newListRecipesResponse Source #
Arguments
| :: Int | |
| -> ListRecipesResponse |
Create a value of ListRecipesResponse 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:nextToken:ListRecipes', listRecipesResponse_nextToken - A token for getting the next set of recipes.
$sel:recipes:ListRecipesResponse', listRecipesResponse_recipes - The list of available recipes.
$sel:httpStatus:ListRecipesResponse', listRecipesResponse_httpStatus - The response's http status code.
Types
IngestionMode
newtype IngestionMode Source #
Constructors
| IngestionMode' | |
Fields | |
Bundled Patterns
| pattern IngestionMode_ALL :: IngestionMode | |
| pattern IngestionMode_BULK :: IngestionMode | |
| pattern IngestionMode_PUT :: IngestionMode |
Instances
ObjectiveSensitivity
newtype ObjectiveSensitivity Source #
Constructors
| ObjectiveSensitivity' | |
Fields | |
Bundled Patterns
| pattern ObjectiveSensitivity_HIGH :: ObjectiveSensitivity | |
| pattern ObjectiveSensitivity_LOW :: ObjectiveSensitivity | |
| pattern ObjectiveSensitivity_MEDIUM :: ObjectiveSensitivity | |
| pattern ObjectiveSensitivity_OFF :: ObjectiveSensitivity |
Instances
RecipeProvider
newtype RecipeProvider Source #
Constructors
| RecipeProvider' | |
Fields | |
Bundled Patterns
| pattern RecipeProvider_SERVICE :: RecipeProvider |
Instances
TrainingMode
newtype TrainingMode Source #
Constructors
| TrainingMode' | |
Fields | |
Bundled Patterns
| pattern TrainingMode_FULL :: TrainingMode | |
| pattern TrainingMode_UPDATE :: TrainingMode |
Instances
Algorithm
Describes a custom algorithm.
See: newAlgorithm smart constructor.
Constructors
| Algorithm' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe DefaultHyperParameterRanges) (Maybe AlgorithmImage) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text Text)) (Maybe Text) |
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.
AlgorithmImage
data AlgorithmImage Source #
Describes an algorithm image.
See: newAlgorithmImage smart constructor.
Constructors
| AlgorithmImage' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> AlgorithmImage |
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.
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.
Constructors
| AutoMLConfig' (Maybe [Text]) (Maybe Text) |
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.
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.
Constructors
| AutoMLResult' (Maybe Text) |
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.
BatchInferenceJob
data BatchInferenceJob Source #
Contains information on a batch inference job.
See: newBatchInferenceJob smart constructor.
Constructors
| BatchInferenceJob' (Maybe Text) (Maybe Text) (Maybe BatchInferenceJobOutput) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe BatchInferenceJobConfig) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe BatchInferenceJobInput) |
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.
BatchInferenceJobConfig
data BatchInferenceJobConfig Source #
The configuration details of a batch inference job.
See: newBatchInferenceJobConfig smart constructor.
Constructors
| BatchInferenceJobConfig' (Maybe (HashMap Text Text)) |
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.
BatchInferenceJobInput
data BatchInferenceJobInput Source #
The input configuration of a batch inference job.
See: newBatchInferenceJobInput smart constructor.
Constructors
| BatchInferenceJobInput' S3DataConfig |
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.
BatchInferenceJobOutput
data BatchInferenceJobOutput Source #
The output configuration parameters of a batch inference job.
See: newBatchInferenceJobOutput smart constructor.
Constructors
| BatchInferenceJobOutput' S3DataConfig |
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.
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.
Constructors
| BatchInferenceJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
Campaign
Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.
See: newCampaign smart constructor.
Constructors
| Campaign' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CampaignConfig) (Maybe CampaignUpdateSummary) (Maybe Text) (Maybe Natural) (Maybe POSIX) (Maybe Text) (Maybe Text) |
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.
CampaignConfig
data CampaignConfig Source #
The configuration details of a campaign.
See: newCampaignConfig smart constructor.
Constructors
| CampaignConfig' (Maybe (HashMap Text Text)) |
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.
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.
Constructors
| CampaignSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
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.
Constructors
| CampaignUpdateSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe CampaignConfig) (Maybe Natural) (Maybe POSIX) (Maybe Text) |
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.
CategoricalHyperParameterRange
data CategoricalHyperParameterRange Source #
Provides the name and range of a categorical hyperparameter.
See: newCategoricalHyperParameterRange smart constructor.
Constructors
| CategoricalHyperParameterRange' (Maybe [Text]) (Maybe Text) |
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.
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.
DataSource
data DataSource Source #
Describes the data source that contains the data to upload to a dataset.
See: newDataSource smart constructor.
Constructors
| DataSource' (Maybe Text) |
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/
Dataset
Provides metadata for a dataset.
See: newDataset smart constructor.
Constructors
| Dataset' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
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.
Constructors
| DatasetExportJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetExportJobOutput) (Maybe Text) (Maybe POSIX) (Maybe IngestionMode) (Maybe POSIX) (Maybe Text) |
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.
DatasetExportJobOutput
data DatasetExportJobOutput Source #
The output configuration parameters of a dataset export job.
See: newDatasetExportJobOutput smart constructor.
Constructors
| DatasetExportJobOutput' S3DataConfig |
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.
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.
Constructors
| DatasetExportJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
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.
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.
Constructors
| DatasetGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
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.
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.
Constructors
| DatasetGroupSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
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.
Constructors
| DatasetImportJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe DataSource) (Maybe POSIX) (Maybe Text) |
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.
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.
Constructors
| DatasetImportJobSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) |
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.
DatasetSchema
data DatasetSchema Source #
Describes the schema for a dataset. For more information on schemas, see CreateSchema.
See: newDatasetSchema smart constructor.
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.
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.
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.
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.
Constructors
| DatasetSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) |
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.
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.
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.
Constructors
| DefaultContinuousHyperParameterRange' (Maybe Double) (Maybe Bool) (Maybe Text) (Maybe Double) |
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.
DefaultHyperParameterRanges
data DefaultHyperParameterRanges Source #
Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.
See: newDefaultHyperParameterRanges smart constructor.
Constructors
| DefaultHyperParameterRanges' (Maybe [DefaultIntegerHyperParameterRange]) (Maybe [DefaultCategoricalHyperParameterRange]) (Maybe [DefaultContinuousHyperParameterRange]) |
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.
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.
EventTracker
data EventTracker Source #
Provides information about an event tracker.
See: newEventTracker smart constructor.
Constructors
| EventTracker' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
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.
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.
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.
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.
Constructors
| FeatureTransformation' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text Text)) |
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.
Filter
Contains information on a recommendation filter, including its ARN, status, and filter expression.
See: newFilter smart constructor.
Constructors
| Filter' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
FilterSummary
data FilterSummary Source #
A short summary of a filter's attributes.
See: newFilterSummary smart constructor.
Constructors
| FilterSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
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.
HPOConfig
Describes the properties for hyperparameter optimization (HPO).
See: newHPOConfig smart constructor.
Constructors
| HPOConfig' (Maybe HyperParameterRanges) (Maybe HPOResourceConfig) (Maybe HPOObjective) |
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.
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.
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.
HPOResourceConfig
data HPOResourceConfig Source #
Describes the resource configuration for hyperparameter optimization (HPO).
See: newHPOResourceConfig smart constructor.
Constructors
| HPOResourceConfig' (Maybe Text) (Maybe Text) |
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.
HyperParameterRanges
data HyperParameterRanges Source #
Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.
See: newHyperParameterRanges smart constructor.
Constructors
| HyperParameterRanges' (Maybe [IntegerHyperParameterRange]) (Maybe [CategoricalHyperParameterRange]) (Maybe [ContinuousHyperParameterRange]) |
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.
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.
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.
Constructors
| OptimizationObjective' (Maybe Text) (Maybe ObjectiveSensitivity) |
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.
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.
Constructors
| Recipe' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
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.
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.
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.
S3DataConfig
data S3DataConfig Source #
The configuration details of an Amazon S3 input or output bucket.
See: newS3DataConfig smart constructor.
Constructors
| S3DataConfig' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> S3DataConfig |
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.
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.
Constructors
| Solution' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe AutoMLResult) (Maybe POSIX) (Maybe Text) (Maybe SolutionVersionSummary) (Maybe SolutionConfig) (Maybe Bool) |
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.
SolutionConfig
data SolutionConfig Source #
Describes the configuration properties for the solution.
See: newSolutionConfig smart constructor.
Constructors
| SolutionConfig' (Maybe (HashMap Text Text)) (Maybe HPOConfig) (Maybe Text) (Maybe AutoMLConfig) (Maybe (HashMap Text Text)) (Maybe OptimizationObjective) |
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.
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.
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.
SolutionVersion
data SolutionVersion Source #
An object that provides information about a specific version of a Solution.
See: newSolutionVersion smart constructor.
Constructors
| SolutionVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe TunedHPOParams) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe TrainingMode) (Maybe Double) (Maybe SolutionConfig) (Maybe Bool) (Maybe Text) |
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.
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.
Constructors
| SolutionVersionSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
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.
TunedHPOParams
data TunedHPOParams Source #
If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
See: newTunedHPOParams smart constructor.
Constructors
| TunedHPOParams' (Maybe (HashMap Text Text)) |
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.