5.0.0 • Published 3 years ago

@datafire/amazonaws_personalize v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

@datafire/amazonaws_personalize

Client library for Amazon Personalize

Installation and Usage

npm install --save @datafire/amazonaws_personalize
let amazonaws_personalize = require('@datafire/amazonaws_personalize').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

Actions

CreateBatchInferenceJob

amazonaws_personalize.CreateBatchInferenceJob({
  "jobName": null,
  "solutionVersionArn": null,
  "jobInput": null,
  "jobOutput": null,
  "roleArn": null
}, context)

Input

  • input object
    • batchInferenceJobConfig
      • itemExplorationConfig
    • filterArn
    • jobInput required
      • s3DataSource required
        • kmsKeyArn
        • path required
    • jobName required
    • jobOutput required
      • s3DataDestination required
        • kmsKeyArn
        • path required
    • numResults
    • roleArn required
    • solutionVersionArn required

Output

CreateCampaign

amazonaws_personalize.CreateCampaign({
  "name": null,
  "solutionVersionArn": null,
  "minProvisionedTPS": null
}, context)

Input

  • input object
    • campaignConfig
      • itemExplorationConfig
    • minProvisionedTPS required
    • name required
    • solutionVersionArn required

Output

CreateDataset

amazonaws_personalize.CreateDataset({
  "name": null,
  "schemaArn": null,
  "datasetGroupArn": null,
  "datasetType": null
}, context)

Input

  • input object
    • datasetGroupArn required
    • datasetType required
    • name required
    • schemaArn required

Output

CreateDatasetGroup

amazonaws_personalize.CreateDatasetGroup({
  "name": null
}, context)

Input

  • input object
    • kmsKeyArn
    • name required
    • roleArn

Output

CreateDatasetImportJob

amazonaws_personalize.CreateDatasetImportJob({
  "jobName": null,
  "datasetArn": null,
  "dataSource": null,
  "roleArn": null
}, context)

Input

  • input object
    • dataSource required
      • dataLocation
    • datasetArn required
    • jobName required
    • roleArn required

Output

CreateEventTracker

amazonaws_personalize.CreateEventTracker({
  "name": null,
  "datasetGroupArn": null
}, context)

Input

  • input object
    • datasetGroupArn required
    • name required

Output

CreateFilter

amazonaws_personalize.CreateFilter({
  "name": null,
  "datasetGroupArn": null,
  "filterExpression": null
}, context)

Input

  • input object
    • datasetGroupArn required
    • filterExpression required
    • name required

Output

CreateSchema

amazonaws_personalize.CreateSchema({
  "name": null,
  "schema": null
}, context)

Input

  • input object
    • name required
    • schema required

Output

CreateSolution

amazonaws_personalize.CreateSolution({
  "name": null,
  "datasetGroupArn": null
}, context)

Input

  • input object
    • datasetGroupArn required
    • eventType
    • name required
    • performAutoML
    • performHPO
    • recipeArn
    • solutionConfig
      • algorithmHyperParameters
      • autoMLConfig
        • metricName
        • recipeList
      • eventValueThreshold
      • featureTransformationParameters
      • hpoConfig

Output

CreateSolutionVersion

amazonaws_personalize.CreateSolutionVersion({
  "solutionArn": null
}, context)

Input

  • input object
    • solutionArn required
    • trainingMode

Output

DeleteCampaign

amazonaws_personalize.DeleteCampaign({
  "campaignArn": null
}, context)

Input

  • input object
    • campaignArn required

Output

Output schema unknown

DeleteDataset

amazonaws_personalize.DeleteDataset({
  "datasetArn": null
}, context)

Input

  • input object
    • datasetArn required

Output

Output schema unknown

DeleteDatasetGroup

amazonaws_personalize.DeleteDatasetGroup({
  "datasetGroupArn": null
}, context)

Input

  • input object
    • datasetGroupArn required

Output

Output schema unknown

DeleteEventTracker

amazonaws_personalize.DeleteEventTracker({
  "eventTrackerArn": null
}, context)

Input

  • input object
    • eventTrackerArn required

Output

Output schema unknown

