types

package
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 1, 2020 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Algorithm 

type Algorithm struct {

	// Specifies the default maximum number of training jobs and parallel training
	// jobs.
	DefaultResourceConfig map[string]*string

	// The Amazon Resource Name (ARN) of the algorithm.
	AlgorithmArn *string

	// The name of the algorithm.
	Name *string

	// The URI of the Docker container for the algorithm image.
	AlgorithmImage *AlgorithmImage

	// The Amazon Resource Name (ARN) of the role.
	RoleArn *string

	// The date and time (in Unix time) that the algorithm was last updated.
	LastUpdatedDateTime *time.Time

	// Specifies the default hyperparameters.
	DefaultHyperParameters map[string]*string

	// The training input mode.
	TrainingInputMode *string

	// Specifies the default hyperparameters, their ranges, and whether they are
	// tunable. A tunable hyperparameter can have its value determined during
	// hyperparameter optimization (HPO).
	DefaultHyperParameterRanges *DefaultHyperParameterRanges

	// The date and time (in Unix time) that the algorithm was created.
	CreationDateTime *time.Time
}

Describes a custom algorithm.

type AlgorithmImage 

type AlgorithmImage struct {

	// The name of the algorithm image.
	Name *string

	// The URI of the Docker container for the algorithm image.
	//
	// This member is required.
	DockerURI *string
}

Describes an algorithm image.

type AutoMLConfig 

type AutoMLConfig struct {

	// The metric to optimize.
	MetricName *string

	// The list of candidate recipes.
	RecipeList []*string
}

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.

type AutoMLResult 

type AutoMLResult struct {

	// The Amazon Resource Name (ARN) of the best recipe.
	BestRecipeArn *string
}

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

type BatchInferenceJob 

type BatchInferenceJob struct {

	// The name of the batch inference job.
	JobName *string

	// If the batch inference job failed, the reason for the failure.
	FailureReason *string

	// The Amazon Resource Name (ARN) of the solution version from which the batch
	// inference job was created.
	SolutionVersionArn *string

	// The ARN of the Amazon Identity and Access Management (IAM) role that requested
	// the batch inference job.
	RoleArn *string

	// The number of recommendations generated by the batch inference job. This number
	// includes the error messages generated for failed input records.
	NumResults *int32

	// The Amazon S3 path that leads to the input data used to generate the batch
	// inference job.
	JobInput *BatchInferenceJobInput

	// The time at which the batch inference job was last updated.
	LastUpdatedDateTime *time.Time

	// The status of the batch inference job. The status is one of the following
	// values:
	//
	//     * PENDING
	//
	//     * IN PROGRESS
	//
	//     * ACTIVE
	//
	//     * CREATE FAILED
	Status *string

	// The time at which the batch inference job was created.
	CreationDateTime *time.Time

	// The Amazon S3 bucket that contains the output data generated by the batch
	// inference job.
	JobOutput *BatchInferenceJobOutput

	// The ARN of the filter used on the batch inference job.
	FilterArn *string

	// The Amazon Resource Name (ARN) of the batch inference job.
	BatchInferenceJobArn *string
}

Contains information on a batch inference job.

type BatchInferenceJobInput 

type BatchInferenceJobInput struct {

	// 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.
	//
	// This member is required.
	S3DataSource *S3DataConfig
}

The input configuration of a batch inference job.

type BatchInferenceJobOutput 

type BatchInferenceJobOutput struct {

	// Information on the Amazon S3 bucket in which the batch inference job's output is
	// stored.
	//
	// This member is required.
	S3DataDestination *S3DataConfig
}

The output configuration parameters of a batch inference job.

type BatchInferenceJobSummary 

type BatchInferenceJobSummary struct {

	// The ARN of the solution version used by the batch inference job.
	SolutionVersionArn *string

	// The time at which the batch inference job was last updated.
	LastUpdatedDateTime *time.Time

	// If the batch inference job failed, the reason for the failure.
	FailureReason *string

	// The Amazon Resource Name (ARN) of the batch inference job.
	BatchInferenceJobArn *string

	// The time at which the batch inference job was created.
	CreationDateTime *time.Time

	// The status of the batch inference job. The status is one of the following
	// values:
	//
	//     * PENDING
	//
	//     * IN PROGRESS
	//
	//     * ACTIVE
	//
	//     * CREATE FAILED
	Status *string

	// The name of the batch inference job.
	JobName *string
}

A truncated version of the BatchInferenceJob () datatype. The ListBatchInferenceJobs () operation returns a list of batch inference job summaries.

type Campaign 

type Campaign struct {

	// Provides a summary of the properties of a campaign update. For a complete
	// listing, call the DescribeCampaign () API.
	LatestCampaignUpdate *CampaignUpdateSummary

	// The date and time (in Unix format) that the campaign was last updated.
	LastUpdatedDateTime *time.Time

	// Specifies the requested minimum provisioned transactions (recommendations) per
	// second.
	MinProvisionedTPS *int32

	// The name of the campaign.
	Name *string

	// 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
	Status *string

	// The date and time (in Unix format) that the campaign was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of a specific version of the solution.
	SolutionVersionArn *string

	// The Amazon Resource Name (ARN) of the campaign.
	CampaignArn *string

	// If a campaign fails, the reason behind the failure.
	FailureReason *string
}

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign ().

type CampaignSummary 

type CampaignSummary struct {

	// The date and time (in Unix time) that the campaign was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of the campaign.
	CampaignArn *string

	// The name of the campaign.
	Name *string

	// The date and time (in Unix time) that the campaign was created.
	CreationDateTime *time.Time

	// 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
	Status *string

	// If a campaign fails, the reason behind the failure.
	FailureReason *string
}

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign () API.

type CampaignUpdateSummary 

type CampaignUpdateSummary struct {

	// The date and time (in Unix time) that the campaign update was last updated.
	LastUpdatedDateTime *time.Time

	// If a campaign update fails, the reason behind the failure.
	FailureReason *string

	// 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
	Status *string

	// The date and time (in Unix time) that the campaign update was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the deployed solution version.
	SolutionVersionArn *string

	// Specifies the requested minimum provisioned transactions (recommendations) per
	// second that Amazon Personalize will support.
	MinProvisionedTPS *int32
}

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign () API.

type CategoricalHyperParameterRange 

type CategoricalHyperParameterRange struct {

	// The name of the hyperparameter.
	Name *string

	// A list of the categories for the hyperparameter.
	Values []*string
}

Provides the name and range of a categorical hyperparameter.

type ContinuousHyperParameterRange 

type ContinuousHyperParameterRange struct {

	// The maximum allowable value for the hyperparameter.
	MaxValue *float64

	// The name of the hyperparameter.
	Name *string

	// The minimum allowable value for the hyperparameter.
	MinValue *float64
}

Provides the name and range of a continuous hyperparameter.

type DataSource 

type DataSource struct {

	// 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/training-data.csv
	DataLocation *string
}

Describes the data source that contains the data to upload to a dataset.

type Dataset 

type Dataset struct {

	// One of the following values:
	//
	//     * Interactions
	//
	//     * Items
	//
	//     * Users
	DatasetType *string

	// A time stamp that shows when the dataset was updated.
	LastUpdatedDateTime *time.Time

	// 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
	Status *string

	// The creation date and time (in Unix time) of the dataset.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the dataset that you want metadata for.
	DatasetArn *string

	// The name of the dataset.
	Name *string

	// The ARN of the associated schema.
	SchemaArn *string

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string
}

Provides metadata for a dataset.

type DatasetGroup 

type DatasetGroup struct {

	// The ARN of the IAM role that has permissions to create the dataset group.
	RoleArn *string

	// The name of the dataset group.
	Name *string

	// The last update date and time (in Unix time) of the dataset group.
	LastUpdatedDateTime *time.Time

	// If creating a dataset group fails, provides the reason why.
	FailureReason *string

	// 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
	Status *string

	// The creation date and time (in Unix time) of the dataset group.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
	KmsKeyArn *string

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string
}

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.

type DatasetGroupSummary 

type DatasetGroupSummary struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string

	// The name of the dataset group.
	Name *string

	// If creating a dataset group fails, the reason behind the failure.
	FailureReason *string

	// The date and time (in Unix time) that the dataset group was last updated.
	LastUpdatedDateTime *time.Time

	// The date and time (in Unix time) that the dataset group was created.
	CreationDateTime *time.Time

	// 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
	Status *string
}

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup () API.

type DatasetImportJob 

type DatasetImportJob struct {

	// 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
	Status *string

	// If a dataset import job fails, provides the reason why.
	FailureReason *string

	// The creation date and time (in Unix time) of the dataset import job.
	CreationDateTime *time.Time

	// The date and time (in Unix time) the dataset was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of the dataset that receives the imported data.
	DatasetArn *string

	// The name of the import job.
	JobName *string

	// The Amazon S3 bucket that contains the training data to import.
	DataSource *DataSource

	// The ARN of the dataset import job.
	DatasetImportJobArn *string

	// The ARN of the AWS Identity and Access Management (IAM) role that has
	// permissions to read from the Amazon S3 data source.
	RoleArn *string
}

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

type DatasetImportJobSummary 

type DatasetImportJobSummary struct {

	// The name of the dataset import job.
	JobName *string

	// If a dataset import job fails, the reason behind the failure.
	FailureReason *string

	// 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
	Status *string

	// The date and time (in Unix time) that the dataset import job was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the dataset import job.
	DatasetImportJobArn *string

	// The date and time (in Unix time) that the dataset was last updated.
	LastUpdatedDateTime *time.Time
}

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob () API.

type DatasetSchema 

type DatasetSchema struct {

	// The Amazon Resource Name (ARN) of the schema.
	SchemaArn *string

	// The schema.
	Schema *string

	// The date and time (in Unix time) that the schema was created.
	CreationDateTime *time.Time

	// The name of the schema.
	Name *string

	// The date and time (in Unix time) that the schema was last updated.
	LastUpdatedDateTime *time.Time
}

Describes the schema for a dataset. For more information on schemas, see CreateSchema ().

type DatasetSchemaSummary 

type DatasetSchemaSummary struct {

	// The name of the schema.
	Name *string

	// The date and time (in Unix time) that the schema was last updated.
	LastUpdatedDateTime *time.Time

	// The date and time (in Unix time) that the schema was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the schema.
	SchemaArn *string
}

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema () API.

type DatasetSummary 

type DatasetSummary struct {

	// The dataset type. One of the following values:
	//
	//     * Interactions
	//
	//     *
	// Items
	//
	//     * Users
	//
	//     * Event-Interactions
	DatasetType *string

	// The date and time (in Unix time) that the dataset was last updated.
	LastUpdatedDateTime *time.Time

	// The date and time (in Unix time) that the dataset was created.
	CreationDateTime *time.Time

	// 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
	Status *string

	// The name of the dataset.
	Name *string

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string
}

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset () API.

type DefaultCategoricalHyperParameterRange 

type DefaultCategoricalHyperParameterRange struct {

	// A list of the categories for the hyperparameter.
	Values []*string

	// Whether the hyperparameter is tunable.
	IsTunable *bool

	// The name of the hyperparameter.
	Name *string
}

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).

type DefaultContinuousHyperParameterRange 

type DefaultContinuousHyperParameterRange struct {

	// The minimum allowable value for the hyperparameter.
	MinValue *float64

	// The name of the hyperparameter.
	Name *string

	// Whether the hyperparameter is tunable.
	IsTunable *bool

	// The maximum allowable value for the hyperparameter.
	MaxValue *float64
}

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).

type DefaultHyperParameterRanges 

type DefaultHyperParameterRanges struct {

	// The integer-valued hyperparameters and their default ranges.
	IntegerHyperParameterRanges []*DefaultIntegerHyperParameterRange

	// The continuous hyperparameters and their default ranges.
	ContinuousHyperParameterRanges []*DefaultContinuousHyperParameterRange

	// The categorical hyperparameters and their default ranges.
	CategoricalHyperParameterRanges []*DefaultCategoricalHyperParameterRange
}

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

type DefaultIntegerHyperParameterRange 

type DefaultIntegerHyperParameterRange struct {

	// The name of the hyperparameter.
	Name *string

	// Indicates whether the hyperparameter is tunable.
	IsTunable *bool

	// The maximum allowable value for the hyperparameter.
	MaxValue *int32

	// The minimum allowable value for the hyperparameter.
	MinValue *int32
}

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).

type EventTracker 

type EventTracker struct {

	// The name of the event tracker.
	Name *string

	// The date and time (in Unix time) that the event tracker was last updated.
	LastUpdatedDateTime *time.Time

	// The ARN of the event tracker.
	EventTrackerArn *string

	// The date and time (in Unix format) that the event tracker was created.
	CreationDateTime *time.Time

	// 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
	Status *string

	// The ID of the event tracker. Include this ID in requests to the PutEvents
	// (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API.
	TrackingId *string

	// The Amazon AWS account that owns the event tracker.
	AccountId *string

	// The Amazon Resource Name (ARN) of the dataset group that receives the event
	// data.
	DatasetGroupArn *string
}

Provides information about an event tracker.

type EventTrackerSummary 

type EventTrackerSummary struct {

	// The date and time (in Unix time) that the event tracker was last updated.
	LastUpdatedDateTime *time.Time

	// The date and time (in Unix time) that the event tracker was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) of the event tracker.
	EventTrackerArn *string

	// 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
	Status *string

	// The name of the event tracker.
	Name *string
}

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker () API.

type FeatureTransformation 

type FeatureTransformation struct {

	// The name of the feature transformation.
	Name *string

	// The Amazon Resource Name (ARN) of the FeatureTransformation object.
	FeatureTransformationArn *string

	// The creation date and time (in Unix time) of the feature transformation.
	CreationDateTime *time.Time

	// The last update date and time (in Unix time) of the feature transformation.
	LastUpdatedDateTime *time.Time

	// Provides the default parameters for feature transformation.
	DefaultParameters map[string]*string

	// 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
	Status *string
}

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

type Filter 

type Filter struct {

	// The ARN of the dataset group to which the filter belongs.
	DatasetGroupArn *string

	// Specifies the type of item interactions to filter out of recommendation results.
	// The filter expression must follow the following format: EXCLUDE itemId WHERE
	// INTERACTIONS.event_type in ("EVENT_TYPE") Where "EVENT_TYPE" is the type of
	// event to filter out. For more information, see Using Filters with Amazon
	// Personalize.
	FilterExpression *string

	// If the filter failed, the reason for its failure.
	FailureReason *string

	// The time at which the filter was last updated.
	LastUpdatedDateTime *time.Time

	// The ARN of the filter.
	FilterArn *string

	// The name of the filter.
	Name *string

	// The status of the filter.
	Status *string

	// The time at which the filter was created.
	CreationDateTime *time.Time
}

Contains information on a recommendation filter, including its ARN, status, and filter expression.

type FilterSummary 

type FilterSummary struct {

	// The name of the filter.
	Name *string

	// The ARN of the dataset group to which the filter belongs.
	DatasetGroupArn *string

	// The time at which the filter was last updated.
	LastUpdatedDateTime *time.Time

	// The status of the filter.
	Status *string

	// The time at which the filter was created.
	CreationDateTime *time.Time

	// The ARN of the filter.
	FilterArn *string

	// If the filter failed, the reason for the failure.
	FailureReason *string
}

A short summary of a filter's attributes.

type HPOConfig 

type HPOConfig struct {

	// Describes the resource configuration for HPO.
	HpoResourceConfig *HPOResourceConfig

	// The hyperparameters and their allowable ranges.
	AlgorithmHyperParameterRanges *HyperParameterRanges

	// The metric to optimize during HPO.
	HpoObjective *HPOObjective
}

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

type HPOObjective 

type HPOObjective struct {

	// The name of the metric.
	MetricName *string

	// The type of the metric. Valid values are Maximize and Minimize.
	Type *string

	// A regular expression for finding the metric in the training job logs.
	MetricRegex *string
}

The metric to optimize during hyperparameter optimization (HPO).

type HPOResourceConfig 

type HPOResourceConfig struct {

	// The maximum number of parallel training jobs when you create a solution version.
	// The maximum value for maxParallelTrainingJobs is 10.
	MaxParallelTrainingJobs *string

	// The maximum number of training jobs when you create a solution version. The
	// maximum value for maxNumberOfTrainingJobs is 40.
	MaxNumberOfTrainingJobs *string
}

Describes the resource configuration for hyperparameter optimization (HPO).

type HyperParameterRanges 

type HyperParameterRanges struct {

	// The continuous hyperparameters and their ranges.
	ContinuousHyperParameterRanges []*ContinuousHyperParameterRange

	// The categorical hyperparameters and their ranges.
	CategoricalHyperParameterRanges []*CategoricalHyperParameterRange

	// The integer-valued hyperparameters and their ranges.
	IntegerHyperParameterRanges []*IntegerHyperParameterRange
}

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

type IntegerHyperParameterRange 

type IntegerHyperParameterRange struct {

	// The maximum allowable value for the hyperparameter.
	MaxValue *int32

	// The minimum allowable value for the hyperparameter.
	MinValue *int32

	// The name of the hyperparameter.
	Name *string
}

Provides the name and range of an integer-valued hyperparameter.

type InvalidInputException 

type InvalidInputException struct {
	Message *string
}

Provide a valid value for the field or parameter.

func (*InvalidInputException) Error 

func (e *InvalidInputException) Error() string

func (*InvalidInputException) ErrorCode 

func (e *InvalidInputException) ErrorCode() string

func (*InvalidInputException) ErrorFault 

func (e *InvalidInputException) ErrorFault() smithy.ErrorFault

func (*InvalidInputException) ErrorMessage 

func (e *InvalidInputException) ErrorMessage() string

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	Message *string
}

The token is not valid.

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string
}

The limit on the number of requests per second has been exceeded.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type Recipe 

type Recipe struct {

	// One of the following values:
	//
	//     * PERSONALIZED_RANKING
	//
	//     * RELATED_ITEMS
	//
	//
	// * USER_PERSONALIZATION
	RecipeType *string

	// The name of the recipe.
	Name *string

	// The date and time (in Unix format) that the recipe was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of the recipe.
	RecipeArn *string

	// The date and time (in Unix format) that the recipe was created.
	CreationDateTime *time.Time

	// The status of the recipe.
	Status *string

	// The ARN of the FeatureTransformation object.
	FeatureTransformationArn *string

	// The description of the recipe.
	Description *string

	// The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to
	// train the model.
	AlgorithmArn *string
}

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution () operation.

type RecipeProvider 

type RecipeProvider string
const (
	RecipeProviderService RecipeProvider = "SERVICE"
)

Enum values for RecipeProvider

type RecipeSummary 

type RecipeSummary struct {

	// The date and time (in Unix time) that the recipe was created.
	CreationDateTime *time.Time

	// The status of the recipe.
	Status *string

	// The date and time (in Unix time) that the recipe was last updated.
	LastUpdatedDateTime *time.Time

	// The Amazon Resource Name (ARN) of the recipe.
	RecipeArn *string

	// The name of the recipe.
	Name *string
}

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe () API.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string
}

The specified resource is in use.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

Could not find the specified resource.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3DataConfig 

type S3DataConfig struct {

	// The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key
	// that Amazon Personalize uses to encrypt or decrypt the input and output files of
	// a batch inference job.
	KmsKeyArn *string

	// The file path of the Amazon S3 bucket.
	//
	// This member is required.
	Path *string
}

The configuration details of an Amazon S3 input or output bucket.

type Solution 

type Solution struct {

	// 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
	Status *string

	// Describes the configuration properties for the solution.
	SolutionConfig *SolutionConfig

	// 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.
	PerformAutoML *bool

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time

	// Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The
	// default is false.
	PerformHPO *bool

	// The Amazon Resource Name (ARN) of the dataset group that provides the training
	// data.
	DatasetGroupArn *string

	// The creation date and time (in Unix time) of the solution.
	CreationDateTime *time.Time

	// The name of the solution.
	Name *string

	// The ARN of the recipe used to create the solution.
	RecipeArn *string

	// Describes the latest version of the solution, including the status and the ARN.
	LatestSolutionVersion *SolutionVersionSummary

	// When performAutoML is true, specifies the best recipe found.
	AutoMLResult *AutoMLResult

	// The ARN of the solution.
	SolutionArn *string

	// The event type (for example, 'click' or 'like') that is used for training the
	// model.
	EventType *string
}

An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.

type SolutionConfig 

type SolutionConfig struct {

	// Only events with a value greater than or equal to this threshold are used for
	// training a model.
	EventValueThreshold *string

	// The AutoMLConfig () object containing a list of recipes to search when AutoML is
	// performed.
	AutoMLConfig *AutoMLConfig

	// Lists the feature transformation parameters.
	FeatureTransformationParameters map[string]*string

	// Describes the properties for hyperparameter optimization (HPO).
	HpoConfig *HPOConfig

	// Lists the hyperparameter names and ranges.
	AlgorithmHyperParameters map[string]*string
}

Describes the configuration properties for the solution.

type SolutionSummary 

type SolutionSummary struct {

	// The Amazon Resource Name (ARN) of the solution.
	SolutionArn *string

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time

	// 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
	Status *string

	// The date and time (in Unix time) that the solution was created.
	CreationDateTime *time.Time

	// The name of the solution.
	Name *string
}

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution () API.

type SolutionVersion 

type SolutionVersion struct {

	// Describes the configuration properties for the solution.
	SolutionConfig *SolutionConfig

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time

	// 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
	Status *string

	// If hyperparameter optimization was performed, contains the hyperparameter values
	// of the best performing model.
	TunedHPOParams *TunedHPOParams

	// Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The
	// default is false.
	PerformHPO *bool

	// When true, Amazon Personalize searches for the most optimal recipe according to
	// the solution configuration. When false (the default), Amazon Personalize uses
	// recipeArn.
	PerformAutoML *bool

	// The scope of training used to create 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 training data that has
	// changed since the creation of the last solution version. Choose UPDATE when you
	// want to start recommending items added to the dataset without retraining the
	// model. The UPDATE option can only be used after you've created a solution
	// version with the FULL option and the training solution uses the
	// native-recipe-hrnn-coldstart ().
	TrainingMode TrainingMode

	// 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.
	TrainingHours *float64

	// If training a solution version fails, the reason for the failure.
	FailureReason *string

	// The date and time (in Unix time) that this version of the solution was created.
	CreationDateTime *time.Time

	// The event type (for example, 'click' or 'like') that is used for training the
	// model.
	EventType *string

	// The ARN of the solution.
	SolutionArn *string

	// The ARN of the recipe used in the solution.
	RecipeArn *string

	// The ARN of the solution version.
	SolutionVersionArn *string

	// The Amazon Resource Name (ARN) of the dataset group providing the training data.
	DatasetGroupArn *string
}

An object that provides information about a specific version of a Solution ().

type SolutionVersionSummary 

type SolutionVersionSummary struct {

	// The date and time (in Unix time) that the solution version was last updated.
	LastUpdatedDateTime *time.Time

	// The date and time (in Unix time) that this version of a solution was created.
	CreationDateTime *time.Time

	// 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
	Status *string

	// If a solution version fails, the reason behind the failure.
	FailureReason *string

	// The Amazon Resource Name (ARN) of the solution version.
	SolutionVersionArn *string
}

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion () API.

type TrainingMode 

type TrainingMode string
const (
	TrainingModeFull   TrainingMode = "FULL"
	TrainingModeUpdate TrainingMode = "UPDATE"
)

Enum values for TrainingMode

type TunedHPOParams 

type TunedHPOParams struct {

	// A list of the hyperparameter values of the best performing model.
	AlgorithmHyperParameters map[string]*string
}

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.