personalize

package
v1.34.25 Latest Latest
Warning

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

Go to latest
Published: Sep 16, 2020 License: Apache-2.0 Imports: 10 Imported by: 27

Documentation

Overview

Package personalize provides the client and types for making API requests to Amazon Personalize.

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

See https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22 for more information on this service.

See personalize package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/personalize/

Using the Client

To contact Amazon Personalize with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Personalize client Personalize for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/personalize/#New

Index

Constants

View Source
const (
	// TrainingModeFull is a TrainingMode enum value
	TrainingModeFull = "FULL"

	// TrainingModeUpdate is a TrainingMode enum value
	TrainingModeUpdate = "UPDATE"
)
View Source
const (

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// Provide a valid value for the field or parameter.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The token is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The limit on the number of requests per second has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The specified resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Could not find the specified resource.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source
const (
	ServiceName = "Personalize" // Name of service.
	EndpointsID = "personalize" // ID to lookup a service endpoint with.
	ServiceID   = "Personalize" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// RecipeProviderService is a RecipeProvider enum value
	RecipeProviderService = "SERVICE"
)

Variables

This section is empty.

Functions

func RecipeProvider_Values added in v1.34.3

func RecipeProvider_Values() []string

RecipeProvider_Values returns all elements of the RecipeProvider enum

func TrainingMode_Values added in v1.34.3

func TrainingMode_Values() []string

TrainingMode_Values returns all elements of the TrainingMode enum

Types

type Algorithm

type Algorithm struct {

	// The Amazon Resource Name (ARN) of the algorithm.
	AlgorithmArn *string `locationName:"algorithmArn" type:"string"`

	// The URI of the Docker container for the algorithm image.
	AlgorithmImage *AlgorithmImage `locationName:"algorithmImage" type:"structure"`

	// The date and time (in Unix time) that the algorithm was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// 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 `locationName:"defaultHyperParameterRanges" type:"structure"`

	// Specifies the default hyperparameters.
	DefaultHyperParameters map[string]*string `locationName:"defaultHyperParameters" type:"map"`

	// Specifies the default maximum number of training jobs and parallel training
	// jobs.
	DefaultResourceConfig map[string]*string `locationName:"defaultResourceConfig" type:"map"`

	// The date and time (in Unix time) that the algorithm was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the algorithm.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the role.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The training input mode.
	TrainingInputMode *string `locationName:"trainingInputMode" type:"string"`
	// contains filtered or unexported fields
}

Describes a custom algorithm.

func (Algorithm) GoString

func (s Algorithm) GoString() string

GoString returns the string representation

func (*Algorithm) SetAlgorithmArn

func (s *Algorithm) SetAlgorithmArn(v string) *Algorithm

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*Algorithm) SetAlgorithmImage

func (s *Algorithm) SetAlgorithmImage(v *AlgorithmImage) *Algorithm

SetAlgorithmImage sets the AlgorithmImage field's value.

func (*Algorithm) SetCreationDateTime

func (s *Algorithm) SetCreationDateTime(v time.Time) *Algorithm

SetCreationDateTime sets the CreationDateTime field's value.

func (*Algorithm) SetDefaultHyperParameterRanges

func (s *Algorithm) SetDefaultHyperParameterRanges(v *DefaultHyperParameterRanges) *Algorithm

SetDefaultHyperParameterRanges sets the DefaultHyperParameterRanges field's value.

func (*Algorithm) SetDefaultHyperParameters

func (s *Algorithm) SetDefaultHyperParameters(v map[string]*string) *Algorithm

SetDefaultHyperParameters sets the DefaultHyperParameters field's value.

func (*Algorithm) SetDefaultResourceConfig

func (s *Algorithm) SetDefaultResourceConfig(v map[string]*string) *Algorithm

SetDefaultResourceConfig sets the DefaultResourceConfig field's value.

func (*Algorithm) SetLastUpdatedDateTime

func (s *Algorithm) SetLastUpdatedDateTime(v time.Time) *Algorithm

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Algorithm) SetName

func (s *Algorithm) SetName(v string) *Algorithm

SetName sets the Name field's value.

func (*Algorithm) SetRoleArn

func (s *Algorithm) SetRoleArn(v string) *Algorithm

SetRoleArn sets the RoleArn field's value.

func (*Algorithm) SetTrainingInputMode

func (s *Algorithm) SetTrainingInputMode(v string) *Algorithm

SetTrainingInputMode sets the TrainingInputMode field's value.

func (Algorithm) String

func (s Algorithm) String() string

String returns the string representation

type AlgorithmImage

type AlgorithmImage struct {

	// The URI of the Docker container for the algorithm image.
	//
	// DockerURI is a required field
	DockerURI *string `locationName:"dockerURI" type:"string" required:"true"`

	// The name of the algorithm image.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an algorithm image.

func (AlgorithmImage) GoString

func (s AlgorithmImage) GoString() string

GoString returns the string representation

func (*AlgorithmImage) SetDockerURI

func (s *AlgorithmImage) SetDockerURI(v string) *AlgorithmImage

SetDockerURI sets the DockerURI field's value.

func (*AlgorithmImage) SetName

func (s *AlgorithmImage) SetName(v string) *AlgorithmImage

SetName sets the Name field's value.

func (AlgorithmImage) String

func (s AlgorithmImage) String() string

String returns the string representation

type AutoMLConfig

type AutoMLConfig struct {

	// The metric to optimize.
	MetricName *string `locationName:"metricName" type:"string"`

	// The list of candidate recipes.
	RecipeList []*string `locationName:"recipeList" type:"list"`
	// contains filtered or unexported fields
}

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.

func (AutoMLConfig) GoString

func (s AutoMLConfig) GoString() string

GoString returns the string representation

func (*AutoMLConfig) SetMetricName

func (s *AutoMLConfig) SetMetricName(v string) *AutoMLConfig

SetMetricName sets the MetricName field's value.

func (*AutoMLConfig) SetRecipeList

func (s *AutoMLConfig) SetRecipeList(v []*string) *AutoMLConfig

SetRecipeList sets the RecipeList field's value.

func (AutoMLConfig) String

func (s AutoMLConfig) String() string

String returns the string representation

type AutoMLResult

type AutoMLResult struct {

	// The Amazon Resource Name (ARN) of the best recipe.
	BestRecipeArn *string `locationName:"bestRecipeArn" type:"string"`
	// contains filtered or unexported fields
}

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

func (AutoMLResult) GoString

func (s AutoMLResult) GoString() string

GoString returns the string representation

func (*AutoMLResult) SetBestRecipeArn

func (s *AutoMLResult) SetBestRecipeArn(v string) *AutoMLResult

SetBestRecipeArn sets the BestRecipeArn field's value.

func (AutoMLResult) String

func (s AutoMLResult) String() string

String returns the string representation

type BatchInferenceJob added in v1.25.35

type BatchInferenceJob struct {

	// The Amazon Resource Name (ARN) of the batch inference job.
	BatchInferenceJobArn *string `locationName:"batchInferenceJobArn" type:"string"`

	// A string to string map of the configuration details of a batch inference
	// job.
	BatchInferenceJobConfig *BatchInferenceJobConfig `locationName:"batchInferenceJobConfig" type:"structure"`

	// The time at which the batch inference job was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If the batch inference job failed, the reason for the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The ARN of the filter used on the batch inference job.
	FilterArn *string `locationName:"filterArn" type:"string"`

	// The Amazon S3 path that leads to the input data used to generate the batch
	// inference job.
	JobInput *BatchInferenceJobInput `locationName:"jobInput" type:"structure"`

	// The name of the batch inference job.
	JobName *string `locationName:"jobName" min:"1" type:"string"`

	// The Amazon S3 bucket that contains the output data generated by the batch
	// inference job.
	JobOutput *BatchInferenceJobOutput `locationName:"jobOutput" type:"structure"`

	// The time at which the batch inference job was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The number of recommendations generated by the batch inference job. This
	// number includes the error messages generated for failed input records.
	NumResults *int64 `locationName:"numResults" type:"integer"`

	// The ARN of the Amazon Identity and Access Management (IAM) role that requested
	// the batch inference job.
	RoleArn *string `locationName:"roleArn" type:"string"`

	// The Amazon Resource Name (ARN) of the solution version from which the batch
	// inference job was created.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`

	// The status of the batch inference job. The status is one of the following
	// values:
	//
	//    * PENDING
	//
	//    * IN PROGRESS
	//
	//    * ACTIVE
	//
	//    * CREATE FAILED
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

Contains information on a batch inference job.

func (BatchInferenceJob) GoString added in v1.25.35

func (s BatchInferenceJob) GoString() string

GoString returns the string representation

func (*BatchInferenceJob) SetBatchInferenceJobArn added in v1.25.35

func (s *BatchInferenceJob) SetBatchInferenceJobArn(v string) *BatchInferenceJob

SetBatchInferenceJobArn sets the BatchInferenceJobArn field's value.

func (*BatchInferenceJob) SetBatchInferenceJobConfig added in v1.33.21

func (s *BatchInferenceJob) SetBatchInferenceJobConfig(v *BatchInferenceJobConfig) *BatchInferenceJob

SetBatchInferenceJobConfig sets the BatchInferenceJobConfig field's value.

func (*BatchInferenceJob) SetCreationDateTime added in v1.25.35

func (s *BatchInferenceJob) SetCreationDateTime(v time.Time) *BatchInferenceJob

SetCreationDateTime sets the CreationDateTime field's value.

func (*BatchInferenceJob) SetFailureReason added in v1.25.35

func (s *BatchInferenceJob) SetFailureReason(v string) *BatchInferenceJob

SetFailureReason sets the FailureReason field's value.

func (*BatchInferenceJob) SetFilterArn added in v1.31.12

func (s *BatchInferenceJob) SetFilterArn(v string) *BatchInferenceJob

SetFilterArn sets the FilterArn field's value.

func (*BatchInferenceJob) SetJobInput added in v1.25.35

SetJobInput sets the JobInput field's value.

func (*BatchInferenceJob) SetJobName added in v1.25.35

func (s *BatchInferenceJob) SetJobName(v string) *BatchInferenceJob

SetJobName sets the JobName field's value.

func (*BatchInferenceJob) SetJobOutput added in v1.25.35

SetJobOutput sets the JobOutput field's value.

func (*BatchInferenceJob) SetLastUpdatedDateTime added in v1.25.35

func (s *BatchInferenceJob) SetLastUpdatedDateTime(v time.Time) *BatchInferenceJob

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*BatchInferenceJob) SetNumResults added in v1.25.35

func (s *BatchInferenceJob) SetNumResults(v int64) *BatchInferenceJob

SetNumResults sets the NumResults field's value.

func (*BatchInferenceJob) SetRoleArn added in v1.25.35

func (s *BatchInferenceJob) SetRoleArn(v string) *BatchInferenceJob

SetRoleArn sets the RoleArn field's value.

func (*BatchInferenceJob) SetSolutionVersionArn added in v1.25.35

func (s *BatchInferenceJob) SetSolutionVersionArn(v string) *BatchInferenceJob

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*BatchInferenceJob) SetStatus added in v1.25.35

func (s *BatchInferenceJob) SetStatus(v string) *BatchInferenceJob

SetStatus sets the Status field's value.

func (BatchInferenceJob) String added in v1.25.35

func (s BatchInferenceJob) String() string

String returns the string representation

type BatchInferenceJobConfig added in v1.33.21

type BatchInferenceJobConfig struct {

	// A string to string map specifying the inference hyperparameters you wish
	// to use for hyperparameter optimization. See customizing-solution-config-hpo.
	ItemExplorationConfig map[string]*string `locationName:"itemExplorationConfig" type:"map"`
	// contains filtered or unexported fields
}

The configuration details of a batch inference job.

func (BatchInferenceJobConfig) GoString added in v1.33.21

func (s BatchInferenceJobConfig) GoString() string

GoString returns the string representation

func (*BatchInferenceJobConfig) SetItemExplorationConfig added in v1.33.21

func (s *BatchInferenceJobConfig) SetItemExplorationConfig(v map[string]*string) *BatchInferenceJobConfig

SetItemExplorationConfig sets the ItemExplorationConfig field's value.

func (BatchInferenceJobConfig) String added in v1.33.21

func (s BatchInferenceJobConfig) String() string

String returns the string representation

type BatchInferenceJobInput added in v1.25.35

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.
	//
	// S3DataSource is a required field
	S3DataSource *S3DataConfig `locationName:"s3DataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input configuration of a batch inference job.

func (BatchInferenceJobInput) GoString added in v1.25.35

func (s BatchInferenceJobInput) GoString() string

GoString returns the string representation

func (*BatchInferenceJobInput) SetS3DataSource added in v1.25.35

SetS3DataSource sets the S3DataSource field's value.

func (BatchInferenceJobInput) String added in v1.25.35

func (s BatchInferenceJobInput) String() string

String returns the string representation

func (*BatchInferenceJobInput) Validate added in v1.25.35

func (s *BatchInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchInferenceJobOutput added in v1.25.35

type BatchInferenceJobOutput struct {

	// Information on the Amazon S3 bucket in which the batch inference job's output
	// is stored.
	//
	// S3DataDestination is a required field
	S3DataDestination *S3DataConfig `locationName:"s3DataDestination" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The output configuration parameters of a batch inference job.

func (BatchInferenceJobOutput) GoString added in v1.25.35

func (s BatchInferenceJobOutput) GoString() string

GoString returns the string representation

func (*BatchInferenceJobOutput) SetS3DataDestination added in v1.25.35

func (s *BatchInferenceJobOutput) SetS3DataDestination(v *S3DataConfig) *BatchInferenceJobOutput

SetS3DataDestination sets the S3DataDestination field's value.

func (BatchInferenceJobOutput) String added in v1.25.35

func (s BatchInferenceJobOutput) String() string

String returns the string representation

func (*BatchInferenceJobOutput) Validate added in v1.25.35

func (s *BatchInferenceJobOutput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchInferenceJobSummary added in v1.25.35

type BatchInferenceJobSummary struct {

	// The Amazon Resource Name (ARN) of the batch inference job.
	BatchInferenceJobArn *string `locationName:"batchInferenceJobArn" type:"string"`

	// The time at which the batch inference job was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If the batch inference job failed, the reason for the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The name of the batch inference job.
	JobName *string `locationName:"jobName" min:"1" type:"string"`

	// The time at which the batch inference job was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The ARN of the solution version used by the batch inference job.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`

	// The status of the batch inference job. The status is one of the following
	// values:
	//
	//    * PENDING
	//
	//    * IN PROGRESS
	//
	//    * ACTIVE
	//
	//    * CREATE FAILED
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (BatchInferenceJobSummary) GoString added in v1.25.35

func (s BatchInferenceJobSummary) GoString() string

GoString returns the string representation

func (*BatchInferenceJobSummary) SetBatchInferenceJobArn added in v1.25.35

func (s *BatchInferenceJobSummary) SetBatchInferenceJobArn(v string) *BatchInferenceJobSummary

SetBatchInferenceJobArn sets the BatchInferenceJobArn field's value.

func (*BatchInferenceJobSummary) SetCreationDateTime added in v1.25.35

func (s *BatchInferenceJobSummary) SetCreationDateTime(v time.Time) *BatchInferenceJobSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*BatchInferenceJobSummary) SetFailureReason added in v1.25.35

SetFailureReason sets the FailureReason field's value.

func (*BatchInferenceJobSummary) SetJobName added in v1.25.35

SetJobName sets the JobName field's value.

func (*BatchInferenceJobSummary) SetLastUpdatedDateTime added in v1.25.35

func (s *BatchInferenceJobSummary) SetLastUpdatedDateTime(v time.Time) *BatchInferenceJobSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*BatchInferenceJobSummary) SetSolutionVersionArn added in v1.29.27

func (s *BatchInferenceJobSummary) SetSolutionVersionArn(v string) *BatchInferenceJobSummary

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*BatchInferenceJobSummary) SetStatus added in v1.25.35

SetStatus sets the Status field's value.

func (BatchInferenceJobSummary) String added in v1.25.35

func (s BatchInferenceJobSummary) String() string

String returns the string representation

type Campaign

type Campaign struct {

	// The Amazon Resource Name (ARN) of the campaign.
	CampaignArn *string `locationName:"campaignArn" type:"string"`

	// The configuration details of a campaign.
	CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"`

	// The date and time (in Unix format) that the campaign was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If a campaign fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix format) that the campaign was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// Provides a summary of the properties of a campaign update. For a complete
	// listing, call the DescribeCampaign API.
	LatestCampaignUpdate *CampaignUpdateSummary `locationName:"latestCampaignUpdate" type:"structure"`

	// Specifies the requested minimum provisioned transactions (recommendations)
	// per second.
	MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"`

	// The name of the campaign.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of a specific version of the solution.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (Campaign) GoString

func (s Campaign) GoString() string

GoString returns the string representation

func (*Campaign) SetCampaignArn

func (s *Campaign) SetCampaignArn(v string) *Campaign

SetCampaignArn sets the CampaignArn field's value.

func (*Campaign) SetCampaignConfig added in v1.33.21

func (s *Campaign) SetCampaignConfig(v *CampaignConfig) *Campaign

SetCampaignConfig sets the CampaignConfig field's value.

func (*Campaign) SetCreationDateTime

func (s *Campaign) SetCreationDateTime(v time.Time) *Campaign

SetCreationDateTime sets the CreationDateTime field's value.

func (*Campaign) SetFailureReason

func (s *Campaign) SetFailureReason(v string) *Campaign

SetFailureReason sets the FailureReason field's value.

func (*Campaign) SetLastUpdatedDateTime

func (s *Campaign) SetLastUpdatedDateTime(v time.Time) *Campaign

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Campaign) SetLatestCampaignUpdate

func (s *Campaign) SetLatestCampaignUpdate(v *CampaignUpdateSummary) *Campaign

SetLatestCampaignUpdate sets the LatestCampaignUpdate field's value.

func (*Campaign) SetMinProvisionedTPS

func (s *Campaign) SetMinProvisionedTPS(v int64) *Campaign

SetMinProvisionedTPS sets the MinProvisionedTPS field's value.

func (*Campaign) SetName

func (s *Campaign) SetName(v string) *Campaign

SetName sets the Name field's value.

func (*Campaign) SetSolutionVersionArn

func (s *Campaign) SetSolutionVersionArn(v string) *Campaign

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*Campaign) SetStatus

func (s *Campaign) SetStatus(v string) *Campaign

SetStatus sets the Status field's value.

func (Campaign) String

func (s Campaign) String() string

String returns the string representation

type CampaignConfig added in v1.33.21

type CampaignConfig struct {

	// A string to string map specifying the inference hyperparameters you wish
	// to use for hyperparameter optimization. See customizing-solution-config-hpo.
	ItemExplorationConfig map[string]*string `locationName:"itemExplorationConfig" type:"map"`
	// contains filtered or unexported fields
}

The configuration details of a campaign.

func (CampaignConfig) GoString added in v1.33.21

func (s CampaignConfig) GoString() string

GoString returns the string representation

func (*CampaignConfig) SetItemExplorationConfig added in v1.33.21

func (s *CampaignConfig) SetItemExplorationConfig(v map[string]*string) *CampaignConfig

SetItemExplorationConfig sets the ItemExplorationConfig field's value.

func (CampaignConfig) String added in v1.33.21

func (s CampaignConfig) String() string

String returns the string representation

type CampaignSummary

type CampaignSummary struct {

	// The Amazon Resource Name (ARN) of the campaign.
	CampaignArn *string `locationName:"campaignArn" type:"string"`

	// The date and time (in Unix time) that the campaign was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If a campaign fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix time) that the campaign was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the campaign.
	Name *string `locationName:"name" min:"1" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (CampaignSummary) GoString

func (s CampaignSummary) GoString() string

GoString returns the string representation

func (*CampaignSummary) SetCampaignArn

func (s *CampaignSummary) SetCampaignArn(v string) *CampaignSummary

SetCampaignArn sets the CampaignArn field's value.

func (*CampaignSummary) SetCreationDateTime

func (s *CampaignSummary) SetCreationDateTime(v time.Time) *CampaignSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*CampaignSummary) SetFailureReason

func (s *CampaignSummary) SetFailureReason(v string) *CampaignSummary

SetFailureReason sets the FailureReason field's value.

func (*CampaignSummary) SetLastUpdatedDateTime

func (s *CampaignSummary) SetLastUpdatedDateTime(v time.Time) *CampaignSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*CampaignSummary) SetName

func (s *CampaignSummary) SetName(v string) *CampaignSummary

SetName sets the Name field's value.

func (*CampaignSummary) SetStatus

func (s *CampaignSummary) SetStatus(v string) *CampaignSummary

SetStatus sets the Status field's value.

func (CampaignSummary) String

func (s CampaignSummary) String() string

String returns the string representation

type CampaignUpdateSummary

type CampaignUpdateSummary struct {

	// The configuration details of a campaign.
	CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"`

	// The date and time (in Unix time) that the campaign update was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If a campaign update fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix time) that the campaign update was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// Specifies the requested minimum provisioned transactions (recommendations)
	// per second that Amazon Personalize will support.
	MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) of the deployed solution version.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (CampaignUpdateSummary) GoString

func (s CampaignUpdateSummary) GoString() string

GoString returns the string representation

func (*CampaignUpdateSummary) SetCampaignConfig added in v1.33.21

SetCampaignConfig sets the CampaignConfig field's value.

func (*CampaignUpdateSummary) SetCreationDateTime

func (s *CampaignUpdateSummary) SetCreationDateTime(v time.Time) *CampaignUpdateSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*CampaignUpdateSummary) SetFailureReason

func (s *CampaignUpdateSummary) SetFailureReason(v string) *CampaignUpdateSummary

SetFailureReason sets the FailureReason field's value.

func (*CampaignUpdateSummary) SetLastUpdatedDateTime

func (s *CampaignUpdateSummary) SetLastUpdatedDateTime(v time.Time) *CampaignUpdateSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*CampaignUpdateSummary) SetMinProvisionedTPS

func (s *CampaignUpdateSummary) SetMinProvisionedTPS(v int64) *CampaignUpdateSummary

SetMinProvisionedTPS sets the MinProvisionedTPS field's value.

func (*CampaignUpdateSummary) SetSolutionVersionArn

func (s *CampaignUpdateSummary) SetSolutionVersionArn(v string) *CampaignUpdateSummary

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*CampaignUpdateSummary) SetStatus

SetStatus sets the Status field's value.

func (CampaignUpdateSummary) String

func (s CampaignUpdateSummary) String() string

String returns the string representation

type CategoricalHyperParameterRange