DeleteFilter

amazonaws_personalize.DeleteFilter({
  "filterArn": null
}, context)

Input

  • input object
    • filterArn required

Output

Output schema unknown

DeleteSchema

amazonaws_personalize.DeleteSchema({
  "schemaArn": null
}, context)

Input

  • input object
    • schemaArn required

Output

Output schema unknown

DeleteSolution

amazonaws_personalize.DeleteSolution({
  "solutionArn": null
}, context)

Input

  • input object
    • solutionArn required

Output

Output schema unknown

DescribeAlgorithm

amazonaws_personalize.DescribeAlgorithm({
  "algorithmArn": null
}, context)

Input

  • input object
    • algorithmArn required

Output

DescribeBatchInferenceJob

amazonaws_personalize.DescribeBatchInferenceJob({
  "batchInferenceJobArn": null
}, context)

Input

  • input object
    • batchInferenceJobArn required

Output

DescribeCampaign

amazonaws_personalize.DescribeCampaign({
  "campaignArn": null
}, context)

Input

  • input object
    • campaignArn required

Output

DescribeDataset

amazonaws_personalize.DescribeDataset({
  "datasetArn": null
}, context)

Input

  • input object
    • datasetArn required

Output

DescribeDatasetGroup

amazonaws_personalize.DescribeDatasetGroup({
  "datasetGroupArn": null
}, context)

Input

  • input object
    • datasetGroupArn required

Output

DescribeDatasetImportJob

amazonaws_personalize.DescribeDatasetImportJob({
  "datasetImportJobArn": null
}, context)

Input

  • input object
    • datasetImportJobArn required

Output

DescribeEventTracker

amazonaws_personalize.DescribeEventTracker({
  "eventTrackerArn": null
}, context)

Input

  • input object
    • eventTrackerArn required

Output

DescribeFeatureTransformation

amazonaws_personalize.DescribeFeatureTransformation({
  "featureTransformationArn": null
}, context)

Input

  • input object
    • featureTransformationArn required

Output

DescribeFilter

amazonaws_personalize.DescribeFilter({
  "filterArn": null
}, context)

Input

  • input object
    • filterArn required

Output

DescribeRecipe

amazonaws_personalize.DescribeRecipe({
  "recipeArn": null
}, context)

Input

  • input object
    • recipeArn required

Output

DescribeSchema

amazonaws_personalize.DescribeSchema({
  "schemaArn": null
}, context)

Input

  • input object
    • schemaArn required

Output

DescribeSolution

amazonaws_personalize.DescribeSolution({
  "solutionArn": null
}, context)

Input

  • input object
    • solutionArn required

Output

DescribeSolutionVersion

amazonaws_personalize.DescribeSolutionVersion({
  "solutionVersionArn": null
}, context)

Input

  • input object
    • solutionVersionArn required

Output

GetSolutionMetrics

amazonaws_personalize.GetSolutionMetrics({
  "solutionVersionArn": null
}, context)

Input

  • input object
    • solutionVersionArn required

Output

ListBatchInferenceJobs

amazonaws_personalize.ListBatchInferenceJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken
    • solutionVersionArn

Output

ListCampaigns

amazonaws_personalize.ListCampaigns({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken
    • solutionArn

Output

ListDatasetGroups

amazonaws_personalize.ListDatasetGroups({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken

Output

ListDatasetImportJobs

amazonaws_personalize.ListDatasetImportJobs({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • datasetArn
    • maxResults
    • nextToken

Output

ListDatasets

amazonaws_personalize.ListDatasets({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • datasetGroupArn
    • maxResults
    • nextToken

Output

ListEventTrackers

amazonaws_personalize.ListEventTrackers({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • datasetGroupArn
    • maxResults
    • nextToken

Output

ListFilters

amazonaws_personalize.ListFilters({}, context)

Input

  • input object
    • datasetGroupArn
    • maxResults
    • nextToken

Output

ListRecipes

amazonaws_personalize.ListRecipes({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken
    • recipeProvider

Output

ListSchemas

amazonaws_personalize.ListSchemas({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken

Output

ListSolutionVersions

amazonaws_personalize.ListSolutionVersions({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • maxResults
    • nextToken
    • solutionArn

Output

ListSolutions

amazonaws_personalize.ListSolutions({}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • datasetGroupArn
    • maxResults
    • nextToken

Output

UpdateCampaign

amazonaws_personalize.UpdateCampaign({
  "campaignArn": null
}, context)

Input

  • input object
    • campaignArn required
    • campaignConfig
      • itemExplorationConfig
    • minProvisionedTPS
    • solutionVersionArn

Output

Definitions

AccountId

  • AccountId string

Algorithm

AlgorithmImage

  • AlgorithmImage object: Describes an algorithm image.
    • dockerURI required
    • name

Arn

  • Arn string

ArnList

  • ArnList array

AutoMLConfig

  • AutoMLConfig object: 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.
    • metricName
    • recipeList

AutoMLResult

  • AutoMLResult object: When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.
    • bestRecipeArn

AvroSchema

  • AvroSchema string

BatchInferenceJob

  • BatchInferenceJob object: Contains information on a batch inference job.
    • batchInferenceJobArn
    • batchInferenceJobConfig
      • itemExplorationConfig
    • creationDateTime
    • failureReason
    • filterArn
    • jobInput
      • s3DataSource required
        • kmsKeyArn
        • path required
    • jobName
    • jobOutput
      • s3DataDestination required
        • kmsKeyArn
        • path required
    • lastUpdatedDateTime
    • numResults
    • roleArn
    • solutionVersionArn
    • status

BatchInferenceJobConfig

  • BatchInferenceJobConfig object: The configuration details of a batch inference job.
    • itemExplorationConfig

BatchInferenceJobInput

  • BatchInferenceJobInput object: The input configuration of a batch inference job.
    • s3DataSource required
      • kmsKeyArn
      • path required

BatchInferenceJobOutput

  • BatchInferenceJobOutput object: The output configuration parameters of a batch inference job.
    • s3DataDestination required
      • kmsKeyArn
      • path required

BatchInferenceJobSummary

  • BatchInferenceJobSummary object: A truncated version of the BatchInferenceJob datatype. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.
    • batchInferenceJobArn
    • creationDateTime
    • failureReason
    • jobName
    • lastUpdatedDateTime
    • solutionVersionArn
    • status

BatchInferenceJobs

Boolean

  • Boolean boolean

Campaign

  • Campaign object: Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.
    • campaignArn
    • campaignConfig
      • itemExplorationConfig
    • creationDateTime
    • failureReason
    • lastUpdatedDateTime
    • latestCampaignUpdate CampaignUpdateSummary
    • minProvisionedTPS
    • name
    • solutionVersionArn
    • status

CampaignConfig

  • CampaignConfig object: The configuration details of a campaign.
    • itemExplorationConfig

CampaignSummary

  • CampaignSummary object: Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.
    • campaignArn
    • creationDateTime
    • failureReason
    • lastUpdatedDateTime
    • name
    • status

CampaignUpdateSummary

  • CampaignUpdateSummary object: Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.
    • campaignConfig CampaignConfig
    • creationDateTime
    • failureReason
    • lastUpdatedDateTime
    • minProvisionedTPS
    • solutionVersionArn
    • status

Campaigns

CategoricalHyperParameterRange

  • CategoricalHyperParameterRange object: Provides the name and range of a categorical hyperparameter.

CategoricalHyperParameterRanges

CategoricalValue

  • CategoricalValue string

CategoricalValues

ContinuousHyperParameterRange

  • ContinuousHyperParameterRange object: Provides the name and range of a continuous hyperparameter.
    • maxValue
    • minValue
    • name

ContinuousHyperParameterRanges

ContinuousMaxValue

  • ContinuousMaxValue number

ContinuousMinValue

  • ContinuousMinValue number

CreateBatchInferenceJobRequest

  • CreateBatchInferenceJobRequest object
    • batchInferenceJobConfig
      • itemExplorationConfig
    • filterArn
    • jobInput required
      • s3DataSource required
        • kmsKeyArn
        • path required
    • jobName required
    • jobOutput required
      • s3DataDestination required
        • kmsKeyArn
        • path required
    • numResults
    • roleArn required
    • solutionVersionArn required

CreateBatchInferenceJobResponse

  • CreateBatchInferenceJobResponse object
    • batchInferenceJobArn

CreateCampaignRequest

  • CreateCampaignRequest object
    • campaignConfig
      • itemExplorationConfig
    • minProvisionedTPS required
    • name required
    • solutionVersionArn required

CreateCampaignResponse

  • CreateCampaignResponse object
    • campaignArn

CreateDatasetGroupRequest

  • CreateDatasetGroupRequest object
    • kmsKeyArn
    • name required
    • roleArn

CreateDatasetGroupResponse

  • CreateDatasetGroupResponse object
    • datasetGroupArn

CreateDatasetImportJobRequest

  • CreateDatasetImportJobRequest object
    • dataSource required
      • dataLocation
    • datasetArn required
    • jobName required
    • roleArn required

CreateDatasetImportJobResponse

  • CreateDatasetImportJobResponse object
    • datasetImportJobArn

CreateDatasetRequest

  • CreateDatasetRequest object
    • datasetGroupArn required
    • datasetType required
    • name required
    • schemaArn required

CreateDatasetResponse

  • CreateDatasetResponse object
    • datasetArn

CreateEventTrackerRequest

  • CreateEventTrackerRequest object
    • datasetGroupArn required
    • name required

CreateEventTrackerResponse

  • CreateEventTrackerResponse object
    • eventTrackerArn
    • trackingId

CreateFilterRequest

  • CreateFilterRequest object
    • datasetGroupArn required
    • filterExpression required
    • name required

CreateFilterResponse

  • CreateFilterResponse object
    • filterArn

CreateSchemaRequest

  • CreateSchemaRequest object
    • name required
    • schema required

CreateSchemaResponse

  • CreateSchemaResponse object
    • schemaArn

CreateSolutionRequest

  • CreateSolutionRequest object
    • datasetGroupArn required
    • eventType
    • name required
    • performAutoML
    • performHPO
    • recipeArn
    • solutionConfig
      • algorithmHyperParameters
      • autoMLConfig
        • metricName
        • recipeList
      • eventValueThreshold
      • featureTransformationParameters
      • hpoConfig

CreateSolutionResponse

  • CreateSolutionResponse object
    • solutionArn

CreateSolutionVersionRequest

  • CreateSolutionVersionRequest object
    • solutionArn required
    • trainingMode

CreateSolutionVersionResponse

  • CreateSolutionVersionResponse object
    • solutionVersionArn

DataSource

  • DataSource object: Describes the data source that contains the data to upload to a dataset.
    • dataLocation

Dataset

  • Dataset object: Provides metadata for a dataset.
    • creationDateTime
    • datasetArn
    • datasetGroupArn
    • datasetType
    • lastUpdatedDateTime
    • name
    • schemaArn
    • status

DatasetGroup

  • DatasetGroup object: 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 AWS Key Management Service (KMS) key to encrypt the datasets in the group.
    • creationDateTime
    • datasetGroupArn
    • failureReason
    • kmsKeyArn
    • lastUpdatedDateTime
    • name
    • roleArn
    • status

DatasetGroupSummary

  • DatasetGroupSummary object: Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
    • creationDateTime
    • datasetGroupArn
    • failureReason
    • lastUpdatedDateTime
    • name
    • status

DatasetGroups

DatasetImportJob

  • DatasetImportJob object: 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
    • creationDateTime
    • dataSource
      • dataLocation
    • datasetArn
    • datasetImportJobArn
    • failureReason
    • jobName
    • lastUpdatedDateTime
    • roleArn
    • status

DatasetImportJobSummary

  • DatasetImportJobSummary object: Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.
    • creationDateTime
    • datasetImportJobArn
    • failureReason
    • jobName
    • lastUpdatedDateTime
    • status

DatasetImportJobs

DatasetSchema

  • DatasetSchema object: Describes the schema for a dataset. For more information on schemas, see CreateSchema.
    • creationDateTime
    • lastUpdatedDateTime
    • name
    • schema
    • schemaArn

DatasetSchemaSummary

  • DatasetSchemaSummary object: Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
    • creationDateTime
    • lastUpdatedDateTime
    • name
    • schemaArn

DatasetSummary

  • DatasetSummary object: Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.
    • creationDateTime
    • datasetArn
    • datasetType
    • lastUpdatedDateTime
    • name
    • status

DatasetType

  • DatasetType string

Datasets

Date

  • Date string

DefaultCategoricalHyperParameterRange

  • DefaultCategoricalHyperParameterRange object: 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).

DefaultCategoricalHyperParameterRanges

DefaultContinuousHyperParameterRange

  • DefaultContinuousHyperParameterRange object: 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).
    • isTunable
    • maxValue
    • minValue
    • name

DefaultContinuousHyperParameterRanges

DefaultHyperParameterRanges

DefaultIntegerHyperParameterRange

  • DefaultIntegerHyperParameterRange object: 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).
    • isTunable
    • maxValue
    • minValue
    • name

DefaultIntegerHyperParameterRanges

DeleteCampaignRequest

  • DeleteCampaignRequest object
    • campaignArn required

DeleteDatasetGroupRequest

  • DeleteDatasetGroupRequest object
    • datasetGroupArn required

DeleteDatasetRequest

  • DeleteDatasetRequest object
    • datasetArn required

DeleteEventTrackerRequest

  • DeleteEventTrackerRequest object
    • eventTrackerArn required

DeleteFilterRequest

  • DeleteFilterRequest object
    • filterArn required

DeleteSchemaRequest

  • DeleteSchemaRequest object
    • schemaArn required

DeleteSolutionRequest

  • DeleteSolutionRequest object
    • solutionArn required

DescribeAlgorithmRequest

  • DescribeAlgorithmRequest object
    • algorithmArn required

DescribeAlgorithmResponse

DescribeBatchInferenceJobRequest

  • DescribeBatchInferenceJobRequest object
    • batchInferenceJobArn required

DescribeBatchInferenceJobResponse

  • DescribeBatchInferenceJobResponse object
    • batchInferenceJob
      • batchInferenceJobArn
      • batchInferenceJobConfig
        • itemExplorationConfig
      • creationDateTime
      • failureReason
      • filterArn
      • jobInput
        • s3DataSource required
          • kmsKeyArn
          • path required
      • jobName
      • jobOutput
        • s3DataDestination required
          • kmsKeyArn
          • path required
      • lastUpdatedDateTime
      • numResults
      • roleArn
      • solutionVersionArn
      • status

DescribeCampaignRequest

  • DescribeCampaignRequest object
    • campaignArn required

DescribeCampaignResponse

  • DescribeCampaignResponse object
    • campaign
      • campaignArn
      • campaignConfig
        • itemExplorationConfig
      • creationDateTime
      • failureReason
      • lastUpdatedDateTime
      • latestCampaignUpdate CampaignUpdateSummary
      • minProvisionedTPS
      • name
      • solutionVersionArn
      • status

DescribeDatasetGroupRequest

  • DescribeDatasetGroupRequest object
    • datasetGroupArn required

DescribeDatasetGroupResponse

  • DescribeDatasetGroupResponse object
    • datasetGroup
      • creationDateTime
      • datasetGroupArn
      • failureReason
      • kmsKeyArn
      • lastUpdatedDateTime
      • name
      • roleArn
      • status

DescribeDatasetImportJobRequest

  • DescribeDatasetImportJobRequest object
    • datasetImportJobArn required

DescribeDatasetImportJobResponse

  • DescribeDatasetImportJobResponse object
    • datasetImportJob
      • creationDateTime
      • dataSource
        • dataLocation
      • datasetArn
      • datasetImportJobArn
      • failureReason
      • jobName
      • lastUpdatedDateTime
      • roleArn
      • status

DescribeDatasetRequest

  • DescribeDatasetRequest object
    • datasetArn required

DescribeDatasetResponse

  • DescribeDatasetResponse object
    • dataset
      • creationDateTime
      • datasetArn
      • datasetGroupArn
      • datasetType
      • lastUpdatedDateTime
      • name
      • schemaArn
      • status

DescribeEventTrackerRequest

  • DescribeEventTrackerRequest object
    • eventTrackerArn required

DescribeEventTrackerResponse

  • DescribeEventTrackerResponse object
    • eventTracker
      • accountId
      • creationDateTime
      • datasetGroupArn
      • eventTrackerArn
      • lastUpdatedDateTime
      • name
      • status
      • trackingId

DescribeFeatureTransformationRequest

  • DescribeFeatureTransformationRequest object
    • featureTransformationArn required

DescribeFeatureTransformationResponse

  • DescribeFeatureTransformationResponse object
    • featureTransformation
      • creationDateTime
      • defaultParameters
      • featureTransformationArn
      • lastUpdatedDateTime
      • name
      • status

DescribeFilterRequest

  • DescribeFilterRequest object
    • filterArn required

DescribeFilterResponse

  • DescribeFilterResponse object
    • filter
      • creationDateTime
      • datasetGroupArn
      • failureReason
      • filterArn
      • filterExpression
      • lastUpdatedDateTime
      • name
      • status

DescribeRecipeRequest

  • DescribeRecipeRequest object
    • recipeArn required

DescribeRecipeResponse

  • DescribeRecipeResponse object
    • recipe
      • algorithmArn
      • creationDateTime
      • description
      • featureTransformationArn
      • lastUpdatedDateTime
      • name
      • recipeArn
      • recipeType
      • status

DescribeSchemaRequest

  • DescribeSchemaRequest object
    • schemaArn required

DescribeSchemaResponse

  • DescribeSchemaResponse object
    • schema
      • creationDateTime
      • lastUpdatedDateTime
      • name
      • schema
      • schemaArn

DescribeSolutionRequest

  • DescribeSolutionRequest object
    • solutionArn required

DescribeSolutionResponse

  • DescribeSolutionResponse object
    • solution
      • autoMLResult
        • bestRecipeArn
      • creationDateTime
      • datasetGroupArn
      • eventType
      • lastUpdatedDateTime
      • latestSolutionVersion
        • creationDateTime
        • failureReason
        • lastUpdatedDateTime
        • solutionVersionArn
        • status
      • name
      • performAutoML
      • performHPO
      • recipeArn
      • solutionArn
      • solutionConfig
        • algorithmHyperParameters
        • autoMLConfig
          • metricName
          • recipeList
        • eventValueThreshold
        • featureTransformationParameters
        • hpoConfig
          • algorithmHyperParameterRanges
            • categoricalHyperParameterRanges
            • continuousHyperParameterRanges
            • integerHyperParameterRanges
          • hpoObjective
            • metricName
            • metricRegex
            • type
          • hpoResourceConfig
            • maxNumberOfTrainingJobs
            • maxParallelTrainingJobs
      • status

DescribeSolutionVersionRequest

  • DescribeSolutionVersionRequest object
    • solutionVersionArn required

DescribeSolutionVersionResponse

  • DescribeSolutionVersionResponse object
    • solutionVersion
      • creationDateTime
      • datasetGroupArn
      • eventType
      • failureReason
      • lastUpdatedDateTime
      • performAutoML
      • performHPO
      • recipeArn
      • solutionArn
      • solutionConfig
        • algorithmHyperParameters
        • autoMLConfig
          • metricName
          • recipeList
        • eventValueThreshold
        • featureTransformationParameters
        • hpoConfig
          • algorithmHyperParameterRanges
            • categoricalHyperParameterRanges
            • continuousHyperParameterRanges
            • integerHyperParameterRanges
          • hpoObjective
            • metricName
            • metricRegex
            • type
          • hpoResourceConfig
            • maxNumberOfTrainingJobs
            • maxParallelTrainingJobs
      • solutionVersionArn
      • status
      • trainingHours
      • trainingMode
      • tunedHPOParams
        • algorithmHyperParameters

Description

  • Description string

DockerURI

  • DockerURI string

EventTracker

  • EventTracker object: Provides information about an event tracker.
    • accountId
    • creationDateTime
    • datasetGroupArn
    • eventTrackerArn
    • lastUpdatedDateTime
    • name
    • status
    • trackingId

EventTrackerSummary

  • EventTrackerSummary object: Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.
    • creationDateTime
    • eventTrackerArn
    • lastUpdatedDateTime
    • name
    • status

EventTrackers

EventType

  • EventType string

EventValueThreshold

  • EventValueThreshold string

FailureReason

  • FailureReason string

FeatureTransformation

  • FeatureTransformation object: Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.
    • creationDateTime
    • defaultParameters
    • featureTransformationArn
    • lastUpdatedDateTime
    • name
    • status

FeatureTransformationParameters

  • FeatureTransformationParameters object

FeaturizationParameters

  • FeaturizationParameters object

Filter

  • Filter object: Contains information on a recommendation filter, including its ARN, status, and filter expression.
    • creationDateTime
    • datasetGroupArn
    • failureReason
    • filterArn
    • filterExpression
    • lastUpdatedDateTime
    • name
    • status

FilterExpression

  • FilterExpression string

FilterSummary

  • FilterSummary object: A short summary of a filter's attributes.
    • creationDateTime
    • datasetGroupArn
    • failureReason
    • filterArn
    • lastUpdatedDateTime
    • name
    • status

Filters

GetSolutionMetricsRequest

  • GetSolutionMetricsRequest object
    • solutionVersionArn required

GetSolutionMetricsResponse

  • GetSolutionMetricsResponse object
    • metrics
    • solutionVersionArn

HPOConfig

  • HPOConfig object: Describes the properties for hyperparameter optimization (HPO). For use with the bring-your-own-recipe feature. Do not use for Amazon Personalize native recipes.

HPOObjective

  • HPOObjective object: The metric to optimize during hyperparameter optimization (HPO).
    • metricName
    • metricRegex
    • type

HPOObjectiveType

  • HPOObjectiveType string

HPOResource

  • HPOResource string

HPOResourceConfig

  • HPOResourceConfig object: Describes the resource configuration for hyperparameter optimization (HPO).
    • maxNumberOfTrainingJobs
    • maxParallelTrainingJobs

HyperParameterRanges

HyperParameters

  • HyperParameters object

IntegerHyperParameterRange

  • IntegerHyperParameterRange object: Provides the name and range of an integer-valued hyperparameter.
    • maxValue
    • minValue
    • name

IntegerHyperParameterRanges

IntegerMaxValue

  • IntegerMaxValue integer

IntegerMinValue

  • IntegerMinValue integer

InvalidInputException

InvalidNextTokenException

KmsKeyArn

  • KmsKeyArn string

LimitExceededException

ListBatchInferenceJobsRequest

  • ListBatchInferenceJobsRequest object
    • maxResults
    • nextToken
    • solutionVersionArn

ListBatchInferenceJobsResponse

ListCampaignsRequest

  • ListCampaignsRequest object
    • maxResults
    • nextToken
    • solutionArn

ListCampaignsResponse

ListDatasetGroupsRequest

  • ListDatasetGroupsRequest object
    • maxResults
    • nextToken

ListDatasetGroupsResponse

ListDatasetImportJobsRequest

  • ListDatasetImportJobsRequest object
    • datasetArn
    • maxResults
    • nextToken

ListDatasetImportJobsResponse

ListDatasetsRequest

  • ListDatasetsRequest object
    • datasetGroupArn
    • maxResults
    • nextToken

ListDatasetsResponse

ListEventTrackersRequest

  • ListEventTrackersRequest object
    • datasetGroupArn
    • maxResults
    • nextToken

ListEventTrackersResponse

ListFiltersRequest

  • ListFiltersRequest object
    • datasetGroupArn
    • maxResults
    • nextToken

ListFiltersResponse

ListRecipesRequest

  • ListRecipesRequest object
    • maxResults
    • nextToken
    • recipeProvider

ListRecipesResponse

ListSchemasRequest

  • ListSchemasRequest object
    • maxResults
    • nextToken

ListSchemasResponse

ListSolutionVersionsRequest

  • ListSolutionVersionsRequest object
    • maxResults
    • nextToken
    • solutionArn

ListSolutionVersionsResponse

ListSolutionsRequest

  • ListSolutionsRequest object
    • datasetGroupArn
    • maxResults
    • nextToken

ListSolutionsResponse

MaxResults

  • MaxResults integer

MetricName

  • MetricName string

MetricRegex

  • MetricRegex string

MetricValue

  • MetricValue number

Metrics

  • Metrics object

Name

  • Name string

NextToken

  • NextToken string

NumBatchResults

  • NumBatchResults integer

ParameterName

  • ParameterName string

ParameterValue

  • ParameterValue string

PerformAutoML

  • PerformAutoML boolean

PerformHPO

  • PerformHPO boolean

Recipe

  • Recipe object: Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.
    • algorithmArn
    • creationDateTime
    • description
    • featureTransformationArn
    • lastUpdatedDateTime
    • name
    • recipeArn
    • recipeType
    • status

RecipeProvider

  • RecipeProvider string (values: SERVICE)

RecipeSummary

  • RecipeSummary object: Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
    • creationDateTime
    • lastUpdatedDateTime
    • name
    • recipeArn
    • status

RecipeType

  • RecipeType string

Recipes

ResourceAlreadyExistsException

ResourceConfig

  • ResourceConfig object

ResourceInUseException

ResourceNotFoundException

RoleArn

  • RoleArn string

S3DataConfig

  • S3DataConfig object: The configuration details of an Amazon S3 input or output bucket.
    • kmsKeyArn
    • path required

S3Location

  • S3Location string

Schemas

Solution

  • Solution object: An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.
    • autoMLResult
      • bestRecipeArn
    • creationDateTime
    • datasetGroupArn
    • eventType
    • lastUpdatedDateTime
    • latestSolutionVersion
      • creationDateTime
      • failureReason
      • lastUpdatedDateTime
      • solutionVersionArn
      • status
    • name
    • performAutoML
    • performHPO
    • recipeArn
    • solutionArn
    • solutionConfig
      • algorithmHyperParameters
      • autoMLConfig
        • metricName
        • recipeList
      • eventValueThreshold
      • featureTransformationParameters
      • hpoConfig
    • status

SolutionConfig

  • SolutionConfig object: Describes the configuration properties for the solution.
    • algorithmHyperParameters
    • autoMLConfig
      • metricName
      • recipeList
    • eventValueThreshold
    • featureTransformationParameters
    • hpoConfig

SolutionSummary

  • SolutionSummary object: Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.
    • creationDateTime
    • lastUpdatedDateTime
    • name
    • solutionArn
    • status

SolutionVersion

  • SolutionVersion object: An object that provides information about a specific version of a Solution.
    • creationDateTime
    • datasetGroupArn
    • eventType
    • failureReason
    • lastUpdatedDateTime
    • performAutoML
    • performHPO
    • recipeArn
    • solutionArn
    • solutionConfig
      • algorithmHyperParameters
      • autoMLConfig
        • metricName
        • recipeList
      • eventValueThreshold
      • featureTransformationParameters
      • hpoConfig
    • solutionVersionArn
    • status
    • trainingHours
    • trainingMode
    • tunedHPOParams
      • algorithmHyperParameters

SolutionVersionSummary

  • SolutionVersionSummary object: Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.
    • creationDateTime
    • failureReason
    • lastUpdatedDateTime
    • solutionVersionArn
    • status

SolutionVersions

Solutions

Status

  • Status string

TrackingId

  • TrackingId string

TrainingHours

  • TrainingHours number

TrainingInputMode

  • TrainingInputMode string

TrainingMode

  • TrainingMode string (values: FULL, UPDATE)

TransactionsPerSecond

  • TransactionsPerSecond integer

Tunable

  • Tunable boolean

TunedHPOParams

  • TunedHPOParams object: If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
    • algorithmHyperParameters

UpdateCampaignRequest

  • UpdateCampaignRequest object
    • campaignArn required
    • campaignConfig
      • itemExplorationConfig
    • minProvisionedTPS
    • solutionVersionArn

UpdateCampaignResponse

  • UpdateCampaignResponse object
    • campaignArn
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

3 years ago