type CategoricalHyperParameterRange struct {

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`

	// A list of the categories for the hyperparameter.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Provides the name and range of a categorical hyperparameter.

func (CategoricalHyperParameterRange) GoString

GoString returns the string representation

func (*CategoricalHyperParameterRange) SetName

SetName sets the Name field's value.

func (*CategoricalHyperParameterRange) SetValues

SetValues sets the Values field's value.

func (CategoricalHyperParameterRange) String

String returns the string representation

type ContinuousHyperParameterRange

type ContinuousHyperParameterRange struct {

	// The maximum allowable value for the hyperparameter.
	MaxValue *float64 `locationName:"maxValue" type:"double"`

	// The minimum allowable value for the hyperparameter.
	MinValue *float64 `locationName:"minValue" type:"double"`

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Provides the name and range of a continuous hyperparameter.

func (ContinuousHyperParameterRange) GoString

GoString returns the string representation

func (*ContinuousHyperParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*ContinuousHyperParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*ContinuousHyperParameterRange) SetName

SetName sets the Name field's value.

func (ContinuousHyperParameterRange) String

String returns the string representation

func (*ContinuousHyperParameterRange) Validate

func (s *ContinuousHyperParameterRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBatchInferenceJobInput added in v1.25.35

type CreateBatchInferenceJobInput struct {

	// The configuration details of a batch inference job.
	BatchInferenceJobConfig *BatchInferenceJobConfig `locationName:"batchInferenceJobConfig" type:"structure"`

	// The ARN of the filter to apply to the batch inference job. For more information
	// on using filters, see Using Filters with Amazon Personalize.
	FilterArn *string `locationName:"filterArn" type:"string"`

	// The Amazon S3 path that leads to the input file to base your recommendations
	// on. The input material must be in JSON format.
	//
	// JobInput is a required field
	JobInput *BatchInferenceJobInput `locationName:"jobInput" type:"structure" required:"true"`

	// The name of the batch inference job to create.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The path to the Amazon S3 bucket where the job's output will be stored.
	//
	// JobOutput is a required field
	JobOutput *BatchInferenceJobOutput `locationName:"jobOutput" type:"structure" required:"true"`

	// The number of recommendations to retreive.
	NumResults *int64 `locationName:"numResults" type:"integer"`

	// The ARN of the Amazon Identity and Access Management role that has permissions
	// to read and write to your input and out Amazon S3 buckets respectively.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the solution version that will be used
	// to generate the batch inference recommendations.
	//
	// SolutionVersionArn is a required field
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBatchInferenceJobInput) GoString added in v1.25.35

func (s CreateBatchInferenceJobInput) GoString() string

GoString returns the string representation

func (*CreateBatchInferenceJobInput) SetBatchInferenceJobConfig added in v1.33.21

SetBatchInferenceJobConfig sets the BatchInferenceJobConfig field's value.

func (*CreateBatchInferenceJobInput) SetFilterArn added in v1.31.12

SetFilterArn sets the FilterArn field's value.

func (*CreateBatchInferenceJobInput) SetJobInput added in v1.25.35

SetJobInput sets the JobInput field's value.

func (*CreateBatchInferenceJobInput) SetJobName added in v1.25.35

SetJobName sets the JobName field's value.

func (*CreateBatchInferenceJobInput) SetJobOutput added in v1.25.35

SetJobOutput sets the JobOutput field's value.

func (*CreateBatchInferenceJobInput) SetNumResults added in v1.25.35

SetNumResults sets the NumResults field's value.

func (*CreateBatchInferenceJobInput) SetRoleArn added in v1.25.35

SetRoleArn sets the RoleArn field's value.

func (*CreateBatchInferenceJobInput) SetSolutionVersionArn added in v1.25.35

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (CreateBatchInferenceJobInput) String added in v1.25.35

String returns the string representation

func (*CreateBatchInferenceJobInput) Validate added in v1.25.35

func (s *CreateBatchInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBatchInferenceJobOutput added in v1.25.35

type CreateBatchInferenceJobOutput struct {

	// The ARN of the batch inference job.
	BatchInferenceJobArn *string `locationName:"batchInferenceJobArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateBatchInferenceJobOutput) GoString added in v1.25.35

GoString returns the string representation

func (*CreateBatchInferenceJobOutput) SetBatchInferenceJobArn added in v1.25.35

SetBatchInferenceJobArn sets the BatchInferenceJobArn field's value.

func (CreateBatchInferenceJobOutput) String added in v1.25.35

String returns the string representation

type CreateCampaignInput

type CreateCampaignInput struct {

	// The configuration details of a campaign.
	CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"`

	// Specifies the requested minimum provisioned transactions (recommendations)
	// per second that Amazon Personalize will support.
	//
	// MinProvisionedTPS is a required field
	MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer" required:"true"`

	// A name for the new campaign. The campaign name must be unique within your
	// account.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the solution version to deploy.
	//
	// SolutionVersionArn is a required field
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCampaignInput) GoString

func (s CreateCampaignInput) GoString() string

GoString returns the string representation

func (*CreateCampaignInput) SetCampaignConfig added in v1.33.21

func (s *CreateCampaignInput) SetCampaignConfig(v *CampaignConfig) *CreateCampaignInput

SetCampaignConfig sets the CampaignConfig field's value.

func (*CreateCampaignInput) SetMinProvisionedTPS

func (s *CreateCampaignInput) SetMinProvisionedTPS(v int64) *CreateCampaignInput

SetMinProvisionedTPS sets the MinProvisionedTPS field's value.

func (*CreateCampaignInput) SetName

SetName sets the Name field's value.

func (*CreateCampaignInput) SetSolutionVersionArn

func (s *CreateCampaignInput) SetSolutionVersionArn(v string) *CreateCampaignInput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (CreateCampaignInput) String

func (s CreateCampaignInput) String() string

String returns the string representation

func (*CreateCampaignInput) Validate

func (s *CreateCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCampaignOutput

type CreateCampaignOutput struct {

	// The Amazon Resource Name (ARN) of the campaign.
	CampaignArn *string `locationName:"campaignArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCampaignOutput) GoString

func (s CreateCampaignOutput) GoString() string

GoString returns the string representation

func (*CreateCampaignOutput) SetCampaignArn

func (s *CreateCampaignOutput) SetCampaignArn(v string) *CreateCampaignOutput

SetCampaignArn sets the CampaignArn field's value.

func (CreateCampaignOutput) String

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateDatasetGroupInput

type CreateDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
	KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"`

	// The name for the new dataset group.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The ARN of the IAM role that has permissions to access the KMS key. Supplying
	// an IAM role is only valid when also specifying a KMS key.
	RoleArn *string `locationName:"roleArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetGroupInput) GoString

func (s CreateDatasetGroupInput) GoString() string

GoString returns the string representation

func (*CreateDatasetGroupInput) SetKmsKeyArn

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateDatasetGroupInput) SetName

SetName sets the Name field's value.

func (*CreateDatasetGroupInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (CreateDatasetGroupInput) String

func (s CreateDatasetGroupInput) String() string

String returns the string representation

func (*CreateDatasetGroupInput) Validate

func (s *CreateDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetGroupOutput

type CreateDatasetGroupOutput struct {

	// The Amazon Resource Name (ARN) of the new dataset group.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetGroupOutput) GoString

func (s CreateDatasetGroupOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetGroupOutput) SetDatasetGroupArn

func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGroupOutput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (CreateDatasetGroupOutput) String

func (s CreateDatasetGroupOutput) String() string

String returns the string representation

type CreateDatasetImportJobInput

type CreateDatasetImportJobInput struct {

	// The Amazon S3 bucket that contains the training data to import.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`

	// The ARN of the dataset that receives the imported data.
	//
	// DatasetArn is a required field
	DatasetArn *string `locationName:"datasetArn" type:"string" required:"true"`

	// The name for the dataset import job.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The ARN of the IAM role that has permissions to read from the Amazon S3 data
	// source.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDatasetImportJobInput) GoString

func (s CreateDatasetImportJobInput) GoString() string

GoString returns the string representation

func (*CreateDatasetImportJobInput) SetDataSource

SetDataSource sets the DataSource field's value.

func (*CreateDatasetImportJobInput) SetDatasetArn

SetDatasetArn sets the DatasetArn field's value.

func (*CreateDatasetImportJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*CreateDatasetImportJobInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (CreateDatasetImportJobInput) String

String returns the string representation

func (*CreateDatasetImportJobInput) Validate

func (s *CreateDatasetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetImportJobOutput

type CreateDatasetImportJobOutput struct {

	// The ARN of the dataset import job.
	DatasetImportJobArn *string `locationName:"datasetImportJobArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetImportJobOutput) GoString

func (s CreateDatasetImportJobOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetImportJobOutput) SetDatasetImportJobArn

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (CreateDatasetImportJobOutput) String

String returns the string representation

type CreateDatasetInput

type CreateDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`

	// The type of dataset.
	//
	// One of the following (case insensitive) values:
	//
	//    * Interactions
	//
	//    * Items
	//
	//    * Users
	//
	// DatasetType is a required field
	DatasetType *string `locationName:"datasetType" type:"string" required:"true"`

	// The name for the dataset.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The ARN of the schema to associate with the dataset. The schema defines the
	// dataset fields.
	//
	// SchemaArn is a required field
	SchemaArn *string `locationName:"schemaArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDatasetInput) GoString

func (s CreateDatasetInput) GoString() string

GoString returns the string representation

func (*CreateDatasetInput) SetDatasetGroupArn

func (s *CreateDatasetInput) SetDatasetGroupArn(v string) *CreateDatasetInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*CreateDatasetInput) SetDatasetType

func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput

SetDatasetType sets the DatasetType field's value.

func (*CreateDatasetInput) SetName

SetName sets the Name field's value.

func (*CreateDatasetInput) SetSchemaArn

func (s *CreateDatasetInput) SetSchemaArn(v string) *CreateDatasetInput

SetSchemaArn sets the SchemaArn field's value.

func (CreateDatasetInput) String

func (s CreateDatasetInput) String() string

String returns the string representation

func (*CreateDatasetInput) Validate

func (s *CreateDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDatasetOutput

type CreateDatasetOutput struct {

	// The ARN of the dataset.
	DatasetArn *string `locationName:"datasetArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateDatasetOutput) GoString

func (s CreateDatasetOutput) GoString() string

GoString returns the string representation

func (*CreateDatasetOutput) SetDatasetArn

func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput

SetDatasetArn sets the DatasetArn field's value.

func (CreateDatasetOutput) String

func (s CreateDatasetOutput) String() string

String returns the string representation

type CreateEventTrackerInput

type CreateEventTrackerInput struct {

	// The Amazon Resource Name (ARN) of the dataset group that receives the event
	// data.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`

	// The name for the event tracker.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateEventTrackerInput) GoString

func (s CreateEventTrackerInput) GoString() string

GoString returns the string representation

func (*CreateEventTrackerInput) SetDatasetGroupArn

func (s *CreateEventTrackerInput) SetDatasetGroupArn(v string) *CreateEventTrackerInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*CreateEventTrackerInput) SetName

SetName sets the Name field's value.

func (CreateEventTrackerInput) String

func (s CreateEventTrackerInput) String() string

String returns the string representation

func (*CreateEventTrackerInput) Validate

func (s *CreateEventTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEventTrackerOutput

type CreateEventTrackerOutput struct {

	// The ARN of the event tracker.
	EventTrackerArn *string `locationName:"eventTrackerArn" type:"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 `locationName:"trackingId" type:"string"`
	// contains filtered or unexported fields
}

func (CreateEventTrackerOutput) GoString

func (s CreateEventTrackerOutput) GoString() string

GoString returns the string representation

func (*CreateEventTrackerOutput) SetEventTrackerArn

func (s *CreateEventTrackerOutput) SetEventTrackerArn(v string) *CreateEventTrackerOutput

SetEventTrackerArn sets the EventTrackerArn field's value.

func (*CreateEventTrackerOutput) SetTrackingId

SetTrackingId sets the TrackingId field's value.

func (CreateEventTrackerOutput) String

func (s CreateEventTrackerOutput) String() string

String returns the string representation

type CreateFilterInput added in v1.31.12

type CreateFilterInput struct {

	// The ARN of the dataset group that the filter will belong to.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`

	// The filter expression that designates the interaction types that the filter
	// will filter out. A 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. To filter out all
	// items with any interactions history, set "*" as the EVENT_TYPE. For more
	// information, see Using Filters with Amazon Personalize (https://docs.aws.amazon.com/personalize/latest/dg/filters.html).
	//
	// FilterExpression is a required field
	FilterExpression *string `locationName:"filterExpression" min:"1" type:"string" required:"true" sensitive:"true"`

	// The name of the filter to create.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFilterInput) GoString added in v1.31.12

func (s CreateFilterInput) GoString() string

GoString returns the string representation

func (*CreateFilterInput) SetDatasetGroupArn added in v1.31.12

func (s *CreateFilterInput) SetDatasetGroupArn(v string) *CreateFilterInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*CreateFilterInput) SetFilterExpression added in v1.31.12

func (s *CreateFilterInput) SetFilterExpression(v string) *CreateFilterInput

SetFilterExpression sets the FilterExpression field's value.

func (*CreateFilterInput) SetName added in v1.31.12

SetName sets the Name field's value.

func (CreateFilterInput) String added in v1.31.12

func (s CreateFilterInput) String() string

String returns the string representation

func (*CreateFilterInput) Validate added in v1.31.12

func (s *CreateFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFilterOutput added in v1.31.12

type CreateFilterOutput struct {

	// The ARN of the new filter.
	FilterArn *string `locationName:"filterArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateFilterOutput) GoString added in v1.31.12

func (s CreateFilterOutput) GoString() string

GoString returns the string representation

func (*CreateFilterOutput) SetFilterArn added in v1.31.12

func (s *CreateFilterOutput) SetFilterArn(v string) *CreateFilterOutput

SetFilterArn sets the FilterArn field's value.

func (CreateFilterOutput) String added in v1.31.12

func (s CreateFilterOutput) String() string

String returns the string representation

type CreateSchemaInput

type CreateSchemaInput struct {

	// The name for the schema.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// A schema in Avro JSON format.
	//
	// Schema is a required field
	Schema *string `locationName:"schema" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSchemaInput) GoString

func (s CreateSchemaInput) GoString() string

GoString returns the string representation

func (*CreateSchemaInput) SetName

SetName sets the Name field's value.

func (*CreateSchemaInput) SetSchema

func (s *CreateSchemaInput) SetSchema(v string) *CreateSchemaInput

SetSchema sets the Schema field's value.

func (CreateSchemaInput) String

func (s CreateSchemaInput) String() string

String returns the string representation

func (*CreateSchemaInput) Validate

func (s *CreateSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSchemaOutput

type CreateSchemaOutput struct {

	// The Amazon Resource Name (ARN) of the created schema.
	SchemaArn *string `locationName:"schemaArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSchemaOutput) GoString

func (s CreateSchemaOutput) GoString() string

GoString returns the string representation

func (*CreateSchemaOutput) SetSchemaArn

func (s *CreateSchemaOutput) SetSchemaArn(v string) *CreateSchemaOutput

SetSchemaArn sets the SchemaArn field's value.

func (CreateSchemaOutput) String

func (s CreateSchemaOutput) String() string

String returns the string representation

type CreateSolutionInput

type CreateSolutionInput struct {

	// The Amazon Resource Name (ARN) of the dataset group that provides the training
	// data.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`

	// 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.
	EventType *string `locationName:"eventType" type:"string"`

	// The name for the solution.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// 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.
	PerformAutoML *bool `locationName:"performAutoML" type:"boolean"`

	// 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.
	PerformHPO *bool `locationName:"performHPO" type:"boolean"`

	// The ARN of the recipe to use for model training. Only specified when performAutoML
	// is false.
	RecipeArn *string `locationName:"recipeArn" type:"string"`

	// The configuration to use with the solution. When performAutoML is set to
	// true, Amazon Personalize only evaluates the autoMLConfig section of the solution
	// configuration.
	SolutionConfig *SolutionConfig `locationName:"solutionConfig" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateSolutionInput) GoString

func (s CreateSolutionInput) GoString() string

GoString returns the string representation

func (*CreateSolutionInput) SetDatasetGroupArn

func (s *CreateSolutionInput) SetDatasetGroupArn(v string) *CreateSolutionInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*CreateSolutionInput) SetEventType

func (s *CreateSolutionInput) SetEventType(v string) *CreateSolutionInput

SetEventType sets the EventType field's value.

func (*CreateSolutionInput) SetName

SetName sets the Name field's value.

func (*CreateSolutionInput) SetPerformAutoML

func (s *CreateSolutionInput) SetPerformAutoML(v bool) *CreateSolutionInput

SetPerformAutoML sets the PerformAutoML field's value.

func (*CreateSolutionInput) SetPerformHPO

func (s *CreateSolutionInput) SetPerformHPO(v bool) *CreateSolutionInput

SetPerformHPO sets the PerformHPO field's value.

func (*CreateSolutionInput) SetRecipeArn

func (s *CreateSolutionInput) SetRecipeArn(v string) *CreateSolutionInput

SetRecipeArn sets the RecipeArn field's value.

func (*CreateSolutionInput) SetSolutionConfig

func (s *CreateSolutionInput) SetSolutionConfig(v *SolutionConfig) *CreateSolutionInput

SetSolutionConfig sets the SolutionConfig field's value.

func (CreateSolutionInput) String

func (s CreateSolutionInput) String() string

String returns the string representation

func (*CreateSolutionInput) Validate

func (s *CreateSolutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSolutionOutput

type CreateSolutionOutput struct {

	// The ARN of the solution.
	SolutionArn *string `locationName:"solutionArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSolutionOutput) GoString

func (s CreateSolutionOutput) GoString() string

GoString returns the string representation

func (*CreateSolutionOutput) SetSolutionArn

func (s *CreateSolutionOutput) SetSolutionArn(v string) *CreateSolutionOutput

SetSolutionArn sets the SolutionArn field's value.

func (CreateSolutionOutput) String

func (s CreateSolutionOutput) String() string

String returns the string representation

type CreateSolutionVersionInput

type CreateSolutionVersionInput struct {

	// The Amazon Resource Name (ARN) of the solution containing the training configuration
	// information.
	//
	// SolutionArn is a required field
	SolutionArn *string `locationName:"solutionArn" type:"string" required:"true"`

	// 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 native-recipe-hrnn-coldstart recipe.
	TrainingMode *string `locationName:"trainingMode" type:"string" enum:"TrainingMode"`
	// contains filtered or unexported fields
}

func (CreateSolutionVersionInput) GoString

func (s CreateSolutionVersionInput) GoString() string

GoString returns the string representation

func (*CreateSolutionVersionInput) SetSolutionArn

SetSolutionArn sets the SolutionArn field's value.

func (*CreateSolutionVersionInput) SetTrainingMode added in v1.25.12

SetTrainingMode sets the TrainingMode field's value.

func (CreateSolutionVersionInput) String

String returns the string representation

func (*CreateSolutionVersionInput) Validate

func (s *CreateSolutionVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSolutionVersionOutput

type CreateSolutionVersionOutput struct {

	// The ARN of the new solution version.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSolutionVersionOutput) GoString

func (s CreateSolutionVersionOutput) GoString() string

GoString returns the string representation

func (*CreateSolutionVersionOutput) SetSolutionVersionArn

func (s *CreateSolutionVersionOutput) SetSolutionVersionArn(v string) *CreateSolutionVersionOutput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (CreateSolutionVersionOutput) String

String returns the string representation

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 `locationName:"dataLocation" type:"string"`
	// contains filtered or unexported fields
}

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

func (DataSource) GoString

func (s DataSource) GoString() string

GoString returns the string representation

func (*DataSource) SetDataLocation

func (s *DataSource) SetDataLocation(v string) *DataSource

SetDataLocation sets the DataLocation field's value.

func (DataSource) String

func (s DataSource) String() string

String returns the string representation

type Dataset

type Dataset struct {

	// The creation date and time (in Unix time) of the dataset.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset that you want metadata for.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// One of the following values:
	//
	//    * Interactions
	//
	//    * Items
	//
	//    * Users
	DatasetType *string `locationName:"datasetType" type:"string"`

	// A time stamp that shows when the dataset was updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the dataset.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The ARN of the associated schema.
	SchemaArn *string `locationName:"schemaArn" type:"string"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

Provides metadata for a dataset.

func (Dataset) GoString

func (s Dataset) GoString() string

GoString returns the string representation

func (*Dataset) SetCreationDateTime

func (s *Dataset) SetCreationDateTime(v time.Time) *Dataset

SetCreationDateTime sets the CreationDateTime field's value.

func (*Dataset) SetDatasetArn

func (s *Dataset) SetDatasetArn(v string) *Dataset

SetDatasetArn sets the DatasetArn field's value.

func (*Dataset) SetDatasetGroupArn

func (s *Dataset) SetDatasetGroupArn(v string) *Dataset

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*Dataset) SetDatasetType

func (s *Dataset) SetDatasetType(v string) *Dataset

SetDatasetType sets the DatasetType field's value.

func (*Dataset) SetLastUpdatedDateTime

func (s *Dataset) SetLastUpdatedDateTime(v time.Time) *Dataset

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Dataset) SetName

func (s *Dataset) SetName(v string) *Dataset

SetName sets the Name field's value.

func (*Dataset) SetSchemaArn

func (s *Dataset) SetSchemaArn(v string) *Dataset

SetSchemaArn sets the SchemaArn field's value.

func (*Dataset) SetStatus

func (s *Dataset) SetStatus(v string) *Dataset

SetStatus sets the Status field's value.

func (Dataset) String

func (s Dataset) String() string

String returns the string representation

type DatasetGroup

type DatasetGroup struct {

	// The creation date and time (in Unix time) of the dataset group.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// If creating a dataset group fails, provides the reason why.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
	KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"`

	// The last update date and time (in Unix time) of the dataset group.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the dataset group.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The ARN of the IAM role that has permissions to create the dataset group.
	RoleArn *string `locationName:"roleArn" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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.

func (DatasetGroup) GoString

func (s DatasetGroup) GoString() string

GoString returns the string representation

func (*DatasetGroup) SetCreationDateTime

func (s *DatasetGroup) SetCreationDateTime(v time.Time) *DatasetGroup

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetGroup) SetDatasetGroupArn

func (s *DatasetGroup) SetDatasetGroupArn(v string) *DatasetGroup

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DatasetGroup) SetFailureReason

func (s *DatasetGroup) SetFailureReason(v string) *DatasetGroup

SetFailureReason sets the FailureReason field's value.

func (*DatasetGroup) SetKmsKeyArn

func (s *DatasetGroup) SetKmsKeyArn(v string) *DatasetGroup

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*DatasetGroup) SetLastUpdatedDateTime

func (s *DatasetGroup) SetLastUpdatedDateTime(v time.Time) *DatasetGroup

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetGroup) SetName

func (s *DatasetGroup) SetName(v string) *DatasetGroup

SetName sets the Name field's value.

func (*DatasetGroup) SetRoleArn

func (s *DatasetGroup) SetRoleArn(v string) *DatasetGroup

SetRoleArn sets the RoleArn field's value.

func (*DatasetGroup) SetStatus

func (s *DatasetGroup) SetStatus(v string) *DatasetGroup

SetStatus sets the Status field's value.

func (DatasetGroup) String

func (s DatasetGroup) String() string

String returns the string representation

type DatasetGroupSummary

type DatasetGroupSummary struct {

	// The date and time (in Unix time) that the dataset group was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// If creating a dataset group fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix time) that the dataset group was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the dataset group.
	Name *string `locationName:"name" min:"1" type:"string"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetGroupSummary) GoString

func (s DatasetGroupSummary) GoString() string

GoString returns the string representation

func (*DatasetGroupSummary) SetCreationDateTime

func (s *DatasetGroupSummary) SetCreationDateTime(v time.Time) *DatasetGroupSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetGroupSummary) SetDatasetGroupArn

func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*DatasetGroupSummary) SetFailureReason

func (s *DatasetGroupSummary) SetFailureReason(v string) *DatasetGroupSummary

SetFailureReason sets the FailureReason field's value.

func (*DatasetGroupSummary) SetLastUpdatedDateTime

func (s *DatasetGroupSummary) SetLastUpdatedDateTime(v time.Time) *DatasetGroupSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetGroupSummary) SetName

SetName sets the Name field's value.

func (*DatasetGroupSummary) SetStatus

SetStatus sets the Status field's value.

func (DatasetGroupSummary) String

func (s DatasetGroupSummary) String() string

String returns the string representation

type DatasetImportJob

type DatasetImportJob struct {

	// The creation date and time (in Unix time) of the dataset import job.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon S3 bucket that contains the training data to import.
	DataSource *DataSource `locationName:"dataSource" type:"structure"`

	// The Amazon Resource Name (ARN) of the dataset that receives the imported
	// data.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// The ARN of the dataset import job.
	DatasetImportJobArn *string `locationName:"datasetImportJobArn" type:"string"`

	// If a dataset import job fails, provides the reason why.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The name of the import job.
	JobName *string `locationName:"jobName" min:"1" type:"string"`

	// The date and time (in Unix time) the dataset was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The ARN of the AWS Identity and Access Management (IAM) role that has permissions
	// to read from the Amazon S3 data source.
	RoleArn *string `locationName:"roleArn" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetImportJob) GoString

func (s DatasetImportJob) GoString() string

GoString returns the string representation

func (*DatasetImportJob) SetCreationDateTime

func (s *DatasetImportJob) SetCreationDateTime(v time.Time) *DatasetImportJob

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetImportJob) SetDataSource

func (s *DatasetImportJob) SetDataSource(v *DataSource) *DatasetImportJob

SetDataSource sets the DataSource field's value.

func (*DatasetImportJob) SetDatasetArn

func (s *DatasetImportJob) SetDatasetArn(v string) *DatasetImportJob

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetImportJob) SetDatasetImportJobArn

func (s *DatasetImportJob) SetDatasetImportJobArn(v string) *DatasetImportJob

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*DatasetImportJob) SetFailureReason

func (s *DatasetImportJob) SetFailureReason(v string) *DatasetImportJob

SetFailureReason sets the FailureReason field's value.

func (*DatasetImportJob) SetJobName

func (s *DatasetImportJob) SetJobName(v string) *DatasetImportJob

SetJobName sets the JobName field's value.

func (*DatasetImportJob) SetLastUpdatedDateTime

func (s *DatasetImportJob) SetLastUpdatedDateTime(v time.Time) *DatasetImportJob

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetImportJob) SetRoleArn

func (s *DatasetImportJob) SetRoleArn(v string) *DatasetImportJob

SetRoleArn sets the RoleArn field's value.

func (*DatasetImportJob) SetStatus

func (s *DatasetImportJob) SetStatus(v string) *DatasetImportJob

SetStatus sets the Status field's value.

func (DatasetImportJob) String

func (s DatasetImportJob) String() string

String returns the string representation

type DatasetImportJobSummary

type DatasetImportJobSummary struct {

	// The date and time (in Unix time) that the dataset import job was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset import job.
	DatasetImportJobArn *string `locationName:"datasetImportJobArn" type:"string"`

	// If a dataset import job fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The name of the dataset import job.
	JobName *string `locationName:"jobName" min:"1" type:"string"`

	// The date and time (in Unix time) that the dataset was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetImportJobSummary) GoString

func (s DatasetImportJobSummary) GoString() string

GoString returns the string representation

func (*DatasetImportJobSummary) SetCreationDateTime

func (s *DatasetImportJobSummary) SetCreationDateTime(v time.Time) *DatasetImportJobSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetImportJobSummary) SetDatasetImportJobArn

func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (*DatasetImportJobSummary) SetFailureReason

func (s *DatasetImportJobSummary) SetFailureReason(v string) *DatasetImportJobSummary

SetFailureReason sets the FailureReason field's value.

func (*DatasetImportJobSummary) SetJobName

SetJobName sets the JobName field's value.

func (*DatasetImportJobSummary) SetLastUpdatedDateTime

func (s *DatasetImportJobSummary) SetLastUpdatedDateTime(v time.Time) *DatasetImportJobSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetImportJobSummary) SetStatus

SetStatus sets the Status field's value.

func (DatasetImportJobSummary) String

func (s DatasetImportJobSummary) String() string

String returns the string representation

type DatasetSchema

type DatasetSchema struct {

	// The date and time (in Unix time) that the schema was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The date and time (in Unix time) that the schema was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the schema.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The schema.
	Schema *string `locationName:"schema" type:"string"`

	// The Amazon Resource Name (ARN) of the schema.
	SchemaArn *string `locationName:"schemaArn" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetSchema) GoString

func (s DatasetSchema) GoString() string

GoString returns the string representation

func (*DatasetSchema) SetCreationDateTime

func (s *DatasetSchema) SetCreationDateTime(v time.Time) *DatasetSchema

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetSchema) SetLastUpdatedDateTime

func (s *DatasetSchema) SetLastUpdatedDateTime(v time.Time) *DatasetSchema

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetSchema) SetName

func (s *DatasetSchema) SetName(v string) *DatasetSchema

SetName sets the Name field's value.

func (*DatasetSchema) SetSchema

func (s *DatasetSchema) SetSchema(v string) *DatasetSchema

SetSchema sets the Schema field's value.

func (*DatasetSchema) SetSchemaArn

func (s *DatasetSchema) SetSchemaArn(v string) *DatasetSchema

SetSchemaArn sets the SchemaArn field's value.

func (DatasetSchema) String

func (s DatasetSchema) String() string

String returns the string representation

type DatasetSchemaSummary

type DatasetSchemaSummary struct {

	// The date and time (in Unix time) that the schema was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The date and time (in Unix time) that the schema was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the schema.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the schema.
	SchemaArn *string `locationName:"schemaArn" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetSchemaSummary) GoString

func (s DatasetSchemaSummary) GoString() string

GoString returns the string representation

func (*DatasetSchemaSummary) SetCreationDateTime

func (s *DatasetSchemaSummary) SetCreationDateTime(v time.Time) *DatasetSchemaSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetSchemaSummary) SetLastUpdatedDateTime

func (s *DatasetSchemaSummary) SetLastUpdatedDateTime(v time.Time) *DatasetSchemaSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetSchemaSummary) SetName

SetName sets the Name field's value.

func (*DatasetSchemaSummary) SetSchemaArn

func (s *DatasetSchemaSummary) SetSchemaArn(v string) *DatasetSchemaSummary

SetSchemaArn sets the SchemaArn field's value.

func (DatasetSchemaSummary) String

func (s DatasetSchemaSummary) String() string

String returns the string representation

type DatasetSummary

type DatasetSummary struct {

	// The date and time (in Unix time) that the dataset was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

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

	// The date and time (in Unix time) that the dataset was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the dataset.
	Name *string `locationName:"name" min:"1" type:"string"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (DatasetSummary) GoString

func (s DatasetSummary) GoString() string

GoString returns the string representation

func (*DatasetSummary) SetCreationDateTime

func (s *DatasetSummary) SetCreationDateTime(v time.Time) *DatasetSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*DatasetSummary) SetDatasetArn

func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary

SetDatasetArn sets the DatasetArn field's value.

func (*DatasetSummary) SetDatasetType

func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary

SetDatasetType sets the DatasetType field's value.

func (*DatasetSummary) SetLastUpdatedDateTime

func (s *DatasetSummary) SetLastUpdatedDateTime(v time.Time) *DatasetSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*DatasetSummary) SetName

func (s *DatasetSummary) SetName(v string) *DatasetSummary

SetName sets the Name field's value.

func (*DatasetSummary) SetStatus

func (s *DatasetSummary) SetStatus(v string) *DatasetSummary

SetStatus sets the Status field's value.

func (DatasetSummary) String

func (s DatasetSummary) String() string

String returns the string representation

type DefaultCategoricalHyperParameterRange

type DefaultCategoricalHyperParameterRange struct {

	// Whether the hyperparameter is tunable.
	IsTunable *bool `locationName:"isTunable" type:"boolean"`

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`

	// A list of the categories for the hyperparameter.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

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

func (DefaultCategoricalHyperParameterRange) GoString

GoString returns the string representation

func (*DefaultCategoricalHyperParameterRange) SetIsTunable

SetIsTunable sets the IsTunable field's value.

func (*DefaultCategoricalHyperParameterRange) SetName

SetName sets the Name field's value.

func (*DefaultCategoricalHyperParameterRange) SetValues

SetValues sets the Values field's value.

func (DefaultCategoricalHyperParameterRange) String

String returns the string representation

type DefaultContinuousHyperParameterRange

type DefaultContinuousHyperParameterRange struct {

	// Whether the hyperparameter is tunable.
	IsTunable *bool `locationName:"isTunable" type:"boolean"`

	// The maximum allowable value for the hyperparameter.
	MaxValue *float64 `locationName:"maxValue" type:"double"`

	// The minimum allowable value for the hyperparameter.
	MinValue *float64 `locationName:"minValue" type:"double"`

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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

func (DefaultContinuousHyperParameterRange) GoString

GoString returns the string representation

func (*DefaultContinuousHyperParameterRange) SetIsTunable

SetIsTunable sets the IsTunable field's value.

func (*DefaultContinuousHyperParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*DefaultContinuousHyperParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*DefaultContinuousHyperParameterRange) SetName

SetName sets the Name field's value.

func (DefaultContinuousHyperParameterRange) String

String returns the string representation

type DefaultHyperParameterRanges

type DefaultHyperParameterRanges struct {

	// The categorical hyperparameters and their default ranges.
	CategoricalHyperParameterRanges []*DefaultCategoricalHyperParameterRange `locationName:"categoricalHyperParameterRanges" type:"list"`

	// The continuous hyperparameters and their default ranges.
	ContinuousHyperParameterRanges []*DefaultContinuousHyperParameterRange `locationName:"continuousHyperParameterRanges" type:"list"`

	// The integer-valued hyperparameters and their default ranges.
	IntegerHyperParameterRanges []*DefaultIntegerHyperParameterRange `locationName:"integerHyperParameterRanges" type:"list"`
	// contains filtered or unexported fields
}

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

func (DefaultHyperParameterRanges) GoString

func (s DefaultHyperParameterRanges) GoString() string

GoString returns the string representation

func (*DefaultHyperParameterRanges) SetCategoricalHyperParameterRanges

SetCategoricalHyperParameterRanges sets the CategoricalHyperParameterRanges field's value.

func (*DefaultHyperParameterRanges) SetContinuousHyperParameterRanges

SetContinuousHyperParameterRanges sets the ContinuousHyperParameterRanges field's value.

func (*DefaultHyperParameterRanges) SetIntegerHyperParameterRanges

SetIntegerHyperParameterRanges sets the IntegerHyperParameterRanges field's value.

func (DefaultHyperParameterRanges) String

String returns the string representation

type DefaultIntegerHyperParameterRange

type DefaultIntegerHyperParameterRange struct {

	// Indicates whether the hyperparameter is tunable.
	IsTunable *bool `locationName:"isTunable" type:"boolean"`

	// The maximum allowable value for the hyperparameter.
	MaxValue *int64 `locationName:"maxValue" type:"integer"`

	// The minimum allowable value for the hyperparameter.
	MinValue *int64 `locationName:"minValue" type:"integer"`

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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

func (DefaultIntegerHyperParameterRange) GoString

GoString returns the string representation

func (*DefaultIntegerHyperParameterRange) SetIsTunable

SetIsTunable sets the IsTunable field's value.

func (*DefaultIntegerHyperParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*DefaultIntegerHyperParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*DefaultIntegerHyperParameterRange) SetName

SetName sets the Name field's value.

func (DefaultIntegerHyperParameterRange) String

String returns the string representation

type DeleteCampaignInput

type DeleteCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign to delete.
	//
	// CampaignArn is a required field
	CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCampaignInput) GoString

func (s DeleteCampaignInput) GoString() string

GoString returns the string representation

func (*DeleteCampaignInput) SetCampaignArn

func (s *DeleteCampaignInput) SetCampaignArn(v string) *DeleteCampaignInput

SetCampaignArn sets the CampaignArn field's value.

func (DeleteCampaignInput) String

func (s DeleteCampaignInput) String() string

String returns the string representation

func (*DeleteCampaignInput) Validate

func (s *DeleteCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCampaignOutput

type DeleteCampaignOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCampaignOutput) GoString

func (s DeleteCampaignOutput) GoString() string

GoString returns the string representation

func (DeleteCampaignOutput) String

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteDatasetGroupInput

type DeleteDatasetGroupInput struct {

	// The ARN of the dataset group to delete.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetGroupInput) GoString

func (s DeleteDatasetGroupInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetGroupInput) SetDatasetGroupArn

func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DeleteDatasetGroupInput) String

func (s DeleteDatasetGroupInput) String() string

String returns the string representation

func (*DeleteDatasetGroupInput) Validate

func (s *DeleteDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetGroupOutput

type DeleteDatasetGroupOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDatasetGroupOutput) GoString

func (s DeleteDatasetGroupOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetGroupOutput) String

func (s DeleteDatasetGroupOutput) String() string

String returns the string representation

type DeleteDatasetInput

type DeleteDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to delete.
	//
	// DatasetArn is a required field
	DatasetArn *string `locationName:"datasetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDatasetInput) GoString

func (s DeleteDatasetInput) GoString() string

GoString returns the string representation

func (*DeleteDatasetInput) SetDatasetArn

func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DeleteDatasetInput) String

func (s DeleteDatasetInput) String() string

String returns the string representation

func (*DeleteDatasetInput) Validate

func (s *DeleteDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDatasetOutput

type DeleteDatasetOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDatasetOutput) GoString

func (s DeleteDatasetOutput) GoString() string

GoString returns the string representation

func (DeleteDatasetOutput) String

func (s DeleteDatasetOutput) String() string

String returns the string representation

type DeleteEventTrackerInput

type DeleteEventTrackerInput struct {

	// The Amazon Resource Name (ARN) of the event tracker to delete.
	//
	// EventTrackerArn is a required field
	EventTrackerArn *string `locationName:"eventTrackerArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventTrackerInput) GoString

func (s DeleteEventTrackerInput) GoString() string

GoString returns the string representation

func (*DeleteEventTrackerInput) SetEventTrackerArn

func (s *DeleteEventTrackerInput) SetEventTrackerArn(v string) *DeleteEventTrackerInput

SetEventTrackerArn sets the EventTrackerArn field's value.

func (DeleteEventTrackerInput) String

func (s DeleteEventTrackerInput) String() string

String returns the string representation

func (*DeleteEventTrackerInput) Validate

func (s *DeleteEventTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEventTrackerOutput

type DeleteEventTrackerOutput struct {
	// contains filtered or unexported fields
}

func (DeleteEventTrackerOutput) GoString

func (s DeleteEventTrackerOutput) GoString() string

GoString returns the string representation

func (DeleteEventTrackerOutput) String

func (s DeleteEventTrackerOutput) String() string

String returns the string representation

type DeleteFilterInput added in v1.31.12

type DeleteFilterInput struct {

	// The ARN of the filter to delete.
	//
	// FilterArn is a required field
	FilterArn *string `locationName:"filterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFilterInput) GoString added in v1.31.12

func (s DeleteFilterInput) GoString() string

GoString returns the string representation

func (*DeleteFilterInput) SetFilterArn added in v1.31.12

func (s *DeleteFilterInput) SetFilterArn(v string) *DeleteFilterInput

SetFilterArn sets the FilterArn field's value.

func (DeleteFilterInput) String added in v1.31.12

func (s DeleteFilterInput) String() string

String returns the string representation

func (*DeleteFilterInput) Validate added in v1.31.12

func (s *DeleteFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFilterOutput added in v1.31.12

type DeleteFilterOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFilterOutput) GoString added in v1.31.12

func (s DeleteFilterOutput) GoString() string

GoString returns the string representation

func (DeleteFilterOutput) String added in v1.31.12

func (s DeleteFilterOutput) String() string

String returns the string representation

type DeleteSchemaInput

type DeleteSchemaInput struct {

	// The Amazon Resource Name (ARN) of the schema to delete.
	//
	// SchemaArn is a required field
	SchemaArn *string `locationName:"schemaArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSchemaInput) GoString

func (s DeleteSchemaInput) GoString() string

GoString returns the string representation

func (*DeleteSchemaInput) SetSchemaArn

func (s *DeleteSchemaInput) SetSchemaArn(v string) *DeleteSchemaInput

SetSchemaArn sets the SchemaArn field's value.

func (DeleteSchemaInput) String

func (s DeleteSchemaInput) String() string

String returns the string representation

func (*DeleteSchemaInput) Validate

func (s *DeleteSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSchemaOutput

type DeleteSchemaOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSchemaOutput) GoString

func (s DeleteSchemaOutput) GoString() string

GoString returns the string representation

func (DeleteSchemaOutput) String

func (s DeleteSchemaOutput) String() string

String returns the string representation

type DeleteSolutionInput

type DeleteSolutionInput struct {

	// The ARN of the solution to delete.
	//
	// SolutionArn is a required field
	SolutionArn *string `locationName:"solutionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSolutionInput) GoString

func (s DeleteSolutionInput) GoString() string

GoString returns the string representation

func (*DeleteSolutionInput) SetSolutionArn

func (s *DeleteSolutionInput) SetSolutionArn(v string) *DeleteSolutionInput

SetSolutionArn sets the SolutionArn field's value.

func (DeleteSolutionInput) String

func (s DeleteSolutionInput) String() string

String returns the string representation

func (*DeleteSolutionInput) Validate

func (s *DeleteSolutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSolutionOutput

type DeleteSolutionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteSolutionOutput) GoString

func (s DeleteSolutionOutput) GoString() string

GoString returns the string representation

func (DeleteSolutionOutput) String

func (s DeleteSolutionOutput) String() string

String returns the string representation

type DescribeAlgorithmInput

type DescribeAlgorithmInput struct {

	// The Amazon Resource Name (ARN) of the algorithm to describe.
	//
	// AlgorithmArn is a required field
	AlgorithmArn *string `locationName:"algorithmArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAlgorithmInput) GoString

func (s DescribeAlgorithmInput) GoString() string

GoString returns the string representation

func (*DescribeAlgorithmInput) SetAlgorithmArn

func (s *DescribeAlgorithmInput) SetAlgorithmArn(v string) *DescribeAlgorithmInput

SetAlgorithmArn sets the AlgorithmArn field's value.

func (DescribeAlgorithmInput) String

func (s DescribeAlgorithmInput) String() string

String returns the string representation

func (*DescribeAlgorithmInput) Validate

func (s *DescribeAlgorithmInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAlgorithmOutput

type DescribeAlgorithmOutput struct {

	// A listing of the properties of the algorithm.
	Algorithm *Algorithm `locationName:"algorithm" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAlgorithmOutput) GoString

func (s DescribeAlgorithmOutput) GoString() string

GoString returns the string representation

func (*DescribeAlgorithmOutput) SetAlgorithm

SetAlgorithm sets the Algorithm field's value.

func (DescribeAlgorithmOutput) String

func (s DescribeAlgorithmOutput) String() string

String returns the string representation

type DescribeBatchInferenceJobInput added in v1.25.35

type DescribeBatchInferenceJobInput struct {

	// The ARN of the batch inference job to describe.
	//
	// BatchInferenceJobArn is a required field
	BatchInferenceJobArn *string `locationName:"batchInferenceJobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBatchInferenceJobInput) GoString added in v1.25.35

GoString returns the string representation

func (*DescribeBatchInferenceJobInput) SetBatchInferenceJobArn added in v1.25.35

SetBatchInferenceJobArn sets the BatchInferenceJobArn field's value.

func (DescribeBatchInferenceJobInput) String added in v1.25.35

String returns the string representation

func (*DescribeBatchInferenceJobInput) Validate added in v1.25.35

func (s *DescribeBatchInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBatchInferenceJobOutput added in v1.25.35

type DescribeBatchInferenceJobOutput struct {

	// Information on the specified batch inference job.
	BatchInferenceJob *BatchInferenceJob `locationName:"batchInferenceJob" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeBatchInferenceJobOutput) GoString added in v1.25.35

GoString returns the string representation

func (*DescribeBatchInferenceJobOutput) SetBatchInferenceJob added in v1.25.35

SetBatchInferenceJob sets the BatchInferenceJob field's value.

func (DescribeBatchInferenceJobOutput) String added in v1.25.35

String returns the string representation

type DescribeCampaignInput

type DescribeCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// CampaignArn is a required field
	CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCampaignInput) GoString

func (s DescribeCampaignInput) GoString() string

GoString returns the string representation

func (*DescribeCampaignInput) SetCampaignArn

func (s *DescribeCampaignInput) SetCampaignArn(v string) *DescribeCampaignInput

SetCampaignArn sets the CampaignArn field's value.

func (DescribeCampaignInput) String

func (s DescribeCampaignInput) String() string

String returns the string representation

func (*DescribeCampaignInput) Validate

func (s *DescribeCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCampaignOutput

type DescribeCampaignOutput struct {

	// The properties of the campaign.
	Campaign *Campaign `locationName:"campaign" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeCampaignOutput) GoString

func (s DescribeCampaignOutput) GoString() string

GoString returns the string representation

func (*DescribeCampaignOutput) SetCampaign

SetCampaign sets the Campaign field's value.

func (DescribeCampaignOutput) String

func (s DescribeCampaignOutput) String() string

String returns the string representation

type DescribeDatasetGroupInput

type DescribeDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to describe.
	//
	// DatasetGroupArn is a required field
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetGroupInput) GoString

func (s DescribeDatasetGroupInput) GoString() string

GoString returns the string representation

func (*DescribeDatasetGroupInput) SetDatasetGroupArn

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (DescribeDatasetGroupInput) String

func (s DescribeDatasetGroupInput) String() string

String returns the string representation

func (*DescribeDatasetGroupInput) Validate

func (s *DescribeDatasetGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetGroupOutput

type DescribeDatasetGroupOutput struct {

	// A listing of the dataset group's properties.
	DatasetGroup *DatasetGroup `locationName:"datasetGroup" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetGroupOutput) GoString

func (s DescribeDatasetGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeDatasetGroupOutput) SetDatasetGroup

SetDatasetGroup sets the DatasetGroup field's value.

func (DescribeDatasetGroupOutput) String

String returns the string representation

type DescribeDatasetImportJobInput

type DescribeDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job to describe.
	//
	// DatasetImportJobArn is a required field
	DatasetImportJobArn *string `locationName:"datasetImportJobArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetImportJobInput) GoString

GoString returns the string representation

func (*DescribeDatasetImportJobInput) SetDatasetImportJobArn

SetDatasetImportJobArn sets the DatasetImportJobArn field's value.

func (DescribeDatasetImportJobInput) String

String returns the string representation

func (*DescribeDatasetImportJobInput) Validate

func (s *DescribeDatasetImportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetImportJobOutput

type DescribeDatasetImportJobOutput struct {

	// 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
	DatasetImportJob *DatasetImportJob `locationName:"datasetImportJob" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetImportJobOutput) GoString

GoString returns the string representation

func (*DescribeDatasetImportJobOutput) SetDatasetImportJob

SetDatasetImportJob sets the DatasetImportJob field's value.

func (DescribeDatasetImportJobOutput) String

String returns the string representation

type DescribeDatasetInput

type DescribeDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to describe.
	//
	// DatasetArn is a required field
	DatasetArn *string `locationName:"datasetArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDatasetInput) GoString

func (s DescribeDatasetInput) GoString() string

GoString returns the string representation

func (*DescribeDatasetInput) SetDatasetArn

func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput

SetDatasetArn sets the DatasetArn field's value.

func (DescribeDatasetInput) String

func (s DescribeDatasetInput) String() string

String returns the string representation

func (*DescribeDatasetInput) Validate

func (s *DescribeDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDatasetOutput

type DescribeDatasetOutput struct {

	// A listing of the dataset's properties.
	Dataset *Dataset `locationName:"dataset" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDatasetOutput) GoString

func (s DescribeDatasetOutput) GoString() string

GoString returns the string representation

func (*DescribeDatasetOutput) SetDataset

SetDataset sets the Dataset field's value.

func (DescribeDatasetOutput) String

func (s DescribeDatasetOutput) String() string

String returns the string representation

type DescribeEventTrackerInput

type DescribeEventTrackerInput struct {

	// The Amazon Resource Name (ARN) of the event tracker to describe.
	//
	// EventTrackerArn is a required field
	EventTrackerArn *string `locationName:"eventTrackerArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventTrackerInput) GoString

func (s DescribeEventTrackerInput) GoString() string

GoString returns the string representation

func (*DescribeEventTrackerInput) SetEventTrackerArn

SetEventTrackerArn sets the EventTrackerArn field's value.

func (DescribeEventTrackerInput) String

func (s DescribeEventTrackerInput) String() string

String returns the string representation

func (*DescribeEventTrackerInput) Validate

func (s *DescribeEventTrackerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventTrackerOutput

type DescribeEventTrackerOutput struct {

	// An object that describes the event tracker.
	EventTracker *EventTracker `locationName:"eventTracker" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEventTrackerOutput) GoString

func (s DescribeEventTrackerOutput) GoString() string

GoString returns the string representation

func (*DescribeEventTrackerOutput) SetEventTracker

SetEventTracker sets the EventTracker field's value.

func (DescribeEventTrackerOutput) String

String returns the string representation

type DescribeFeatureTransformationInput

type DescribeFeatureTransformationInput struct {

	// The Amazon Resource Name (ARN) of the feature transformation to describe.
	//
	// FeatureTransformationArn is a required field
	FeatureTransformationArn *string `locationName:"featureTransformationArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFeatureTransformationInput) GoString

GoString returns the string representation

func (*DescribeFeatureTransformationInput) SetFeatureTransformationArn

SetFeatureTransformationArn sets the FeatureTransformationArn field's value.

func (DescribeFeatureTransformationInput) String

String returns the string representation

func (*DescribeFeatureTransformationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeFeatureTransformationOutput

type DescribeFeatureTransformationOutput struct {

	// A listing of the FeatureTransformation properties.
	FeatureTransformation *FeatureTransformation `locationName:"featureTransformation" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFeatureTransformationOutput) GoString

GoString returns the string representation

func (*DescribeFeatureTransformationOutput) SetFeatureTransformation

SetFeatureTransformation sets the FeatureTransformation field's value.

func (DescribeFeatureTransformationOutput) String

String returns the string representation

type DescribeFilterInput added in v1.31.12

type DescribeFilterInput struct {

	// The ARN of the filter to describe.
	//
	// FilterArn is a required field
	FilterArn *string `locationName:"filterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFilterInput) GoString added in v1.31.12

func (s DescribeFilterInput) GoString() string

GoString returns the string representation

func (*DescribeFilterInput) SetFilterArn added in v1.31.12

func (s *DescribeFilterInput) SetFilterArn(v string) *DescribeFilterInput

SetFilterArn sets the FilterArn field's value.

func (DescribeFilterInput) String added in v1.31.12

func (s DescribeFilterInput) String() string

String returns the string representation

func (*DescribeFilterInput) Validate added in v1.31.12

func (s *DescribeFilterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFilterOutput added in v1.31.12

type DescribeFilterOutput struct {

	// The filter's details.
	Filter *Filter `locationName:"filter" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeFilterOutput) GoString added in v1.31.12

func (s DescribeFilterOutput) GoString() string

GoString returns the string representation

func (*DescribeFilterOutput) SetFilter added in v1.31.12

SetFilter sets the Filter field's value.

func (DescribeFilterOutput) String added in v1.31.12

func (s DescribeFilterOutput) String() string

String returns the string representation

type DescribeRecipeInput

type DescribeRecipeInput struct {

	// The Amazon Resource Name (ARN) of the recipe to describe.
	//
	// RecipeArn is a required field
	RecipeArn *string `locationName:"recipeArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRecipeInput) GoString

func (s DescribeRecipeInput) GoString() string

GoString returns the string representation

func (*DescribeRecipeInput) SetRecipeArn

func (s *DescribeRecipeInput) SetRecipeArn(v string) *DescribeRecipeInput

SetRecipeArn sets the RecipeArn field's value.

func (DescribeRecipeInput) String

func (s DescribeRecipeInput) String() string

String returns the string representation

func (*DescribeRecipeInput) Validate

func (s *DescribeRecipeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRecipeOutput

type DescribeRecipeOutput struct {

	// An object that describes the recipe.
	Recipe *Recipe `locationName:"recipe" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeRecipeOutput) GoString

func (s DescribeRecipeOutput) GoString() string

GoString returns the string representation

func (*DescribeRecipeOutput) SetRecipe

SetRecipe sets the Recipe field's value.

func (DescribeRecipeOutput) String

func (s DescribeRecipeOutput) String() string

String returns the string representation

type DescribeSchemaInput

type DescribeSchemaInput struct {

	// The Amazon Resource Name (ARN) of the schema to retrieve.
	//
	// SchemaArn is a required field
	SchemaArn *string `locationName:"schemaArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSchemaInput) GoString

func (s DescribeSchemaInput) GoString() string

GoString returns the string representation

func (*DescribeSchemaInput) SetSchemaArn

func (s *DescribeSchemaInput) SetSchemaArn(v string) *DescribeSchemaInput

SetSchemaArn sets the SchemaArn field's value.

func (DescribeSchemaInput) String

func (s DescribeSchemaInput) String() string

String returns the string representation

func (*DescribeSchemaInput) Validate

func (s *DescribeSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSchemaOutput

type DescribeSchemaOutput struct {

	// The requested schema.
	Schema *DatasetSchema `locationName:"schema" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSchemaOutput) GoString

func (s DescribeSchemaOutput) GoString() string

GoString returns the string representation

func (*DescribeSchemaOutput) SetSchema

SetSchema sets the Schema field's value.

func (DescribeSchemaOutput) String

func (s DescribeSchemaOutput) String() string

String returns the string representation

type DescribeSolutionInput

type DescribeSolutionInput struct {

	// The Amazon Resource Name (ARN) of the solution to describe.
	//
	// SolutionArn is a required field
	SolutionArn *string `locationName:"solutionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSolutionInput) GoString

func (s DescribeSolutionInput) GoString() string

GoString returns the string representation

func (*DescribeSolutionInput) SetSolutionArn

func (s *DescribeSolutionInput) SetSolutionArn(v string) *DescribeSolutionInput

SetSolutionArn sets the SolutionArn field's value.

func (DescribeSolutionInput) String

func (s DescribeSolutionInput) String() string

String returns the string representation

func (*DescribeSolutionInput) Validate

func (s *DescribeSolutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSolutionOutput

type DescribeSolutionOutput struct {

	// An object that describes the solution.
	Solution *Solution `locationName:"solution" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSolutionOutput) GoString

func (s DescribeSolutionOutput) GoString() string

GoString returns the string representation

func (*DescribeSolutionOutput) SetSolution

SetSolution sets the Solution field's value.

func (DescribeSolutionOutput) String

func (s DescribeSolutionOutput) String() string

String returns the string representation

type DescribeSolutionVersionInput

type DescribeSolutionVersionInput struct {

	// The Amazon Resource Name (ARN) of the solution version.
	//
	// SolutionVersionArn is a required field
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeSolutionVersionInput) GoString

func (s DescribeSolutionVersionInput) GoString() string

GoString returns the string representation

func (*DescribeSolutionVersionInput) SetSolutionVersionArn

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (DescribeSolutionVersionInput) String

String returns the string representation

func (*DescribeSolutionVersionInput) Validate

func (s *DescribeSolutionVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSolutionVersionOutput

type DescribeSolutionVersionOutput struct {

	// The solution version.
	SolutionVersion *SolutionVersion `locationName:"solutionVersion" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSolutionVersionOutput) GoString

GoString returns the string representation

func (*DescribeSolutionVersionOutput) SetSolutionVersion

SetSolutionVersion sets the SolutionVersion field's value.

func (DescribeSolutionVersionOutput) String

String returns the string representation

type EventTracker

type EventTracker struct {

	// The Amazon AWS account that owns the event tracker.
	AccountId *string `locationName:"accountId" type:"string"`

	// The date and time (in Unix format) that the event tracker was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset group that receives the event
	// data.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// The ARN of the event tracker.
	EventTrackerArn *string `locationName:"eventTrackerArn" type:"string"`

	// The date and time (in Unix time) that the event tracker was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the event tracker.
	Name *string `locationName:"name" min:"1" type:"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 `locationName:"status" type:"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 `locationName:"trackingId" type:"string"`
	// contains filtered or unexported fields
}

Provides information about an event tracker.

func (EventTracker) GoString

func (s EventTracker) GoString() string

GoString returns the string representation

func (*EventTracker) SetAccountId

func (s *EventTracker) SetAccountId(v string) *EventTracker

SetAccountId sets the AccountId field's value.

func (*EventTracker) SetCreationDateTime

func (s *EventTracker) SetCreationDateTime(v time.Time) *EventTracker

SetCreationDateTime sets the CreationDateTime field's value.

func (*EventTracker) SetDatasetGroupArn

func (s *EventTracker) SetDatasetGroupArn(v string) *EventTracker

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*EventTracker) SetEventTrackerArn

func (s *EventTracker) SetEventTrackerArn(v string) *EventTracker

SetEventTrackerArn sets the EventTrackerArn field's value.

func (*EventTracker) SetLastUpdatedDateTime

func (s *EventTracker) SetLastUpdatedDateTime(v time.Time) *EventTracker

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*EventTracker) SetName

func (s *EventTracker) SetName(v string) *EventTracker

SetName sets the Name field's value.

func (*EventTracker) SetStatus

func (s *EventTracker) SetStatus(v string) *EventTracker

SetStatus sets the Status field's value.

func (*EventTracker) SetTrackingId

func (s *EventTracker) SetTrackingId(v string) *EventTracker

SetTrackingId sets the TrackingId field's value.

func (EventTracker) String

func (s EventTracker) String() string

String returns the string representation

type EventTrackerSummary

type EventTrackerSummary struct {

	// The date and time (in Unix time) that the event tracker was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the event tracker.
	EventTrackerArn *string `locationName:"eventTrackerArn" type:"string"`

	// The date and time (in Unix time) that the event tracker was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the event tracker.
	Name *string `locationName:"name" min:"1" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (EventTrackerSummary) GoString

func (s EventTrackerSummary) GoString() string

GoString returns the string representation

func (*EventTrackerSummary) SetCreationDateTime

func (s *EventTrackerSummary) SetCreationDateTime(v time.Time) *EventTrackerSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*EventTrackerSummary) SetEventTrackerArn

func (s *EventTrackerSummary) SetEventTrackerArn(v string) *EventTrackerSummary

SetEventTrackerArn sets the EventTrackerArn field's value.

func (*EventTrackerSummary) SetLastUpdatedDateTime

func (s *EventTrackerSummary) SetLastUpdatedDateTime(v time.Time) *EventTrackerSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*EventTrackerSummary) SetName

SetName sets the Name field's value.

func (*EventTrackerSummary) SetStatus

SetStatus sets the Status field's value.

func (EventTrackerSummary) String

func (s EventTrackerSummary) String() string

String returns the string representation

type FeatureTransformation

type FeatureTransformation struct {

	// The creation date and time (in Unix time) of the feature transformation.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// Provides the default parameters for feature transformation.
	DefaultParameters map[string]*string `locationName:"defaultParameters" type:"map"`

	// The Amazon Resource Name (ARN) of the FeatureTransformation object.
	FeatureTransformationArn *string `locationName:"featureTransformationArn" type:"string"`

	// The last update date and time (in Unix time) of the feature transformation.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the feature transformation.
	Name *string `locationName:"name" min:"1" type:"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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (FeatureTransformation) GoString

func (s FeatureTransformation) GoString() string

GoString returns the string representation

func (*FeatureTransformation) SetCreationDateTime

func (s *FeatureTransformation) SetCreationDateTime(v time.Time) *FeatureTransformation

SetCreationDateTime sets the CreationDateTime field's value.

func (*FeatureTransformation) SetDefaultParameters

func (s *FeatureTransformation) SetDefaultParameters(v map[string]*string) *FeatureTransformation

SetDefaultParameters sets the DefaultParameters field's value.

func (*FeatureTransformation) SetFeatureTransformationArn

func (s *FeatureTransformation) SetFeatureTransformationArn(v string) *FeatureTransformation

SetFeatureTransformationArn sets the FeatureTransformationArn field's value.

func (*FeatureTransformation) SetLastUpdatedDateTime

func (s *FeatureTransformation) SetLastUpdatedDateTime(v time.Time) *FeatureTransformation

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*FeatureTransformation) SetName

SetName sets the Name field's value.

func (*FeatureTransformation) SetStatus

SetStatus sets the Status field's value.

func (FeatureTransformation) String

func (s FeatureTransformation) String() string

String returns the string representation

type Filter added in v1.31.12

type Filter struct {

	// The time at which the filter was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The ARN of the dataset group to which the filter belongs.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// If the filter failed, the reason for its failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The ARN of the filter.
	FilterArn *string `locationName:"filterArn" type:"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 (https://docs.aws.amazon.com/personalize/latest/dg/filters.html).
	FilterExpression *string `locationName:"filterExpression" min:"1" type:"string" sensitive:"true"`

	// The time at which the filter was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the filter.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The status of the filter.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (Filter) GoString added in v1.31.12

func (s Filter) GoString() string

GoString returns the string representation

func (*Filter) SetCreationDateTime added in v1.31.12

func (s *Filter) SetCreationDateTime(v time.Time) *Filter

SetCreationDateTime sets the CreationDateTime field's value.

func (*Filter) SetDatasetGroupArn added in v1.31.12

func (s *Filter) SetDatasetGroupArn(v string) *Filter

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*Filter) SetFailureReason added in v1.31.12

func (s *Filter) SetFailureReason(v string) *Filter

SetFailureReason sets the FailureReason field's value.

func (*Filter) SetFilterArn added in v1.31.12

func (s *Filter) SetFilterArn(v string) *Filter

SetFilterArn sets the FilterArn field's value.

func (*Filter) SetFilterExpression added in v1.31.12

func (s *Filter) SetFilterExpression(v string) *Filter

SetFilterExpression sets the FilterExpression field's value.

func (*Filter) SetLastUpdatedDateTime added in v1.31.12

func (s *Filter) SetLastUpdatedDateTime(v time.Time) *Filter

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Filter) SetName added in v1.31.12

func (s *Filter) SetName(v string) *Filter

SetName sets the Name field's value.

func (*Filter) SetStatus added in v1.31.12

func (s *Filter) SetStatus(v string) *Filter

SetStatus sets the Status field's value.

func (Filter) String added in v1.31.12

func (s Filter) String() string

String returns the string representation

type FilterSummary added in v1.31.12

type FilterSummary struct {

	// The time at which the filter was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The ARN of the dataset group to which the filter belongs.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// If the filter failed, the reason for the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The ARN of the filter.
	FilterArn *string `locationName:"filterArn" type:"string"`

	// The time at which the filter was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the filter.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The status of the filter.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

A short summary of a filter's attributes.

func (FilterSummary) GoString added in v1.31.12

func (s FilterSummary) GoString() string

GoString returns the string representation

func (*FilterSummary) SetCreationDateTime added in v1.31.12

func (s *FilterSummary) SetCreationDateTime(v time.Time) *FilterSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*FilterSummary) SetDatasetGroupArn added in v1.31.12

func (s *FilterSummary) SetDatasetGroupArn(v string) *FilterSummary

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*FilterSummary) SetFailureReason added in v1.31.12

func (s *FilterSummary) SetFailureReason(v string) *FilterSummary

SetFailureReason sets the FailureReason field's value.

func (*FilterSummary) SetFilterArn added in v1.31.12

func (s *FilterSummary) SetFilterArn(v string) *FilterSummary

SetFilterArn sets the FilterArn field's value.

func (*FilterSummary) SetLastUpdatedDateTime added in v1.31.12

func (s *FilterSummary) SetLastUpdatedDateTime(v time.Time) *FilterSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*FilterSummary) SetName added in v1.31.12

func (s *FilterSummary) SetName(v string) *FilterSummary

SetName sets the Name field's value.

func (*FilterSummary) SetStatus added in v1.31.12

func (s *FilterSummary) SetStatus(v string) *FilterSummary

SetStatus sets the Status field's value.

func (FilterSummary) String added in v1.31.12

func (s FilterSummary) String() string

String returns the string representation

type GetSolutionMetricsInput

type GetSolutionMetricsInput struct {

	// The Amazon Resource Name (ARN) of the solution version for which to get metrics.
	//
	// SolutionVersionArn is a required field
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSolutionMetricsInput) GoString

func (s GetSolutionMetricsInput) GoString() string

GoString returns the string representation

func (*GetSolutionMetricsInput) SetSolutionVersionArn

func (s *GetSolutionMetricsInput) SetSolutionVersionArn(v string) *GetSolutionMetricsInput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (GetSolutionMetricsInput) String

func (s GetSolutionMetricsInput) String() string

String returns the string representation

func (*GetSolutionMetricsInput) Validate

func (s *GetSolutionMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSolutionMetricsOutput

type GetSolutionMetricsOutput struct {

	// The metrics for the solution version.
	Metrics map[string]*float64 `locationName:"metrics" type:"map"`

	// The same solution version ARN as specified in the request.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`
	// contains filtered or unexported fields
}

func (GetSolutionMetricsOutput) GoString

func (s GetSolutionMetricsOutput) GoString() string

GoString returns the string representation

func (*GetSolutionMetricsOutput) SetMetrics

SetMetrics sets the Metrics field's value.

func (*GetSolutionMetricsOutput) SetSolutionVersionArn

func (s *GetSolutionMetricsOutput) SetSolutionVersionArn(v string) *GetSolutionMetricsOutput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (GetSolutionMetricsOutput) String

func (s GetSolutionMetricsOutput) String() string

String returns the string representation

type HPOConfig

type HPOConfig struct {

	// The hyperparameters and their allowable ranges.
	AlgorithmHyperParameterRanges *HyperParameterRanges `locationName:"algorithmHyperParameterRanges" type:"structure"`

	// The metric to optimize during HPO.
	HpoObjective *HPOObjective `locationName:"hpoObjective" type:"structure"`

	// Describes the resource configuration for HPO.
	HpoResourceConfig *HPOResourceConfig `locationName:"hpoResourceConfig" type:"structure"`
	// contains filtered or unexported fields
}

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

func (HPOConfig) GoString

func (s HPOConfig) GoString() string

GoString returns the string representation

func (*HPOConfig) SetAlgorithmHyperParameterRanges

func (s *HPOConfig) SetAlgorithmHyperParameterRanges(v *HyperParameterRanges) *HPOConfig

SetAlgorithmHyperParameterRanges sets the AlgorithmHyperParameterRanges field's value.

func (*HPOConfig) SetHpoObjective

func (s *HPOConfig) SetHpoObjective(v *HPOObjective) *HPOConfig

SetHpoObjective sets the HpoObjective field's value.

func (*HPOConfig) SetHpoResourceConfig

func (s *HPOConfig) SetHpoResourceConfig(v *HPOResourceConfig) *HPOConfig

SetHpoResourceConfig sets the HpoResourceConfig field's value.

func (HPOConfig) String

func (s HPOConfig) String() string

String returns the string representation

func (*HPOConfig) Validate

func (s *HPOConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HPOObjective

type HPOObjective struct {

	// The name of the metric.
	MetricName *string `locationName:"metricName" type:"string"`

	// A regular expression for finding the metric in the training job logs.
	MetricRegex *string `locationName:"metricRegex" type:"string"`

	// The type of the metric. Valid values are Maximize and Minimize.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

The metric to optimize during hyperparameter optimization (HPO).

func (HPOObjective) GoString

func (s HPOObjective) GoString() string

GoString returns the string representation

func (*HPOObjective) SetMetricName

func (s *HPOObjective) SetMetricName(v string) *HPOObjective

SetMetricName sets the MetricName field's value.

func (*HPOObjective) SetMetricRegex

func (s *HPOObjective) SetMetricRegex(v string) *HPOObjective

SetMetricRegex sets the MetricRegex field's value.

func (*HPOObjective) SetType

func (s *HPOObjective) SetType(v string) *HPOObjective

SetType sets the Type field's value.

func (HPOObjective) String

func (s HPOObjective) String() string

String returns the string representation

type HPOResourceConfig

type HPOResourceConfig struct {

	// The maximum number of training jobs when you create a solution version. The
	// maximum value for maxNumberOfTrainingJobs is 40.
	MaxNumberOfTrainingJobs *string `locationName:"maxNumberOfTrainingJobs" type:"string"`

	// The maximum number of parallel training jobs when you create a solution version.
	// The maximum value for maxParallelTrainingJobs is 10.
	MaxParallelTrainingJobs *string `locationName:"maxParallelTrainingJobs" type:"string"`
	// contains filtered or unexported fields
}

Describes the resource configuration for hyperparameter optimization (HPO).

func (HPOResourceConfig) GoString

func (s HPOResourceConfig) GoString() string

GoString returns the string representation

func (*HPOResourceConfig) SetMaxNumberOfTrainingJobs

func (s *HPOResourceConfig) SetMaxNumberOfTrainingJobs(v string) *HPOResourceConfig

SetMaxNumberOfTrainingJobs sets the MaxNumberOfTrainingJobs field's value.

func (*HPOResourceConfig) SetMaxParallelTrainingJobs

func (s *HPOResourceConfig) SetMaxParallelTrainingJobs(v string) *HPOResourceConfig

SetMaxParallelTrainingJobs sets the MaxParallelTrainingJobs field's value.

func (HPOResourceConfig) String

func (s HPOResourceConfig) String() string

String returns the string representation

type HyperParameterRanges

type HyperParameterRanges struct {

	// The categorical hyperparameters and their ranges.
	CategoricalHyperParameterRanges []*CategoricalHyperParameterRange `locationName:"categoricalHyperParameterRanges" type:"list"`

	// The continuous hyperparameters and their ranges.
	ContinuousHyperParameterRanges []*ContinuousHyperParameterRange `locationName:"continuousHyperParameterRanges" type:"list"`

	// The integer-valued hyperparameters and their ranges.
	IntegerHyperParameterRanges []*IntegerHyperParameterRange `locationName:"integerHyperParameterRanges" type:"list"`
	// contains filtered or unexported fields
}

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

func (HyperParameterRanges) GoString

func (s HyperParameterRanges) GoString() string

GoString returns the string representation

func (*HyperParameterRanges) SetCategoricalHyperParameterRanges

func (s *HyperParameterRanges) SetCategoricalHyperParameterRanges(v []*CategoricalHyperParameterRange) *HyperParameterRanges

SetCategoricalHyperParameterRanges sets the CategoricalHyperParameterRanges field's value.

func (*HyperParameterRanges) SetContinuousHyperParameterRanges

func (s *HyperParameterRanges) SetContinuousHyperParameterRanges(v []*ContinuousHyperParameterRange) *HyperParameterRanges

SetContinuousHyperParameterRanges sets the ContinuousHyperParameterRanges field's value.

func (*HyperParameterRanges) SetIntegerHyperParameterRanges

func (s *HyperParameterRanges) SetIntegerHyperParameterRanges(v []*IntegerHyperParameterRange) *HyperParameterRanges

SetIntegerHyperParameterRanges sets the IntegerHyperParameterRanges field's value.

func (HyperParameterRanges) String

func (s HyperParameterRanges) String() string

String returns the string representation

func (*HyperParameterRanges) Validate

func (s *HyperParameterRanges) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IntegerHyperParameterRange

type IntegerHyperParameterRange struct {

	// The maximum allowable value for the hyperparameter.
	MaxValue *int64 `locationName:"maxValue" type:"integer"`

	// The minimum allowable value for the hyperparameter.
	MinValue *int64 `locationName:"minValue" type:"integer"`

	// The name of the hyperparameter.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

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

func (IntegerHyperParameterRange) GoString

func (s IntegerHyperParameterRange) GoString() string

GoString returns the string representation

func (*IntegerHyperParameterRange) SetMaxValue

SetMaxValue sets the MaxValue field's value.

func (*IntegerHyperParameterRange) SetMinValue

SetMinValue sets the MinValue field's value.

func (*IntegerHyperParameterRange) SetName

SetName sets the Name field's value.

func (IntegerHyperParameterRange) String

String returns the string representation

func (*IntegerHyperParameterRange) Validate

func (s *IntegerHyperParameterRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InvalidInputException added in v1.28.0

type InvalidInputException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Provide a valid value for the field or parameter.

func (*InvalidInputException) Code added in v1.28.0

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error added in v1.28.0

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString added in v1.28.0

func (s InvalidInputException) GoString() string

GoString returns the string representation

func (*InvalidInputException) Message added in v1.28.0

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr added in v1.28.0

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID added in v1.28.0

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode added in v1.28.0

func (s *InvalidInputException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInputException) String added in v1.28.0

func (s InvalidInputException) String() string

String returns the string representation

type InvalidNextTokenException added in v1.28.0

type InvalidNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The token is not valid.

func (*InvalidNextTokenException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidNextTokenException) Error added in v1.28.0

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString added in v1.28.0

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation

func (*InvalidNextTokenException) Message added in v1.28.0

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr added in v1.28.0

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID added in v1.28.0

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode added in v1.28.0

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String added in v1.28.0

func (s InvalidNextTokenException) String() string

String returns the string representation

type LimitExceededException added in v1.28.0

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0

func (s LimitExceededException) String() string

String returns the string representation

type ListBatchInferenceJobsInput added in v1.25.35

type ListBatchInferenceJobsInput struct {

	// The maximum number of batch inference job results to return in each page.
	// The default value is 100.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the solution version from which the batch
	// inference jobs were created.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListBatchInferenceJobsInput) GoString added in v1.25.35

func (s ListBatchInferenceJobsInput) GoString() string

GoString returns the string representation

func (*ListBatchInferenceJobsInput) SetMaxResults added in v1.25.35

SetMaxResults sets the MaxResults field's value.

func (*ListBatchInferenceJobsInput) SetNextToken added in v1.25.35

SetNextToken sets the NextToken field's value.

func (*ListBatchInferenceJobsInput) SetSolutionVersionArn added in v1.25.35

func (s *ListBatchInferenceJobsInput) SetSolutionVersionArn(v string) *ListBatchInferenceJobsInput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (ListBatchInferenceJobsInput) String added in v1.25.35

String returns the string representation

func (*ListBatchInferenceJobsInput) Validate added in v1.25.35

func (s *ListBatchInferenceJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBatchInferenceJobsOutput added in v1.25.35

type ListBatchInferenceJobsOutput struct {

	// A list containing information on each job that is returned.
	BatchInferenceJobs []*BatchInferenceJobSummary `locationName:"batchInferenceJobs" type:"list"`

	// The token to use to retreive the next page of results. The value is null
	// when there are no more results to return.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBatchInferenceJobsOutput) GoString added in v1.25.35

func (s ListBatchInferenceJobsOutput) GoString() string

GoString returns the string representation

func (*ListBatchInferenceJobsOutput) SetBatchInferenceJobs added in v1.25.35

SetBatchInferenceJobs sets the BatchInferenceJobs field's value.

func (*ListBatchInferenceJobsOutput) SetNextToken added in v1.25.35

SetNextToken sets the NextToken field's value.

func (ListBatchInferenceJobsOutput) String added in v1.25.35

String returns the string representation

type ListCampaignsInput

type ListCampaignsInput struct {

	// The maximum number of campaigns to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListCampaigns for getting the
	// next set of campaigns (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// 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.
	SolutionArn *string `locationName:"solutionArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListCampaignsInput) GoString

func (s ListCampaignsInput) GoString() string

GoString returns the string representation

func (*ListCampaignsInput) SetMaxResults

func (s *ListCampaignsInput) SetMaxResults(v int64) *ListCampaignsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCampaignsInput) SetNextToken

func (s *ListCampaignsInput) SetNextToken(v string) *ListCampaignsInput

SetNextToken sets the NextToken field's value.

func (*ListCampaignsInput) SetSolutionArn

func (s *ListCampaignsInput) SetSolutionArn(v string) *ListCampaignsInput

SetSolutionArn sets the SolutionArn field's value.

func (ListCampaignsInput) String

func (s ListCampaignsInput) String() string

String returns the string representation

func (*ListCampaignsInput) Validate

func (s *ListCampaignsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCampaignsOutput

type ListCampaignsOutput struct {

	// A list of the campaigns.
	Campaigns []*CampaignSummary `locationName:"campaigns" type:"list"`

	// A token for getting the next set of campaigns (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCampaignsOutput) GoString

func (s ListCampaignsOutput) GoString() string

GoString returns the string representation

func (*ListCampaignsOutput) SetCampaigns

SetCampaigns sets the Campaigns field's value.

func (*ListCampaignsOutput) SetNextToken

func (s *ListCampaignsOutput) SetNextToken(v string) *ListCampaignsOutput

SetNextToken sets the NextToken field's value.

func (ListCampaignsOutput) String

func (s ListCampaignsOutput) String() string

String returns the string representation

type ListDatasetGroupsInput

type ListDatasetGroupsInput struct {

	// The maximum number of dataset groups to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListDatasetGroups for getting
	// the next set of dataset groups (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetGroupsInput) GoString

func (s ListDatasetGroupsInput) GoString() string

GoString returns the string representation

func (*ListDatasetGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsInput) String

func (s ListDatasetGroupsInput) String() string

String returns the string representation

func (*ListDatasetGroupsInput) Validate

func (s *ListDatasetGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetGroupsOutput

type ListDatasetGroupsOutput struct {

	// The list of your dataset groups.
	DatasetGroups []*DatasetGroupSummary `locationName:"datasetGroups" type:"list"`

	// A token for getting the next set of dataset groups (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetGroupsOutput) GoString

func (s ListDatasetGroupsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetGroupsOutput) SetDatasetGroups

SetDatasetGroups sets the DatasetGroups field's value.

func (*ListDatasetGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetGroupsOutput) String

func (s ListDatasetGroupsOutput) String() string

String returns the string representation

type ListDatasetImportJobsInput

type ListDatasetImportJobsInput struct {

	// The Amazon Resource Name (ARN) of the dataset to list the dataset import
	// jobs for.
	DatasetArn *string `locationName:"datasetArn" type:"string"`

	// The maximum number of dataset import jobs to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListDatasetImportJobs for getting
	// the next set of dataset import jobs (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetImportJobsInput) GoString

func (s ListDatasetImportJobsInput) GoString() string

GoString returns the string representation

func (*ListDatasetImportJobsInput) SetDatasetArn

SetDatasetArn sets the DatasetArn field's value.

func (*ListDatasetImportJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetImportJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsInput) String

String returns the string representation

func (*ListDatasetImportJobsInput) Validate

func (s *ListDatasetImportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetImportJobsOutput

type ListDatasetImportJobsOutput struct {

	// The list of dataset import jobs.
	DatasetImportJobs []*DatasetImportJobSummary `locationName:"datasetImportJobs" type:"list"`

	// A token for getting the next set of dataset import jobs (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetImportJobsOutput) GoString

func (s ListDatasetImportJobsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetImportJobsOutput) SetDatasetImportJobs

SetDatasetImportJobs sets the DatasetImportJobs field's value.

func (*ListDatasetImportJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDatasetImportJobsOutput) String

String returns the string representation

type ListDatasetsInput

type ListDatasetsInput struct {

	// The Amazon Resource Name (ARN) of the dataset group that contains the datasets
	// to list.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// The maximum number of datasets to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListDatasetImportJobs for getting
	// the next set of dataset import jobs (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsInput) GoString

func (s ListDatasetsInput) GoString() string

GoString returns the string representation

func (*ListDatasetsInput) SetDatasetGroupArn

func (s *ListDatasetsInput) SetDatasetGroupArn(v string) *ListDatasetsInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*ListDatasetsInput) SetMaxResults

func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDatasetsInput) SetNextToken

func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput

SetNextToken sets the NextToken field's value.

func (ListDatasetsInput) String

func (s ListDatasetsInput) String() string

String returns the string representation

func (*ListDatasetsInput) Validate

func (s *ListDatasetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDatasetsOutput

type ListDatasetsOutput struct {

	// An array of Dataset objects. Each object provides metadata information.
	Datasets []*DatasetSummary `locationName:"datasets" type:"list"`

	// A token for getting the next set of datasets (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDatasetsOutput) GoString

func (s ListDatasetsOutput) GoString() string

GoString returns the string representation

func (*ListDatasetsOutput) SetDatasets

SetDatasets sets the Datasets field's value.

func (*ListDatasetsOutput) SetNextToken

func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput

SetNextToken sets the NextToken field's value.

func (ListDatasetsOutput) String

func (s ListDatasetsOutput) String() string

String returns the string representation

type ListEventTrackersInput

type ListEventTrackersInput struct {

	// The ARN of a dataset group used to filter the response.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// The maximum number of event trackers to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListEventTrackers for getting
	// the next set of event trackers (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventTrackersInput) GoString

func (s ListEventTrackersInput) GoString() string

GoString returns the string representation

func (*ListEventTrackersInput) SetDatasetGroupArn

func (s *ListEventTrackersInput) SetDatasetGroupArn(v string) *ListEventTrackersInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*ListEventTrackersInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListEventTrackersInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEventTrackersInput) String

func (s ListEventTrackersInput) String() string

String returns the string representation

func (*ListEventTrackersInput) Validate

func (s *ListEventTrackersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEventTrackersOutput

type ListEventTrackersOutput struct {

	// A list of event trackers.
	EventTrackers []*EventTrackerSummary `locationName:"eventTrackers" type:"list"`

	// A token for getting the next set of event trackers (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventTrackersOutput) GoString

func (s ListEventTrackersOutput) GoString() string

GoString returns the string representation

func (*ListEventTrackersOutput) SetEventTrackers

SetEventTrackers sets the EventTrackers field's value.

func (*ListEventTrackersOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEventTrackersOutput) String

func (s ListEventTrackersOutput) String() string

String returns the string representation

type ListFiltersInput added in v1.31.12

type ListFiltersInput struct {

	// The ARN of the dataset group that contains the filters.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// The maximum number of filters to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListFilters for getting the next
	// set of filters (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFiltersInput) GoString added in v1.31.12

func (s ListFiltersInput) GoString() string

GoString returns the string representation

func (*ListFiltersInput) SetDatasetGroupArn added in v1.31.12

func (s *ListFiltersInput) SetDatasetGroupArn(v string) *ListFiltersInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*ListFiltersInput) SetMaxResults added in v1.31.12

func (s *ListFiltersInput) SetMaxResults(v int64) *ListFiltersInput

SetMaxResults sets the MaxResults field's value.

func (*ListFiltersInput) SetNextToken added in v1.31.12

func (s *ListFiltersInput) SetNextToken(v string) *ListFiltersInput

SetNextToken sets the NextToken field's value.

func (ListFiltersInput) String added in v1.31.12

func (s ListFiltersInput) String() string

String returns the string representation

func (*ListFiltersInput) Validate added in v1.31.12

func (s *ListFiltersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFiltersOutput added in v1.31.12

type ListFiltersOutput struct {

	// A list of returned filters.
	Filters []*FilterSummary `type:"list"`

	// A token for getting the next set of filters (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFiltersOutput) GoString added in v1.31.12

func (s ListFiltersOutput) GoString() string

GoString returns the string representation

func (*ListFiltersOutput) SetFilters added in v1.31.12

func (s *ListFiltersOutput) SetFilters(v []*FilterSummary) *ListFiltersOutput

SetFilters sets the Filters field's value.

func (*ListFiltersOutput) SetNextToken added in v1.31.12

func (s *ListFiltersOutput) SetNextToken(v string) *ListFiltersOutput

SetNextToken sets the NextToken field's value.

func (ListFiltersOutput) String added in v1.31.12

func (s ListFiltersOutput) String() string

String returns the string representation

type ListRecipesInput

type ListRecipesInput struct {

	// The maximum number of recipes to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListRecipes for getting the next
	// set of recipes (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// The default is SERVICE.
	RecipeProvider *string `locationName:"recipeProvider" type:"string" enum:"RecipeProvider"`
	// contains filtered or unexported fields
}

func (ListRecipesInput) GoString

func (s ListRecipesInput) GoString() string

GoString returns the string representation

func (*ListRecipesInput) SetMaxResults

func (s *ListRecipesInput) SetMaxResults(v int64) *ListRecipesInput

SetMaxResults sets the MaxResults field's value.

func (*ListRecipesInput) SetNextToken

func (s *ListRecipesInput) SetNextToken(v string) *ListRecipesInput

SetNextToken sets the NextToken field's value.

func (*ListRecipesInput) SetRecipeProvider

func (s *ListRecipesInput) SetRecipeProvider(v string) *ListRecipesInput

SetRecipeProvider sets the RecipeProvider field's value.

func (ListRecipesInput) String

func (s ListRecipesInput) String() string

String returns the string representation

func (*ListRecipesInput) Validate

func (s *ListRecipesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRecipesOutput

type ListRecipesOutput struct {

	// A token for getting the next set of recipes.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of available recipes.
	Recipes []*RecipeSummary `locationName:"recipes" type:"list"`
	// contains filtered or unexported fields
}

func (ListRecipesOutput) GoString

func (s ListRecipesOutput) GoString() string

GoString returns the string representation

func (*ListRecipesOutput) SetNextToken

func (s *ListRecipesOutput) SetNextToken(v string) *ListRecipesOutput

SetNextToken sets the NextToken field's value.

func (*ListRecipesOutput) SetRecipes

func (s *ListRecipesOutput) SetRecipes(v []*RecipeSummary) *ListRecipesOutput

SetRecipes sets the Recipes field's value.

func (ListRecipesOutput) String

func (s ListRecipesOutput) String() string

String returns the string representation

type ListSchemasInput

type ListSchemasInput struct {

	// The maximum number of schemas to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListSchemas for getting the next
	// set of schemas (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSchemasInput) GoString

func (s ListSchemasInput) GoString() string

GoString returns the string representation

func (*ListSchemasInput) SetMaxResults

func (s *ListSchemasInput) SetMaxResults(v int64) *ListSchemasInput

SetMaxResults sets the MaxResults field's value.

func (*ListSchemasInput) SetNextToken

func (s *ListSchemasInput) SetNextToken(v string) *ListSchemasInput

SetNextToken sets the NextToken field's value.

func (ListSchemasInput) String

func (s ListSchemasInput) String() string

String returns the string representation

func (*ListSchemasInput) Validate

func (s *ListSchemasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSchemasOutput

type ListSchemasOutput struct {

	// A token used to get the next set of schemas (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of schemas.
	Schemas []*DatasetSchemaSummary `locationName:"schemas" type:"list"`
	// contains filtered or unexported fields
}

func (ListSchemasOutput) GoString

func (s ListSchemasOutput) GoString() string

GoString returns the string representation

func (*ListSchemasOutput) SetNextToken

func (s *ListSchemasOutput) SetNextToken(v string) *ListSchemasOutput

SetNextToken sets the NextToken field's value.

func (*ListSchemasOutput) SetSchemas

SetSchemas sets the Schemas field's value.

func (ListSchemasOutput) String

func (s ListSchemasOutput) String() string

String returns the string representation

type ListSolutionVersionsInput

type ListSolutionVersionsInput struct {

	// The maximum number of solution versions to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListSolutionVersions for getting
	// the next set of solution versions (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// The Amazon Resource Name (ARN) of the solution.
	SolutionArn *string `locationName:"solutionArn" type:"string"`
	// contains filtered or unexported fields
}

func (ListSolutionVersionsInput) GoString

func (s ListSolutionVersionsInput) GoString() string

GoString returns the string representation

func (*ListSolutionVersionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListSolutionVersionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListSolutionVersionsInput) SetSolutionArn

SetSolutionArn sets the SolutionArn field's value.

func (ListSolutionVersionsInput) String

func (s ListSolutionVersionsInput) String() string

String returns the string representation

func (*ListSolutionVersionsInput) Validate

func (s *ListSolutionVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSolutionVersionsOutput

type ListSolutionVersionsOutput struct {

	// A token for getting the next set of solution versions (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of solution versions describing the version properties.
	SolutionVersions []*SolutionVersionSummary `locationName:"solutionVersions" type:"list"`
	// contains filtered or unexported fields
}

func (ListSolutionVersionsOutput) GoString

func (s ListSolutionVersionsOutput) GoString() string

GoString returns the string representation

func (*ListSolutionVersionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListSolutionVersionsOutput) SetSolutionVersions

SetSolutionVersions sets the SolutionVersions field's value.

func (ListSolutionVersionsOutput) String

String returns the string representation

type ListSolutionsInput

type ListSolutionsInput struct {

	// The Amazon Resource Name (ARN) of the dataset group.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

	// The maximum number of solutions to return.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// A token returned from the previous call to ListSolutions for getting the
	// next set of solutions (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSolutionsInput) GoString

func (s ListSolutionsInput) GoString() string

GoString returns the string representation

func (*ListSolutionsInput) SetDatasetGroupArn

func (s *ListSolutionsInput) SetDatasetGroupArn(v string) *ListSolutionsInput

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*ListSolutionsInput) SetMaxResults

func (s *ListSolutionsInput) SetMaxResults(v int64) *ListSolutionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSolutionsInput) SetNextToken

func (s *ListSolutionsInput) SetNextToken(v string) *ListSolutionsInput

SetNextToken sets the NextToken field's value.

func (ListSolutionsInput) String

func (s ListSolutionsInput) String() string

String returns the string representation

func (*ListSolutionsInput) Validate

func (s *ListSolutionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSolutionsOutput

type ListSolutionsOutput struct {

	// A token for getting the next set of solutions (if they exist).
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of the current solutions.
	Solutions []*SolutionSummary `locationName:"solutions" type:"list"`
	// contains filtered or unexported fields
}

func (ListSolutionsOutput) GoString

func (s ListSolutionsOutput) GoString() string

GoString returns the string representation

func (*ListSolutionsOutput) SetNextToken

func (s *ListSolutionsOutput) SetNextToken(v string) *ListSolutionsOutput

SetNextToken sets the NextToken field's value.

func (*ListSolutionsOutput) SetSolutions

SetSolutions sets the Solutions field's value.

func (ListSolutionsOutput) String

func (s ListSolutionsOutput) String() string

String returns the string representation

type Personalize

type Personalize struct {
	*client.Client
}

Personalize provides the API operation methods for making requests to Amazon Personalize. See this package's package overview docs for details on the service.

Personalize methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Personalize

New creates a new instance of the Personalize client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Personalize client from just a session.
svc := personalize.New(mySession)

// Create a Personalize client with additional configuration
svc := personalize.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Personalize) CreateBatchInferenceJob added in v1.25.35

func (c *Personalize) CreateBatchInferenceJob(input *CreateBatchInferenceJobInput) (*CreateBatchInferenceJobOutput, error)

CreateBatchInferenceJob API operation for Amazon Personalize.

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateBatchInferenceJob for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

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

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJob

func (*Personalize) CreateBatchInferenceJobRequest added in v1.25.35

func (c *Personalize) CreateBatchInferenceJobRequest(input *CreateBatchInferenceJobInput) (req *request.Request, output *CreateBatchInferenceJobOutput)

CreateBatchInferenceJobRequest generates a "aws/request.Request" representing the client's request for the CreateBatchInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBatchInferenceJob for more information on using the CreateBatchInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBatchInferenceJobRequest method.
req, resp := client.CreateBatchInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJob

func (*Personalize) CreateBatchInferenceJobWithContext added in v1.25.35

func (c *Personalize) CreateBatchInferenceJobWithContext(ctx aws.Context, input *CreateBatchInferenceJobInput, opts ...request.Option) (*CreateBatchInferenceJobOutput, error)

CreateBatchInferenceJobWithContext is the same as CreateBatchInferenceJob with the addition of the ability to pass a context and additional request options.

See CreateBatchInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateCampaign

func (c *Personalize) CreateCampaign(input *CreateCampaignInput) (*CreateCampaignOutput, error)

CreateCampaign API operation for Amazon Personalize.

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) and GetPersonalizedRanking (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateCampaign for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceAlreadyExistsException The specified resource already exists.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaign

func (*Personalize) CreateCampaignRequest

func (c *Personalize) CreateCampaignRequest(input *CreateCampaignInput) (req *request.Request, output *CreateCampaignOutput)

CreateCampaignRequest generates a "aws/request.Request" representing the client's request for the CreateCampaign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCampaign for more information on using the CreateCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCampaignRequest method.
req, resp := client.CreateCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateCampaign

func (*Personalize) CreateCampaignWithContext

func (c *Personalize) CreateCampaignWithContext(ctx aws.Context, input *CreateCampaignInput, opts ...request.Option) (*CreateCampaignOutput, error)

CreateCampaignWithContext is the same as CreateCampaign with the addition of the ability to pass a context and additional request options.

See CreateCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateDataset

func (c *Personalize) CreateDataset(input *CreateDatasetInput) (*CreateDatasetOutput, error)

CreateDataset API operation for Amazon Personalize.

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateDataset for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceAlreadyExistsException The specified resource already exists.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDataset

func (*Personalize) CreateDatasetGroup

func (c *Personalize) CreateDatasetGroup(input *CreateDatasetGroupInput) (*CreateDatasetGroupOutput, error)

CreateDatasetGroup API operation for Amazon Personalize.

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateDatasetGroup for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup

func (*Personalize) CreateDatasetGroupRequest

func (c *Personalize) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) (req *request.Request, output *CreateDatasetGroupOutput)

CreateDatasetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDatasetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDatasetGroup for more information on using the CreateDatasetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDatasetGroupRequest method.
req, resp := client.CreateDatasetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetGroup

func (*Personalize) CreateDatasetGroupWithContext

func (c *Personalize) CreateDatasetGroupWithContext(ctx aws.Context, input *CreateDatasetGroupInput, opts ...request.Option) (*CreateDatasetGroupOutput, error)

CreateDatasetGroupWithContext is the same as CreateDatasetGroup with the addition of the ability to pass a context and additional request options.

See CreateDatasetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateDatasetImportJob

func (c *Personalize) CreateDatasetImportJob(input *CreateDatasetImportJobInput) (*CreateDatasetImportJobOutput, error)

CreateDatasetImportJob API operation for Amazon Personalize.

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.

The dataset import job replaces any previous data in the dataset.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateDatasetImportJob for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceAlreadyExistsException The specified resource already exists.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJob

func (*Personalize) CreateDatasetImportJobRequest

func (c *Personalize) CreateDatasetImportJobRequest(input *CreateDatasetImportJobInput) (req *request.Request, output *CreateDatasetImportJobOutput)

CreateDatasetImportJobRequest generates a "aws/request.Request" representing the client's request for the CreateDatasetImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDatasetImportJob for more information on using the CreateDatasetImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDatasetImportJobRequest method.
req, resp := client.CreateDatasetImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDatasetImportJob

func (*Personalize) CreateDatasetImportJobWithContext

func (c *Personalize) CreateDatasetImportJobWithContext(ctx aws.Context, input *CreateDatasetImportJobInput, opts ...request.Option) (*CreateDatasetImportJobOutput, error)

CreateDatasetImportJobWithContext is the same as CreateDatasetImportJob with the addition of the ability to pass a context and additional request options.

See CreateDatasetImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateDatasetRequest

func (c *Personalize) CreateDatasetRequest(input *CreateDatasetInput) (req *request.Request, output *CreateDatasetOutput)

CreateDatasetRequest generates a "aws/request.Request" representing the client's request for the CreateDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDataset for more information on using the CreateDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDatasetRequest method.
req, resp := client.CreateDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateDataset

func (*Personalize) CreateDatasetWithContext

func (c *Personalize) CreateDatasetWithContext(ctx aws.Context, input *CreateDatasetInput, opts ...request.Option) (*CreateDatasetOutput, error)

CreateDatasetWithContext is the same as CreateDataset with the addition of the ability to pass a context and additional request options.

See CreateDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateEventTracker

func (c *Personalize) CreateEventTracker(input *CreateEventTrackerInput) (*CreateEventTrackerOutput, error)

CreateEventTracker API operation for Amazon Personalize.

Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API.

When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateEventTracker for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException Could not find the specified resource.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTracker

func (*Personalize) CreateEventTrackerRequest

func (c *Personalize) CreateEventTrackerRequest(input *CreateEventTrackerInput) (req *request.Request, output *CreateEventTrackerOutput)

CreateEventTrackerRequest generates a "aws/request.Request" representing the client's request for the CreateEventTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEventTracker for more information on using the CreateEventTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEventTrackerRequest method.
req, resp := client.CreateEventTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateEventTracker

func (*Personalize) CreateEventTrackerWithContext

func (c *Personalize) CreateEventTrackerWithContext(ctx aws.Context, input *CreateEventTrackerInput, opts ...request.Option) (*CreateEventTrackerOutput, error)

CreateEventTrackerWithContext is the same as CreateEventTracker with the addition of the ability to pass a context and additional request options.

See CreateEventTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateFilter added in v1.31.12

func (c *Personalize) CreateFilter(input *CreateFilterInput) (*CreateFilterOutput, error)

CreateFilter API operation for Amazon Personalize.

Creates a recommendation filter. For more information, see Using Filters with Amazon Personalize (https://docs.aws.amazon.com/personalize/latest/dg/filters.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateFilter for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException Could not find the specified resource.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilter

func (*Personalize) CreateFilterRequest added in v1.31.12

func (c *Personalize) CreateFilterRequest(input *CreateFilterInput) (req *request.Request, output *CreateFilterOutput)

CreateFilterRequest generates a "aws/request.Request" representing the client's request for the CreateFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFilter for more information on using the CreateFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFilterRequest method.
req, resp := client.CreateFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilter

func (*Personalize) CreateFilterWithContext added in v1.31.12

func (c *Personalize) CreateFilterWithContext(ctx aws.Context, input *CreateFilterInput, opts ...request.Option) (*CreateFilterOutput, error)

CreateFilterWithContext is the same as CreateFilter with the addition of the ability to pass a context and additional request options.

See CreateFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateSchema

func (c *Personalize) CreateSchema(input *CreateSchemaInput) (*CreateSchemaOutput, error)

CreateSchema API operation for Amazon Personalize.

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateSchema for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchema

func (*Personalize) CreateSchemaRequest

func (c *Personalize) CreateSchemaRequest(input *CreateSchemaInput) (req *request.Request, output *CreateSchemaOutput)

CreateSchemaRequest generates a "aws/request.Request" representing the client's request for the CreateSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSchema for more information on using the CreateSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSchemaRequest method.
req, resp := client.CreateSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSchema

func (*Personalize) CreateSchemaWithContext

func (c *Personalize) CreateSchemaWithContext(ctx aws.Context, input *CreateSchemaInput, opts ...request.Option) (*CreateSchemaOutput, error)

CreateSchemaWithContext is the same as CreateSchema with the addition of the ability to pass a context and additional request options.

See CreateSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateSolution

func (c *Personalize) CreateSolution(input *CreateSolutionInput) (*CreateSolutionOutput, error)

CreateSolution API operation for Amazon Personalize.

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution

  • ListSolutionVersions

  • DescribeSolutionVersion

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateSolution for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException Could not find the specified resource.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolution

func (*Personalize) CreateSolutionRequest

func (c *Personalize) CreateSolutionRequest(input *CreateSolutionInput) (req *request.Request, output *CreateSolutionOutput)

CreateSolutionRequest generates a "aws/request.Request" representing the client's request for the CreateSolution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSolution for more information on using the CreateSolution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSolutionRequest method.
req, resp := client.CreateSolutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolution

func (*Personalize) CreateSolutionVersion

func (c *Personalize) CreateSolutionVersion(input *CreateSolutionVersionInput) (*CreateSolutionVersionOutput, error)

CreateSolutionVersion API operation for Amazon Personalize.

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

  • ListSolutionVersions

  • DescribeSolutionVersion

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation CreateSolutionVersion for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

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

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersion

func (*Personalize) CreateSolutionVersionRequest

func (c *Personalize) CreateSolutionVersionRequest(input *CreateSolutionVersionInput) (req *request.Request, output *CreateSolutionVersionOutput)

CreateSolutionVersionRequest generates a "aws/request.Request" representing the client's request for the CreateSolutionVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSolutionVersion for more information on using the CreateSolutionVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSolutionVersionRequest method.
req, resp := client.CreateSolutionVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersion

func (*Personalize) CreateSolutionVersionWithContext

func (c *Personalize) CreateSolutionVersionWithContext(ctx aws.Context, input *CreateSolutionVersionInput, opts ...request.Option) (*CreateSolutionVersionOutput, error)

CreateSolutionVersionWithContext is the same as CreateSolutionVersion with the addition of the ability to pass a context and additional request options.

See CreateSolutionVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) CreateSolutionWithContext

func (c *Personalize) CreateSolutionWithContext(ctx aws.Context, input *CreateSolutionInput, opts ...request.Option) (*CreateSolutionOutput, error)

CreateSolutionWithContext is the same as CreateSolution with the addition of the ability to pass a context and additional request options.

See CreateSolution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteCampaign

func (c *Personalize) DeleteCampaign(input *DeleteCampaignInput) (*DeleteCampaignOutput, error)

DeleteCampaign API operation for Amazon Personalize.

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) request. For more information on campaigns, see CreateCampaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteCampaign for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteCampaign

func (*Personalize) DeleteCampaignRequest

func (c *Personalize) DeleteCampaignRequest(input *DeleteCampaignInput) (req *request.Request, output *DeleteCampaignOutput)

DeleteCampaignRequest generates a "aws/request.Request" representing the client's request for the DeleteCampaign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCampaign for more information on using the DeleteCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCampaignRequest method.
req, resp := client.DeleteCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteCampaign

func (*Personalize) DeleteCampaignWithContext

func (c *Personalize) DeleteCampaignWithContext(ctx aws.Context, input *DeleteCampaignInput, opts ...request.Option) (*DeleteCampaignOutput, error)

DeleteCampaignWithContext is the same as DeleteCampaign with the addition of the ability to pass a context and additional request options.

See DeleteCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteDataset

func (c *Personalize) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error)

DeleteDataset API operation for Amazon Personalize.

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteDataset for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDataset

func (*Personalize) DeleteDatasetGroup

func (c *Personalize) DeleteDatasetGroup(input *DeleteDatasetGroupInput) (*DeleteDatasetGroupOutput, error)

DeleteDatasetGroup API operation for Amazon Personalize.

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteDatasetGroup for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetGroup

func (*Personalize) DeleteDatasetGroupRequest

func (c *Personalize) DeleteDatasetGroupRequest(input *DeleteDatasetGroupInput) (req *request.Request, output *DeleteDatasetGroupOutput)

DeleteDatasetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDatasetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDatasetGroup for more information on using the DeleteDatasetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDatasetGroupRequest method.
req, resp := client.DeleteDatasetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetGroup

func (*Personalize) DeleteDatasetGroupWithContext

func (c *Personalize) DeleteDatasetGroupWithContext(ctx aws.Context, input *DeleteDatasetGroupInput, opts ...request.Option) (*DeleteDatasetGroupOutput, error)

DeleteDatasetGroupWithContext is the same as DeleteDatasetGroup with the addition of the ability to pass a context and additional request options.

See DeleteDatasetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteDatasetRequest

func (c *Personalize) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput)

DeleteDatasetRequest generates a "aws/request.Request" representing the client's request for the DeleteDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataset for more information on using the DeleteDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDatasetRequest method.
req, resp := client.DeleteDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDataset

func (*Personalize) DeleteDatasetWithContext

func (c *Personalize) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error)

DeleteDatasetWithContext is the same as DeleteDataset with the addition of the ability to pass a context and additional request options.

See DeleteDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteEventTracker

func (c *Personalize) DeleteEventTracker(input *DeleteEventTrackerInput) (*DeleteEventTrackerOutput, error)

DeleteEventTracker API operation for Amazon Personalize.

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteEventTracker for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteEventTracker

func (*Personalize) DeleteEventTrackerRequest

func (c *Personalize) DeleteEventTrackerRequest(input *DeleteEventTrackerInput) (req *request.Request, output *DeleteEventTrackerOutput)

DeleteEventTrackerRequest generates a "aws/request.Request" representing the client's request for the DeleteEventTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEventTracker for more information on using the DeleteEventTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEventTrackerRequest method.
req, resp := client.DeleteEventTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteEventTracker

func (*Personalize) DeleteEventTrackerWithContext

func (c *Personalize) DeleteEventTrackerWithContext(ctx aws.Context, input *DeleteEventTrackerInput, opts ...request.Option) (*DeleteEventTrackerOutput, error)

DeleteEventTrackerWithContext is the same as DeleteEventTracker with the addition of the ability to pass a context and additional request options.

See DeleteEventTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteFilter added in v1.31.12

func (c *Personalize) DeleteFilter(input *DeleteFilterInput) (*DeleteFilterOutput, error)

DeleteFilter API operation for Amazon Personalize.

Deletes a filter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteFilter for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilter

func (*Personalize) DeleteFilterRequest added in v1.31.12

func (c *Personalize) DeleteFilterRequest(input *DeleteFilterInput) (req *request.Request, output *DeleteFilterOutput)

DeleteFilterRequest generates a "aws/request.Request" representing the client's request for the DeleteFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFilter for more information on using the DeleteFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFilterRequest method.
req, resp := client.DeleteFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteFilter

func (*Personalize) DeleteFilterWithContext added in v1.31.12

func (c *Personalize) DeleteFilterWithContext(ctx aws.Context, input *DeleteFilterInput, opts ...request.Option) (*DeleteFilterOutput, error)

DeleteFilterWithContext is the same as DeleteFilter with the addition of the ability to pass a context and additional request options.

See DeleteFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteSchema

func (c *Personalize) DeleteSchema(input *DeleteSchemaInput) (*DeleteSchemaOutput, error)

DeleteSchema API operation for Amazon Personalize.

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteSchema for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSchema

func (*Personalize) DeleteSchemaRequest

func (c *Personalize) DeleteSchemaRequest(input *DeleteSchemaInput) (req *request.Request, output *DeleteSchemaOutput)

DeleteSchemaRequest generates a "aws/request.Request" representing the client's request for the DeleteSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSchema for more information on using the DeleteSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSchemaRequest method.
req, resp := client.DeleteSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSchema

func (*Personalize) DeleteSchemaWithContext

func (c *Personalize) DeleteSchemaWithContext(ctx aws.Context, input *DeleteSchemaInput, opts ...request.Option) (*DeleteSchemaOutput, error)

DeleteSchemaWithContext is the same as DeleteSchema with the addition of the ability to pass a context and additional request options.

See DeleteSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DeleteSolution

func (c *Personalize) DeleteSolution(input *DeleteSolutionInput) (*DeleteSolutionOutput, error)

DeleteSolution API operation for Amazon Personalize.

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DeleteSolution for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSolution

func (*Personalize) DeleteSolutionRequest

func (c *Personalize) DeleteSolutionRequest(input *DeleteSolutionInput) (req *request.Request, output *DeleteSolutionOutput)

DeleteSolutionRequest generates a "aws/request.Request" representing the client's request for the DeleteSolution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSolution for more information on using the DeleteSolution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSolutionRequest method.
req, resp := client.DeleteSolutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSolution

func (*Personalize) DeleteSolutionWithContext

func (c *Personalize) DeleteSolutionWithContext(ctx aws.Context, input *DeleteSolutionInput, opts ...request.Option) (*DeleteSolutionOutput, error)

DeleteSolutionWithContext is the same as DeleteSolution with the addition of the ability to pass a context and additional request options.

See DeleteSolution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeAlgorithm

func (c *Personalize) DescribeAlgorithm(input *DescribeAlgorithmInput) (*DescribeAlgorithmOutput, error)

DescribeAlgorithm API operation for Amazon Personalize.

Describes the given algorithm.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeAlgorithm for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithm

func (*Personalize) DescribeAlgorithmRequest

func (c *Personalize) DescribeAlgorithmRequest(input *DescribeAlgorithmInput) (req *request.Request, output *DescribeAlgorithmOutput)

DescribeAlgorithmRequest generates a "aws/request.Request" representing the client's request for the DescribeAlgorithm operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAlgorithm for more information on using the DescribeAlgorithm API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAlgorithmRequest method.
req, resp := client.DescribeAlgorithmRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithm

func (*Personalize) DescribeAlgorithmWithContext

func (c *Personalize) DescribeAlgorithmWithContext(ctx aws.Context, input *DescribeAlgorithmInput, opts ...request.Option) (*DescribeAlgorithmOutput, error)

DescribeAlgorithmWithContext is the same as DescribeAlgorithm with the addition of the ability to pass a context and additional request options.

See DescribeAlgorithm for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeBatchInferenceJob added in v1.25.35

func (c *Personalize) DescribeBatchInferenceJob(input *DescribeBatchInferenceJobInput) (*DescribeBatchInferenceJobOutput, error)

DescribeBatchInferenceJob API operation for Amazon Personalize.

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeBatchInferenceJob for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJob

func (*Personalize) DescribeBatchInferenceJobRequest added in v1.25.35

func (c *Personalize) DescribeBatchInferenceJobRequest(input *DescribeBatchInferenceJobInput) (req *request.Request, output *DescribeBatchInferenceJobOutput)

DescribeBatchInferenceJobRequest generates a "aws/request.Request" representing the client's request for the DescribeBatchInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBatchInferenceJob for more information on using the DescribeBatchInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBatchInferenceJobRequest method.
req, resp := client.DescribeBatchInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJob

func (*Personalize) DescribeBatchInferenceJobWithContext added in v1.25.35

func (c *Personalize) DescribeBatchInferenceJobWithContext(ctx aws.Context, input *DescribeBatchInferenceJobInput, opts ...request.Option) (*DescribeBatchInferenceJobOutput, error)

DescribeBatchInferenceJobWithContext is the same as DescribeBatchInferenceJob with the addition of the ability to pass a context and additional request options.

See DescribeBatchInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeCampaign

func (c *Personalize) DescribeCampaign(input *DescribeCampaignInput) (*DescribeCampaignOutput, error)

DescribeCampaign API operation for Amazon Personalize.

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeCampaign for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign

func (*Personalize) DescribeCampaignRequest

func (c *Personalize) DescribeCampaignRequest(input *DescribeCampaignInput) (req *request.Request, output *DescribeCampaignOutput)

DescribeCampaignRequest generates a "aws/request.Request" representing the client's request for the DescribeCampaign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCampaign for more information on using the DescribeCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCampaignRequest method.
req, resp := client.DescribeCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign

func (*Personalize) DescribeCampaignWithContext

func (c *Personalize) DescribeCampaignWithContext(ctx aws.Context, input *DescribeCampaignInput, opts ...request.Option) (*DescribeCampaignOutput, error)

DescribeCampaignWithContext is the same as DescribeCampaign with the addition of the ability to pass a context and additional request options.

See DescribeCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeDataset

func (c *Personalize) DescribeDataset(input *DescribeDatasetInput) (*DescribeDatasetOutput, error)

DescribeDataset API operation for Amazon Personalize.

Describes the given dataset. For more information on datasets, see CreateDataset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeDataset for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset

func (*Personalize) DescribeDatasetGroup

func (c *Personalize) DescribeDatasetGroup(input *DescribeDatasetGroupInput) (*DescribeDatasetGroupOutput, error)

DescribeDatasetGroup API operation for Amazon Personalize.

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeDatasetGroup for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup

func (*Personalize) DescribeDatasetGroupRequest

func (c *Personalize) DescribeDatasetGroupRequest(input *DescribeDatasetGroupInput) (req *request.Request, output *DescribeDatasetGroupOutput)

DescribeDatasetGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeDatasetGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDatasetGroup for more information on using the DescribeDatasetGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDatasetGroupRequest method.
req, resp := client.DescribeDatasetGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup

func (*Personalize) DescribeDatasetGroupWithContext

func (c *Personalize) DescribeDatasetGroupWithContext(ctx aws.Context, input *DescribeDatasetGroupInput, opts ...request.Option) (*DescribeDatasetGroupOutput, error)

DescribeDatasetGroupWithContext is the same as DescribeDatasetGroup with the addition of the ability to pass a context and additional request options.

See DescribeDatasetGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeDatasetImportJob

func (c *Personalize) DescribeDatasetImportJob(input *DescribeDatasetImportJobInput) (*DescribeDatasetImportJobOutput, error)

DescribeDatasetImportJob API operation for Amazon Personalize.

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeDatasetImportJob for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJob

func (*Personalize) DescribeDatasetImportJobRequest

func (c *Personalize) DescribeDatasetImportJobRequest(input *DescribeDatasetImportJobInput) (req *request.Request, output *DescribeDatasetImportJobOutput)

DescribeDatasetImportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeDatasetImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDatasetImportJob for more information on using the DescribeDatasetImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDatasetImportJobRequest method.
req, resp := client.DescribeDatasetImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJob

func (*Personalize) DescribeDatasetImportJobWithContext

func (c *Personalize) DescribeDatasetImportJobWithContext(ctx aws.Context, input *DescribeDatasetImportJobInput, opts ...request.Option) (*DescribeDatasetImportJobOutput, error)

DescribeDatasetImportJobWithContext is the same as DescribeDatasetImportJob with the addition of the ability to pass a context and additional request options.

See DescribeDatasetImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeDatasetRequest

func (c *Personalize) DescribeDatasetRequest(input *DescribeDatasetInput) (req *request.Request, output *DescribeDatasetOutput)

DescribeDatasetRequest generates a "aws/request.Request" representing the client's request for the DescribeDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDataset for more information on using the DescribeDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDatasetRequest method.
req, resp := client.DescribeDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset

func (*Personalize) DescribeDatasetWithContext

func (c *Personalize) DescribeDatasetWithContext(ctx aws.Context, input *DescribeDatasetInput, opts ...request.Option) (*DescribeDatasetOutput, error)

DescribeDatasetWithContext is the same as DescribeDataset with the addition of the ability to pass a context and additional request options.

See DescribeDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeEventTracker

func (c *Personalize) DescribeEventTracker(input *DescribeEventTrackerInput) (*DescribeEventTrackerOutput, error)

DescribeEventTracker API operation for Amazon Personalize.

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeEventTracker for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTracker

func (*Personalize) DescribeEventTrackerRequest

func (c *Personalize) DescribeEventTrackerRequest(input *DescribeEventTrackerInput) (req *request.Request, output *DescribeEventTrackerOutput)

DescribeEventTrackerRequest generates a "aws/request.Request" representing the client's request for the DescribeEventTracker operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventTracker for more information on using the DescribeEventTracker API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEventTrackerRequest method.
req, resp := client.DescribeEventTrackerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTracker

func (*Personalize) DescribeEventTrackerWithContext

func (c *Personalize) DescribeEventTrackerWithContext(ctx aws.Context, input *DescribeEventTrackerInput, opts ...request.Option) (*DescribeEventTrackerOutput, error)

DescribeEventTrackerWithContext is the same as DescribeEventTracker with the addition of the ability to pass a context and additional request options.

See DescribeEventTracker for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeFeatureTransformation

func (c *Personalize) DescribeFeatureTransformation(input *DescribeFeatureTransformationInput) (*DescribeFeatureTransformationOutput, error)

DescribeFeatureTransformation API operation for Amazon Personalize.

Describes the given feature transformation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeFeatureTransformation for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformation

func (*Personalize) DescribeFeatureTransformationRequest

func (c *Personalize) DescribeFeatureTransformationRequest(input *DescribeFeatureTransformationInput) (req *request.Request, output *DescribeFeatureTransformationOutput)

DescribeFeatureTransformationRequest generates a "aws/request.Request" representing the client's request for the DescribeFeatureTransformation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFeatureTransformation for more information on using the DescribeFeatureTransformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFeatureTransformationRequest method.
req, resp := client.DescribeFeatureTransformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformation

func (*Personalize) DescribeFeatureTransformationWithContext

func (c *Personalize) DescribeFeatureTransformationWithContext(ctx aws.Context, input *DescribeFeatureTransformationInput, opts ...request.Option) (*DescribeFeatureTransformationOutput, error)

DescribeFeatureTransformationWithContext is the same as DescribeFeatureTransformation with the addition of the ability to pass a context and additional request options.

See DescribeFeatureTransformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeFilter added in v1.31.12

func (c *Personalize) DescribeFilter(input *DescribeFilterInput) (*DescribeFilterOutput, error)

DescribeFilter API operation for Amazon Personalize.

Describes a filter's properties.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeFilter for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilter

func (*Personalize) DescribeFilterRequest added in v1.31.12

func (c *Personalize) DescribeFilterRequest(input *DescribeFilterInput) (req *request.Request, output *DescribeFilterOutput)

DescribeFilterRequest generates a "aws/request.Request" representing the client's request for the DescribeFilter operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFilter for more information on using the DescribeFilter API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFilterRequest method.
req, resp := client.DescribeFilterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFilter

func (*Personalize) DescribeFilterWithContext added in v1.31.12

func (c *Personalize) DescribeFilterWithContext(ctx aws.Context, input *DescribeFilterInput, opts ...request.Option) (*DescribeFilterOutput, error)

DescribeFilterWithContext is the same as DescribeFilter with the addition of the ability to pass a context and additional request options.

See DescribeFilter for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeRecipe

func (c *Personalize) DescribeRecipe(input *DescribeRecipeInput) (*DescribeRecipeOutput, error)

DescribeRecipe API operation for Amazon Personalize.

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeRecipe for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipe

func (*Personalize) DescribeRecipeRequest

func (c *Personalize) DescribeRecipeRequest(input *DescribeRecipeInput) (req *request.Request, output *DescribeRecipeOutput)

DescribeRecipeRequest generates a "aws/request.Request" representing the client's request for the DescribeRecipe operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRecipe for more information on using the DescribeRecipe API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRecipeRequest method.
req, resp := client.DescribeRecipeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipe

func (*Personalize) DescribeRecipeWithContext

func (c *Personalize) DescribeRecipeWithContext(ctx aws.Context, input *DescribeRecipeInput, opts ...request.Option) (*DescribeRecipeOutput, error)

DescribeRecipeWithContext is the same as DescribeRecipe with the addition of the ability to pass a context and additional request options.

See DescribeRecipe for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeSchema

func (c *Personalize) DescribeSchema(input *DescribeSchemaInput) (*DescribeSchemaOutput, error)

DescribeSchema API operation for Amazon Personalize.

Describes a schema. For more information on schemas, see CreateSchema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeSchema for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema

func (*Personalize) DescribeSchemaRequest

func (c *Personalize) DescribeSchemaRequest(input *DescribeSchemaInput) (req *request.Request, output *DescribeSchemaOutput)

DescribeSchemaRequest generates a "aws/request.Request" representing the client's request for the DescribeSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSchema for more information on using the DescribeSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSchemaRequest method.
req, resp := client.DescribeSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema

func (*Personalize) DescribeSchemaWithContext

func (c *Personalize) DescribeSchemaWithContext(ctx aws.Context, input *DescribeSchemaInput, opts ...request.Option) (*DescribeSchemaOutput, error)

DescribeSchemaWithContext is the same as DescribeSchema with the addition of the ability to pass a context and additional request options.

See DescribeSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeSolution

func (c *Personalize) DescribeSolution(input *DescribeSolutionInput) (*DescribeSolutionOutput, error)

DescribeSolution API operation for Amazon Personalize.

Describes a solution. For more information on solutions, see CreateSolution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeSolution for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolution

func (*Personalize) DescribeSolutionRequest

func (c *Personalize) DescribeSolutionRequest(input *DescribeSolutionInput) (req *request.Request, output *DescribeSolutionOutput)

DescribeSolutionRequest generates a "aws/request.Request" representing the client's request for the DescribeSolution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSolution for more information on using the DescribeSolution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSolutionRequest method.
req, resp := client.DescribeSolutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolution

func (*Personalize) DescribeSolutionVersion

func (c *Personalize) DescribeSolutionVersion(input *DescribeSolutionVersionInput) (*DescribeSolutionVersionOutput, error)

DescribeSolutionVersion API operation for Amazon Personalize.

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation DescribeSolutionVersion for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersion

func (*Personalize) DescribeSolutionVersionRequest

func (c *Personalize) DescribeSolutionVersionRequest(input *DescribeSolutionVersionInput) (req *request.Request, output *DescribeSolutionVersionOutput)

DescribeSolutionVersionRequest generates a "aws/request.Request" representing the client's request for the DescribeSolutionVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSolutionVersion for more information on using the DescribeSolutionVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeSolutionVersionRequest method.
req, resp := client.DescribeSolutionVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersion

func (*Personalize) DescribeSolutionVersionWithContext

func (c *Personalize) DescribeSolutionVersionWithContext(ctx aws.Context, input *DescribeSolutionVersionInput, opts ...request.Option) (*DescribeSolutionVersionOutput, error)

DescribeSolutionVersionWithContext is the same as DescribeSolutionVersion with the addition of the ability to pass a context and additional request options.

See DescribeSolutionVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) DescribeSolutionWithContext

func (c *Personalize) DescribeSolutionWithContext(ctx aws.Context, input *DescribeSolutionInput, opts ...request.Option) (*DescribeSolutionOutput, error)

DescribeSolutionWithContext is the same as DescribeSolution with the addition of the ability to pass a context and additional request options.

See DescribeSolution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) GetSolutionMetrics

func (c *Personalize) GetSolutionMetrics(input *GetSolutionMetricsInput) (*GetSolutionMetricsOutput, error)

GetSolutionMetrics API operation for Amazon Personalize.

Gets the metrics for the specified solution version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation GetSolutionMetrics for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetrics

func (*Personalize) GetSolutionMetricsRequest

func (c *Personalize) GetSolutionMetricsRequest(input *GetSolutionMetricsInput) (req *request.Request, output *GetSolutionMetricsOutput)

GetSolutionMetricsRequest generates a "aws/request.Request" representing the client's request for the GetSolutionMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSolutionMetrics for more information on using the GetSolutionMetrics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSolutionMetricsRequest method.
req, resp := client.GetSolutionMetricsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetrics

func (*Personalize) GetSolutionMetricsWithContext

func (c *Personalize) GetSolutionMetricsWithContext(ctx aws.Context, input *GetSolutionMetricsInput, opts ...request.Option) (*GetSolutionMetricsOutput, error)

GetSolutionMetricsWithContext is the same as GetSolutionMetrics with the addition of the ability to pass a context and additional request options.

See GetSolutionMetrics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListBatchInferenceJobs added in v1.25.35

func (c *Personalize) ListBatchInferenceJobs(input *ListBatchInferenceJobsInput) (*ListBatchInferenceJobsOutput, error)

ListBatchInferenceJobs API operation for Amazon Personalize.

Gets a list of the batch inference jobs that have been performed off of a solution version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListBatchInferenceJobs for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs

func (*Personalize) ListBatchInferenceJobsPages added in v1.25.35

func (c *Personalize) ListBatchInferenceJobsPages(input *ListBatchInferenceJobsInput, fn func(*ListBatchInferenceJobsOutput, bool) bool) error

ListBatchInferenceJobsPages iterates over the pages of a ListBatchInferenceJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBatchInferenceJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBatchInferenceJobs operation.
pageNum := 0
err := client.ListBatchInferenceJobsPages(params,
    func(page *personalize.ListBatchInferenceJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListBatchInferenceJobsPagesWithContext added in v1.25.35

func (c *Personalize) ListBatchInferenceJobsPagesWithContext(ctx aws.Context, input *ListBatchInferenceJobsInput, fn func(*ListBatchInferenceJobsOutput, bool) bool, opts ...request.Option) error

ListBatchInferenceJobsPagesWithContext same as ListBatchInferenceJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListBatchInferenceJobsRequest added in v1.25.35

func (c *Personalize) ListBatchInferenceJobsRequest(input *ListBatchInferenceJobsInput) (req *request.Request, output *ListBatchInferenceJobsOutput)

ListBatchInferenceJobsRequest generates a "aws/request.Request" representing the client's request for the ListBatchInferenceJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBatchInferenceJobs for more information on using the ListBatchInferenceJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBatchInferenceJobsRequest method.
req, resp := client.ListBatchInferenceJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs

func (*Personalize) ListBatchInferenceJobsWithContext added in v1.25.35

func (c *Personalize) ListBatchInferenceJobsWithContext(ctx aws.Context, input *ListBatchInferenceJobsInput, opts ...request.Option) (*ListBatchInferenceJobsOutput, error)

ListBatchInferenceJobsWithContext is the same as ListBatchInferenceJobs with the addition of the ability to pass a context and additional request options.

See ListBatchInferenceJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListCampaigns

func (c *Personalize) ListCampaigns(input *ListCampaignsInput) (*ListCampaignsOutput, error)

ListCampaigns API operation for Amazon Personalize.

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListCampaigns for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns

func (*Personalize) ListCampaignsPages

func (c *Personalize) ListCampaignsPages(input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool) error

ListCampaignsPages iterates over the pages of a ListCampaigns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCampaigns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCampaigns operation.
pageNum := 0
err := client.ListCampaignsPages(params,
    func(page *personalize.ListCampaignsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListCampaignsPagesWithContext

func (c *Personalize) ListCampaignsPagesWithContext(ctx aws.Context, input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool, opts ...request.Option) error

ListCampaignsPagesWithContext same as ListCampaignsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListCampaignsRequest

func (c *Personalize) ListCampaignsRequest(input *ListCampaignsInput) (req *request.Request, output *ListCampaignsOutput)

ListCampaignsRequest generates a "aws/request.Request" representing the client's request for the ListCampaigns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCampaigns for more information on using the ListCampaigns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCampaignsRequest method.
req, resp := client.ListCampaignsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns

func (*Personalize) ListCampaignsWithContext

func (c *Personalize) ListCampaignsWithContext(ctx aws.Context, input *ListCampaignsInput, opts ...request.Option) (*ListCampaignsOutput, error)

ListCampaignsWithContext is the same as ListCampaigns with the addition of the ability to pass a context and additional request options.

See ListCampaigns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasetGroups

func (c *Personalize) ListDatasetGroups(input *ListDatasetGroupsInput) (*ListDatasetGroupsOutput, error)

ListDatasetGroups API operation for Amazon Personalize.

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListDatasetGroups for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups

func (*Personalize) ListDatasetGroupsPages

func (c *Personalize) ListDatasetGroupsPages(input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool) error

ListDatasetGroupsPages iterates over the pages of a ListDatasetGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasetGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDatasetGroups operation.
pageNum := 0
err := client.ListDatasetGroupsPages(params,
    func(page *personalize.ListDatasetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListDatasetGroupsPagesWithContext

func (c *Personalize) ListDatasetGroupsPagesWithContext(ctx aws.Context, input *ListDatasetGroupsInput, fn func(*ListDatasetGroupsOutput, bool) bool, opts ...request.Option) error

ListDatasetGroupsPagesWithContext same as ListDatasetGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasetGroupsRequest

func (c *Personalize) ListDatasetGroupsRequest(input *ListDatasetGroupsInput) (req *request.Request, output *ListDatasetGroupsOutput)

ListDatasetGroupsRequest generates a "aws/request.Request" representing the client's request for the ListDatasetGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatasetGroups for more information on using the ListDatasetGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDatasetGroupsRequest method.
req, resp := client.ListDatasetGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups

func (*Personalize) ListDatasetGroupsWithContext

func (c *Personalize) ListDatasetGroupsWithContext(ctx aws.Context, input *ListDatasetGroupsInput, opts ...request.Option) (*ListDatasetGroupsOutput, error)

ListDatasetGroupsWithContext is the same as ListDatasetGroups with the addition of the ability to pass a context and additional request options.

See ListDatasetGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasetImportJobs

func (c *Personalize) ListDatasetImportJobs(input *ListDatasetImportJobsInput) (*ListDatasetImportJobsOutput, error)

ListDatasetImportJobs API operation for Amazon Personalize.

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListDatasetImportJobs for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobs

func (*Personalize) ListDatasetImportJobsPages

func (c *Personalize) ListDatasetImportJobsPages(input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool) error

ListDatasetImportJobsPages iterates over the pages of a ListDatasetImportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasetImportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDatasetImportJobs operation.
pageNum := 0
err := client.ListDatasetImportJobsPages(params,
    func(page *personalize.ListDatasetImportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListDatasetImportJobsPagesWithContext

func (c *Personalize) ListDatasetImportJobsPagesWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, fn func(*ListDatasetImportJobsOutput, bool) bool, opts ...request.Option) error

ListDatasetImportJobsPagesWithContext same as ListDatasetImportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasetImportJobsRequest

func (c *Personalize) ListDatasetImportJobsRequest(input *ListDatasetImportJobsInput) (req *request.Request, output *ListDatasetImportJobsOutput)

ListDatasetImportJobsRequest generates a "aws/request.Request" representing the client's request for the ListDatasetImportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatasetImportJobs for more information on using the ListDatasetImportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDatasetImportJobsRequest method.
req, resp := client.ListDatasetImportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobs

func (*Personalize) ListDatasetImportJobsWithContext

func (c *Personalize) ListDatasetImportJobsWithContext(ctx aws.Context, input *ListDatasetImportJobsInput, opts ...request.Option) (*ListDatasetImportJobsOutput, error)

ListDatasetImportJobsWithContext is the same as ListDatasetImportJobs with the addition of the ability to pass a context and additional request options.

See ListDatasetImportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasets

func (c *Personalize) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error)

ListDatasets API operation for Amazon Personalize.

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListDatasets for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasets

func (*Personalize) ListDatasetsPages

func (c *Personalize) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error

ListDatasetsPages iterates over the pages of a ListDatasets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDatasets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDatasets operation.
pageNum := 0
err := client.ListDatasetsPages(params,
    func(page *personalize.ListDatasetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListDatasetsPagesWithContext

func (c *Personalize) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error

ListDatasetsPagesWithContext same as ListDatasetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListDatasetsRequest

func (c *Personalize) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput)

ListDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListDatasets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDatasets for more information on using the ListDatasets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDatasetsRequest method.
req, resp := client.ListDatasetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasets

func (*Personalize) ListDatasetsWithContext

func (c *Personalize) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error)

ListDatasetsWithContext is the same as ListDatasets with the addition of the ability to pass a context and additional request options.

See ListDatasets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListEventTrackers

func (c *Personalize) ListEventTrackers(input *ListEventTrackersInput) (*ListEventTrackersOutput, error)

ListEventTrackers API operation for Amazon Personalize.

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListEventTrackers for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackers

func (*Personalize) ListEventTrackersPages

func (c *Personalize) ListEventTrackersPages(input *ListEventTrackersInput, fn func(*ListEventTrackersOutput, bool) bool) error

ListEventTrackersPages iterates over the pages of a ListEventTrackers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEventTrackers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEventTrackers operation.
pageNum := 0
err := client.ListEventTrackersPages(params,
    func(page *personalize.ListEventTrackersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListEventTrackersPagesWithContext

func (c *Personalize) ListEventTrackersPagesWithContext(ctx aws.Context, input *ListEventTrackersInput, fn func(*ListEventTrackersOutput, bool) bool, opts ...request.Option) error

ListEventTrackersPagesWithContext same as ListEventTrackersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListEventTrackersRequest

func (c *Personalize) ListEventTrackersRequest(input *ListEventTrackersInput) (req *request.Request, output *ListEventTrackersOutput)

ListEventTrackersRequest generates a "aws/request.Request" representing the client's request for the ListEventTrackers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEventTrackers for more information on using the ListEventTrackers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEventTrackersRequest method.
req, resp := client.ListEventTrackersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackers

func (*Personalize) ListEventTrackersWithContext

func (c *Personalize) ListEventTrackersWithContext(ctx aws.Context, input *ListEventTrackersInput, opts ...request.Option) (*ListEventTrackersOutput, error)

ListEventTrackersWithContext is the same as ListEventTrackers with the addition of the ability to pass a context and additional request options.

See ListEventTrackers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListFilters added in v1.31.12

func (c *Personalize) ListFilters(input *ListFiltersInput) (*ListFiltersOutput, error)

ListFilters API operation for Amazon Personalize.

Lists all filters that belong to a given dataset group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListFilters for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters

func (*Personalize) ListFiltersRequest added in v1.31.12

func (c *Personalize) ListFiltersRequest(input *ListFiltersInput) (req *request.Request, output *ListFiltersOutput)

ListFiltersRequest generates a "aws/request.Request" representing the client's request for the ListFilters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFilters for more information on using the ListFilters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFiltersRequest method.
req, resp := client.ListFiltersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListFilters

func (*Personalize) ListFiltersWithContext added in v1.31.12

func (c *Personalize) ListFiltersWithContext(ctx aws.Context, input *ListFiltersInput, opts ...request.Option) (*ListFiltersOutput, error)

ListFiltersWithContext is the same as ListFilters with the addition of the ability to pass a context and additional request options.

See ListFilters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListRecipes

func (c *Personalize) ListRecipes(input *ListRecipesInput) (*ListRecipesOutput, error)

ListRecipes API operation for Amazon Personalize.

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListRecipes for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes

func (*Personalize) ListRecipesPages

func (c *Personalize) ListRecipesPages(input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool) error

ListRecipesPages iterates over the pages of a ListRecipes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRecipes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListRecipes operation.
pageNum := 0
err := client.ListRecipesPages(params,
    func(page *personalize.ListRecipesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListRecipesPagesWithContext

func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRecipesInput, fn func(*ListRecipesOutput, bool) bool, opts ...request.Option) error

ListRecipesPagesWithContext same as ListRecipesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListRecipesRequest

func (c *Personalize) ListRecipesRequest(input *ListRecipesInput) (req *request.Request, output *ListRecipesOutput)

ListRecipesRequest generates a "aws/request.Request" representing the client's request for the ListRecipes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRecipes for more information on using the ListRecipes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRecipesRequest method.
req, resp := client.ListRecipesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes

func (*Personalize) ListRecipesWithContext

func (c *Personalize) ListRecipesWithContext(ctx aws.Context, input *ListRecipesInput, opts ...request.Option) (*ListRecipesOutput, error)

ListRecipesWithContext is the same as ListRecipes with the addition of the ability to pass a context and additional request options.

See ListRecipes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSchemas

func (c *Personalize) ListSchemas(input *ListSchemasInput) (*ListSchemasOutput, error)

ListSchemas API operation for Amazon Personalize.

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListSchemas for usage and error information.

Returned Error Types:

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas

func (*Personalize) ListSchemasPages

func (c *Personalize) ListSchemasPages(input *ListSchemasInput, fn func(*ListSchemasOutput, bool) bool) error

ListSchemasPages iterates over the pages of a ListSchemas operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSchemas method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSchemas operation.
pageNum := 0
err := client.ListSchemasPages(params,
    func(page *personalize.ListSchemasOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListSchemasPagesWithContext

func (c *Personalize) ListSchemasPagesWithContext(ctx aws.Context, input *ListSchemasInput, fn func(*ListSchemasOutput, bool) bool, opts ...request.Option) error

ListSchemasPagesWithContext same as ListSchemasPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSchemasRequest

func (c *Personalize) ListSchemasRequest(input *ListSchemasInput) (req *request.Request, output *ListSchemasOutput)

ListSchemasRequest generates a "aws/request.Request" representing the client's request for the ListSchemas operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSchemas for more information on using the ListSchemas API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSchemasRequest method.
req, resp := client.ListSchemasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas

func (*Personalize) ListSchemasWithContext

func (c *Personalize) ListSchemasWithContext(ctx aws.Context, input *ListSchemasInput, opts ...request.Option) (*ListSchemasOutput, error)

ListSchemasWithContext is the same as ListSchemas with the addition of the ability to pass a context and additional request options.

See ListSchemas for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSolutionVersions

func (c *Personalize) ListSolutionVersions(input *ListSolutionVersionsInput) (*ListSolutionVersionsOutput, error)

ListSolutionVersions API operation for Amazon Personalize.

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListSolutionVersions for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersions

func (*Personalize) ListSolutionVersionsPages

func (c *Personalize) ListSolutionVersionsPages(input *ListSolutionVersionsInput, fn func(*ListSolutionVersionsOutput, bool) bool) error

ListSolutionVersionsPages iterates over the pages of a ListSolutionVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSolutionVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSolutionVersions operation.
pageNum := 0
err := client.ListSolutionVersionsPages(params,
    func(page *personalize.ListSolutionVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListSolutionVersionsPagesWithContext

func (c *Personalize) ListSolutionVersionsPagesWithContext(ctx aws.Context, input *ListSolutionVersionsInput, fn func(*ListSolutionVersionsOutput, bool) bool, opts ...request.Option) error

ListSolutionVersionsPagesWithContext same as ListSolutionVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSolutionVersionsRequest

func (c *Personalize) ListSolutionVersionsRequest(input *ListSolutionVersionsInput) (req *request.Request, output *ListSolutionVersionsOutput)

ListSolutionVersionsRequest generates a "aws/request.Request" representing the client's request for the ListSolutionVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSolutionVersions for more information on using the ListSolutionVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSolutionVersionsRequest method.
req, resp := client.ListSolutionVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersions

func (*Personalize) ListSolutionVersionsWithContext

func (c *Personalize) ListSolutionVersionsWithContext(ctx aws.Context, input *ListSolutionVersionsInput, opts ...request.Option) (*ListSolutionVersionsOutput, error)

ListSolutionVersionsWithContext is the same as ListSolutionVersions with the addition of the ability to pass a context and additional request options.

See ListSolutionVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSolutions

func (c *Personalize) ListSolutions(input *ListSolutionsInput) (*ListSolutionsOutput, error)

ListSolutions API operation for Amazon Personalize.

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation ListSolutions for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • InvalidNextTokenException The token is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutions

func (*Personalize) ListSolutionsPages

func (c *Personalize) ListSolutionsPages(input *ListSolutionsInput, fn func(*ListSolutionsOutput, bool) bool) error

ListSolutionsPages iterates over the pages of a ListSolutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSolutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSolutions operation.
pageNum := 0
err := client.ListSolutionsPages(params,
    func(page *personalize.ListSolutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Personalize) ListSolutionsPagesWithContext

func (c *Personalize) ListSolutionsPagesWithContext(ctx aws.Context, input *ListSolutionsInput, fn func(*ListSolutionsOutput, bool) bool, opts ...request.Option) error

ListSolutionsPagesWithContext same as ListSolutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) ListSolutionsRequest

func (c *Personalize) ListSolutionsRequest(input *ListSolutionsInput) (req *request.Request, output *ListSolutionsOutput)

ListSolutionsRequest generates a "aws/request.Request" representing the client's request for the ListSolutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSolutions for more information on using the ListSolutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSolutionsRequest method.
req, resp := client.ListSolutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutions

func (*Personalize) ListSolutionsWithContext

func (c *Personalize) ListSolutionsWithContext(ctx aws.Context, input *ListSolutionsInput, opts ...request.Option) (*ListSolutionsOutput, error)

ListSolutionsWithContext is the same as ListSolutions with the addition of the ability to pass a context and additional request options.

See ListSolutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Personalize) UpdateCampaign

func (c *Personalize) UpdateCampaign(input *UpdateCampaignInput) (*UpdateCampaignOutput, error)

UpdateCampaign API operation for Amazon Personalize.

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Personalize's API operation UpdateCampaign for usage and error information.

Returned Error Types:

  • InvalidInputException Provide a valid value for the field or parameter.

  • ResourceNotFoundException Could not find the specified resource.

  • ResourceInUseException The specified resource is in use.

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign

func (*Personalize) UpdateCampaignRequest

func (c *Personalize) UpdateCampaignRequest(input *UpdateCampaignInput) (req *request.Request, output *UpdateCampaignOutput)

UpdateCampaignRequest generates a "aws/request.Request" representing the client's request for the UpdateCampaign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCampaign for more information on using the UpdateCampaign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateCampaignRequest method.
req, resp := client.UpdateCampaignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign

func (*Personalize) UpdateCampaignWithContext

func (c *Personalize) UpdateCampaignWithContext(ctx aws.Context, input *UpdateCampaignInput, opts ...request.Option) (*UpdateCampaignOutput, error)

UpdateCampaignWithContext is the same as UpdateCampaign with the addition of the ability to pass a context and additional request options.

See UpdateCampaign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Recipe

type Recipe struct {

	// The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses
	// to train the model.
	AlgorithmArn *string `locationName:"algorithmArn" type:"string"`

	// The date and time (in Unix format) that the recipe was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The description of the recipe.
	Description *string `locationName:"description" type:"string"`

	// The ARN of the FeatureTransformation object.
	FeatureTransformationArn *string `locationName:"featureTransformationArn" type:"string"`

	// The date and time (in Unix format) that the recipe was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the recipe.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the recipe.
	RecipeArn *string `locationName:"recipeArn" type:"string"`

	// One of the following values:
	//
	//    * PERSONALIZED_RANKING
	//
	//    * RELATED_ITEMS
	//
	//    * USER_PERSONALIZATION
	RecipeType *string `locationName:"recipeType" type:"string"`

	// The status of the recipe.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (Recipe) GoString

func (s Recipe) GoString() string

GoString returns the string representation

func (*Recipe) SetAlgorithmArn

func (s *Recipe) SetAlgorithmArn(v string) *Recipe

SetAlgorithmArn sets the AlgorithmArn field's value.

func (*Recipe) SetCreationDateTime

func (s *Recipe) SetCreationDateTime(v time.Time) *Recipe

SetCreationDateTime sets the CreationDateTime field's value.

func (*Recipe) SetDescription

func (s *Recipe) SetDescription(v string) *Recipe

SetDescription sets the Description field's value.

func (*Recipe) SetFeatureTransformationArn

func (s *Recipe) SetFeatureTransformationArn(v string) *Recipe

SetFeatureTransformationArn sets the FeatureTransformationArn field's value.

func (*Recipe) SetLastUpdatedDateTime

func (s *Recipe) SetLastUpdatedDateTime(v time.Time) *Recipe

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Recipe) SetName

func (s *Recipe) SetName(v string) *Recipe

SetName sets the Name field's value.

func (*Recipe) SetRecipeArn

func (s *Recipe) SetRecipeArn(v string) *Recipe

SetRecipeArn sets the RecipeArn field's value.

func (*Recipe) SetRecipeType

func (s *Recipe) SetRecipeType(v string) *Recipe

SetRecipeType sets the RecipeType field's value.

func (*Recipe) SetStatus

func (s *Recipe) SetStatus(v string) *Recipe

SetStatus sets the Status field's value.

func (Recipe) String

func (s Recipe) String() string

String returns the string representation

type RecipeSummary

type RecipeSummary struct {

	// The date and time (in Unix time) that the recipe was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The date and time (in Unix time) that the recipe was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the recipe.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the recipe.
	RecipeArn *string `locationName:"recipeArn" type:"string"`

	// The status of the recipe.
	Status *string `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (RecipeSummary) GoString

func (s RecipeSummary) GoString() string

GoString returns the string representation

func (*RecipeSummary) SetCreationDateTime

func (s *RecipeSummary) SetCreationDateTime(v time.Time) *RecipeSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*RecipeSummary) SetLastUpdatedDateTime

func (s *RecipeSummary) SetLastUpdatedDateTime(v time.Time) *RecipeSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*RecipeSummary) SetName

func (s *RecipeSummary) SetName(v string) *RecipeSummary

SetName sets the Name field's value.

func (*RecipeSummary) SetRecipeArn

func (s *RecipeSummary) SetRecipeArn(v string) *RecipeSummary

SetRecipeArn sets the RecipeArn field's value.

func (*RecipeSummary) SetStatus

func (s *RecipeSummary) SetStatus(v string) *RecipeSummary

SetStatus sets the Status field's value.

func (RecipeSummary) String

func (s RecipeSummary) String() string

String returns the string representation

type ResourceAlreadyExistsException added in v1.28.0

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0

func (ResourceAlreadyExistsException) GoString added in v1.28.0

GoString returns the string representation

func (*ResourceAlreadyExistsException) Message added in v1.28.0

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0

String returns the string representation

type ResourceInUseException added in v1.28.0

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is in use.

func (*ResourceInUseException) Code added in v1.28.0

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0

func (s ResourceInUseException) GoString() string

GoString returns the string representation

func (*ResourceInUseException) Message added in v1.28.0

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.28.0

func (s ResourceInUseException) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Could not find the specified resource.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation

type S3DataConfig added in v1.25.35

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 `locationName:"kmsKeyArn" type:"string"`

	// The file path of the Amazon S3 bucket.
	//
	// Path is a required field
	Path *string `locationName:"path" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (S3DataConfig) GoString added in v1.25.35

func (s S3DataConfig) GoString() string

GoString returns the string representation

func (*S3DataConfig) SetKmsKeyArn added in v1.25.35

func (s *S3DataConfig) SetKmsKeyArn(v string) *S3DataConfig

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*S3DataConfig) SetPath added in v1.25.35

func (s *S3DataConfig) SetPath(v string) *S3DataConfig

SetPath sets the Path field's value.

func (S3DataConfig) String added in v1.25.35

func (s S3DataConfig) String() string

String returns the string representation

func (*S3DataConfig) Validate added in v1.25.35

func (s *S3DataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Solution

type Solution struct {

	// When performAutoML is true, specifies the best recipe found.
	AutoMLResult *AutoMLResult `locationName:"autoMLResult" type:"structure"`

	// The creation date and time (in Unix time) of the solution.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset group that provides the training
	// data.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

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

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// Describes the latest version of the solution, including the status and the
	// ARN.
	LatestSolutionVersion *SolutionVersionSummary `locationName:"latestSolutionVersion" type:"structure"`

	// The name of the solution.
	Name *string `locationName:"name" min:"1" type:"string"`

	// 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 `locationName:"performAutoML" type:"boolean"`

	// Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
	// The default is false.
	PerformHPO *bool `locationName:"performHPO" type:"boolean"`

	// The ARN of the recipe used to create the solution.
	RecipeArn *string `locationName:"recipeArn" type:"string"`

	// The ARN of the solution.
	SolutionArn *string `locationName:"solutionArn" type:"string"`

	// Describes the configuration properties for the solution.
	SolutionConfig *SolutionConfig `locationName:"solutionConfig" type:"structure"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (Solution) GoString

func (s Solution) GoString() string

GoString returns the string representation

func (*Solution) SetAutoMLResult

func (s *Solution) SetAutoMLResult(v *AutoMLResult) *Solution

SetAutoMLResult sets the AutoMLResult field's value.

func (*Solution) SetCreationDateTime

func (s *Solution) SetCreationDateTime(v time.Time) *Solution

SetCreationDateTime sets the CreationDateTime field's value.

func (*Solution) SetDatasetGroupArn

func (s *Solution) SetDatasetGroupArn(v string) *Solution

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*Solution) SetEventType

func (s *Solution) SetEventType(v string) *Solution

SetEventType sets the EventType field's value.

func (*Solution) SetLastUpdatedDateTime

func (s *Solution) SetLastUpdatedDateTime(v time.Time) *Solution

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*Solution) SetLatestSolutionVersion

func (s *Solution) SetLatestSolutionVersion(v *SolutionVersionSummary) *Solution

SetLatestSolutionVersion sets the LatestSolutionVersion field's value.

func (*Solution) SetName

func (s *Solution) SetName(v string) *Solution

SetName sets the Name field's value.

func (*Solution) SetPerformAutoML

func (s *Solution) SetPerformAutoML(v bool) *Solution

SetPerformAutoML sets the PerformAutoML field's value.

func (*Solution) SetPerformHPO

func (s *Solution) SetPerformHPO(v bool) *Solution

SetPerformHPO sets the PerformHPO field's value.

func (*Solution) SetRecipeArn

func (s *Solution) SetRecipeArn(v string) *Solution

SetRecipeArn sets the RecipeArn field's value.

func (*Solution) SetSolutionArn

func (s *Solution) SetSolutionArn(v string) *Solution

SetSolutionArn sets the SolutionArn field's value.

func (*Solution) SetSolutionConfig

func (s *Solution) SetSolutionConfig(v *SolutionConfig) *Solution

SetSolutionConfig sets the SolutionConfig field's value.

func (*Solution) SetStatus

func (s *Solution) SetStatus(v string) *Solution

SetStatus sets the Status field's value.

func (Solution) String

func (s Solution) String() string

String returns the string representation

type SolutionConfig

type SolutionConfig struct {

	// Lists the hyperparameter names and ranges.
	AlgorithmHyperParameters map[string]*string `locationName:"algorithmHyperParameters" type:"map"`

	// The AutoMLConfig object containing a list of recipes to search when AutoML
	// is performed.
	AutoMLConfig *AutoMLConfig `locationName:"autoMLConfig" type:"structure"`

	// Only events with a value greater than or equal to this threshold are used
	// for training a model.
	EventValueThreshold *string `locationName:"eventValueThreshold" type:"string"`

	// Lists the feature transformation parameters.
	FeatureTransformationParameters map[string]*string `locationName:"featureTransformationParameters" type:"map"`

	// Describes the properties for hyperparameter optimization (HPO).
	HpoConfig *HPOConfig `locationName:"hpoConfig" type:"structure"`
	// contains filtered or unexported fields
}

Describes the configuration properties for the solution.

func (SolutionConfig) GoString

func (s SolutionConfig) GoString() string

GoString returns the string representation

func (*SolutionConfig) SetAlgorithmHyperParameters

func (s *SolutionConfig) SetAlgorithmHyperParameters(v map[string]*string) *SolutionConfig

SetAlgorithmHyperParameters sets the AlgorithmHyperParameters field's value.

func (*SolutionConfig) SetAutoMLConfig

func (s *SolutionConfig) SetAutoMLConfig(v *AutoMLConfig) *SolutionConfig

SetAutoMLConfig sets the AutoMLConfig field's value.

func (*SolutionConfig) SetEventValueThreshold

func (s *SolutionConfig) SetEventValueThreshold(v string) *SolutionConfig

SetEventValueThreshold sets the EventValueThreshold field's value.

func (*SolutionConfig) SetFeatureTransformationParameters

func (s *SolutionConfig) SetFeatureTransformationParameters(v map[string]*string) *SolutionConfig

SetFeatureTransformationParameters sets the FeatureTransformationParameters field's value.

func (*SolutionConfig) SetHpoConfig

func (s *SolutionConfig) SetHpoConfig(v *HPOConfig) *SolutionConfig

SetHpoConfig sets the HpoConfig field's value.

func (SolutionConfig) String

func (s SolutionConfig) String() string

String returns the string representation

func (*SolutionConfig) Validate

func (s *SolutionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SolutionSummary

type SolutionSummary struct {

	// The date and time (in Unix time) that the solution was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The name of the solution.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the solution.
	SolutionArn *string `locationName:"solutionArn" type:"string"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (SolutionSummary) GoString

func (s SolutionSummary) GoString() string

GoString returns the string representation

func (*SolutionSummary) SetCreationDateTime

func (s *SolutionSummary) SetCreationDateTime(v time.Time) *SolutionSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*SolutionSummary) SetLastUpdatedDateTime

func (s *SolutionSummary) SetLastUpdatedDateTime(v time.Time) *SolutionSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*SolutionSummary) SetName

func (s *SolutionSummary) SetName(v string) *SolutionSummary

SetName sets the Name field's value.

func (*SolutionSummary) SetSolutionArn

func (s *SolutionSummary) SetSolutionArn(v string) *SolutionSummary

SetSolutionArn sets the SolutionArn field's value.

func (*SolutionSummary) SetStatus

func (s *SolutionSummary) SetStatus(v string) *SolutionSummary

SetStatus sets the Status field's value.

func (SolutionSummary) String

func (s SolutionSummary) String() string

String returns the string representation

type SolutionVersion

type SolutionVersion struct {

	// The date and time (in Unix time) that this version of the solution was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the dataset group providing the training
	// data.
	DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"`

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

	// If training a solution version fails, the reason for the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix time) that the solution was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// 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 `locationName:"performAutoML" type:"boolean"`

	// Whether to perform hyperparameter optimization (HPO) on the chosen recipe.
	// The default is false.
	PerformHPO *bool `locationName:"performHPO" type:"boolean"`

	// The ARN of the recipe used in the solution.
	RecipeArn *string `locationName:"recipeArn" type:"string"`

	// The ARN of the solution.
	SolutionArn *string `locationName:"solutionArn" type:"string"`

	// Describes the configuration properties for the solution.
	SolutionConfig *SolutionConfig `locationName:"solutionConfig" type:"structure"`

	// The ARN of the solution version.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`

	// 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 `locationName:"status" type:"string"`

	// 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 `locationName:"trainingHours" type:"double"`

	// 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 *string `locationName:"trainingMode" type:"string" enum:"TrainingMode"`

	// If hyperparameter optimization was performed, contains the hyperparameter
	// values of the best performing model.
	TunedHPOParams *TunedHPOParams `locationName:"tunedHPOParams" type:"structure"`
	// contains filtered or unexported fields
}

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

func (SolutionVersion) GoString

func (s SolutionVersion) GoString() string

GoString returns the string representation

func (*SolutionVersion) SetCreationDateTime

func (s *SolutionVersion) SetCreationDateTime(v time.Time) *SolutionVersion

SetCreationDateTime sets the CreationDateTime field's value.

func (*SolutionVersion) SetDatasetGroupArn

func (s *SolutionVersion) SetDatasetGroupArn(v string) *SolutionVersion

SetDatasetGroupArn sets the DatasetGroupArn field's value.

func (*SolutionVersion) SetEventType

func (s *SolutionVersion) SetEventType(v string) *SolutionVersion

SetEventType sets the EventType field's value.

func (*SolutionVersion) SetFailureReason

func (s *SolutionVersion) SetFailureReason(v string) *SolutionVersion

SetFailureReason sets the FailureReason field's value.

func (*SolutionVersion) SetLastUpdatedDateTime

func (s *SolutionVersion) SetLastUpdatedDateTime(v time.Time) *SolutionVersion

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*SolutionVersion) SetPerformAutoML

func (s *SolutionVersion) SetPerformAutoML(v bool) *SolutionVersion

SetPerformAutoML sets the PerformAutoML field's value.

func (*SolutionVersion) SetPerformHPO

func (s *SolutionVersion) SetPerformHPO(v bool) *SolutionVersion

SetPerformHPO sets the PerformHPO field's value.

func (*SolutionVersion) SetRecipeArn

func (s *SolutionVersion) SetRecipeArn(v string) *SolutionVersion

SetRecipeArn sets the RecipeArn field's value.

func (*SolutionVersion) SetSolutionArn

func (s *SolutionVersion) SetSolutionArn(v string) *SolutionVersion

SetSolutionArn sets the SolutionArn field's value.

func (*SolutionVersion) SetSolutionConfig

func (s *SolutionVersion) SetSolutionConfig(v *SolutionConfig) *SolutionVersion

SetSolutionConfig sets the SolutionConfig field's value.

func (*SolutionVersion) SetSolutionVersionArn

func (s *SolutionVersion) SetSolutionVersionArn(v string) *SolutionVersion

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*SolutionVersion) SetStatus

func (s *SolutionVersion) SetStatus(v string) *SolutionVersion

SetStatus sets the Status field's value.

func (*SolutionVersion) SetTrainingHours added in v1.24.0

func (s *SolutionVersion) SetTrainingHours(v float64) *SolutionVersion

SetTrainingHours sets the TrainingHours field's value.

func (*SolutionVersion) SetTrainingMode added in v1.25.12

func (s *SolutionVersion) SetTrainingMode(v string) *SolutionVersion

SetTrainingMode sets the TrainingMode field's value.

func (*SolutionVersion) SetTunedHPOParams added in v1.29.27

func (s *SolutionVersion) SetTunedHPOParams(v *TunedHPOParams) *SolutionVersion

SetTunedHPOParams sets the TunedHPOParams field's value.

func (SolutionVersion) String

func (s SolutionVersion) String() string

String returns the string representation

type SolutionVersionSummary

type SolutionVersionSummary struct {

	// The date and time (in Unix time) that this version of a solution was created.
	CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"`

	// If a solution version fails, the reason behind the failure.
	FailureReason *string `locationName:"failureReason" type:"string"`

	// The date and time (in Unix time) that the solution version was last updated.
	LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the solution version.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`

	// 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 `locationName:"status" type:"string"`
	// contains filtered or unexported fields
}

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

func (SolutionVersionSummary) GoString

func (s SolutionVersionSummary) GoString() string

GoString returns the string representation

func (*SolutionVersionSummary) SetCreationDateTime

func (s *SolutionVersionSummary) SetCreationDateTime(v time.Time) *SolutionVersionSummary

SetCreationDateTime sets the CreationDateTime field's value.

func (*SolutionVersionSummary) SetFailureReason

func (s *SolutionVersionSummary) SetFailureReason(v string) *SolutionVersionSummary

SetFailureReason sets the FailureReason field's value.

func (*SolutionVersionSummary) SetLastUpdatedDateTime

func (s *SolutionVersionSummary) SetLastUpdatedDateTime(v time.Time) *SolutionVersionSummary

SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value.

func (*SolutionVersionSummary) SetSolutionVersionArn

func (s *SolutionVersionSummary) SetSolutionVersionArn(v string) *SolutionVersionSummary

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (*SolutionVersionSummary) SetStatus

SetStatus sets the Status field's value.

func (SolutionVersionSummary) String

func (s SolutionVersionSummary) String() string

String returns the string representation

type TunedHPOParams added in v1.29.27

type TunedHPOParams struct {

	// A list of the hyperparameter values of the best performing model.
	AlgorithmHyperParameters map[string]*string `locationName:"algorithmHyperParameters" type:"map"`
	// contains filtered or unexported fields
}

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

func (TunedHPOParams) GoString added in v1.29.27

func (s TunedHPOParams) GoString() string

GoString returns the string representation

func (*TunedHPOParams) SetAlgorithmHyperParameters added in v1.29.27

func (s *TunedHPOParams) SetAlgorithmHyperParameters(v map[string]*string) *TunedHPOParams

SetAlgorithmHyperParameters sets the AlgorithmHyperParameters field's value.

func (TunedHPOParams) String added in v1.29.27

func (s TunedHPOParams) String() string

String returns the string representation

type UpdateCampaignInput

type UpdateCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// CampaignArn is a required field
	CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`

	// The configuration details of a campaign.
	CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"`

	// Specifies the requested minimum provisioned transactions (recommendations)
	// per second that Amazon Personalize will support.
	MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"`

	// The ARN of a new solution version to deploy.
	SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateCampaignInput) GoString

func (s UpdateCampaignInput) GoString() string

GoString returns the string representation

func (*UpdateCampaignInput) SetCampaignArn

func (s *UpdateCampaignInput) SetCampaignArn(v string) *UpdateCampaignInput

SetCampaignArn sets the CampaignArn field's value.

func (*UpdateCampaignInput) SetCampaignConfig added in v1.33.21

func (s *UpdateCampaignInput) SetCampaignConfig(v *CampaignConfig) *UpdateCampaignInput

SetCampaignConfig sets the CampaignConfig field's value.

func (*UpdateCampaignInput) SetMinProvisionedTPS

func (s *UpdateCampaignInput) SetMinProvisionedTPS(v int64) *UpdateCampaignInput

SetMinProvisionedTPS sets the MinProvisionedTPS field's value.

func (*UpdateCampaignInput) SetSolutionVersionArn

func (s *UpdateCampaignInput) SetSolutionVersionArn(v string) *UpdateCampaignInput

SetSolutionVersionArn sets the SolutionVersionArn field's value.

func (UpdateCampaignInput) String

func (s UpdateCampaignInput) String() string

String returns the string representation

func (*UpdateCampaignInput) Validate

func (s *UpdateCampaignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateCampaignOutput

type UpdateCampaignOutput struct {

	// The same campaign ARN as given in the request.
	CampaignArn *string `locationName:"campaignArn" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateCampaignOutput) GoString

func (s UpdateCampaignOutput) GoString() string

GoString returns the string representation

func (*UpdateCampaignOutput) SetCampaignArn

func (s *UpdateCampaignOutput) SetCampaignArn(v string) *UpdateCampaignOutput

SetCampaignArn sets the CampaignArn field's value.

func (UpdateCampaignOutput) String

func (s UpdateCampaignOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package personalizeiface provides an interface to enable mocking the Amazon Personalize service client for testing your code.
Package personalizeiface provides an interface to enable mocking the Amazon Personalize service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL