personalize

package
v0.20.0 Latest Latest
Warning

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

Go to latest
Published: Mar 17, 2020 License: Apache-2.0 Imports: 9 Imported by: 7

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 use 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 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 (
	ServiceName = "Amazon Personalize" // Service's name
	ServiceID   = "Personalize"        // Service's identifier
	EndpointsID = "personalize"        // Service's Endpoint identifier
)
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"
)

Variables

This section is empty.

Functions

This section is empty.

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

func (s AutoMLResult) String() string

String returns the string representation

type BatchInferenceJob added in v0.17.0

type BatchInferenceJob 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 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) String added in v0.17.0

func (s BatchInferenceJob) String() string

String returns the string representation

type BatchInferenceJobInput added in v0.17.0

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) String added in v0.17.0

func (s BatchInferenceJobInput) String() string

String returns the string representation

func (*BatchInferenceJobInput) Validate added in v0.17.0

func (s *BatchInferenceJobInput) Validate() error

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

type BatchInferenceJobOutput added in v0.17.0

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) String added in v0.17.0

func (s BatchInferenceJobOutput) String() string

String returns the string representation

func (*BatchInferenceJobOutput) Validate added in v0.17.0

func (s *BatchInferenceJobOutput) Validate() error

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

type BatchInferenceJobSummary added in v0.17.0

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 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) String added in v0.17.0

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

func (s Campaign) 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) String

func (s CampaignSummary) String() string

String returns the string representation

type CampaignUpdateSummary

type CampaignUpdateSummary struct {

	// 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) 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) String

String returns the string representation

type Client

type Client struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := personalize.New(myConfig)

func (*Client) CreateBatchInferenceJobRequest added in v0.17.0

func (c *Client) CreateBatchInferenceJobRequest(input *CreateBatchInferenceJobInput) CreateBatchInferenceJobRequest

CreateBatchInferenceJobRequest returns a request value for making 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.

// Example sending a request using CreateBatchInferenceJobRequest.
req := client.CreateBatchInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateCampaignRequest

func (c *Client) CreateCampaignRequest(input *CreateCampaignInput) CreateCampaignRequest

CreateCampaignRequest returns a request value for making 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

    // Example sending a request using CreateCampaignRequest. req := client.CreateCampaignRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateDatasetGroupRequest

func (c *Client) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) CreateDatasetGroupRequest

CreateDatasetGroupRequest returns a request value for making 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

    // Example sending a request using CreateDatasetGroupRequest. req := client.CreateDatasetGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateDatasetImportJobRequest

func (c *Client) CreateDatasetImportJobRequest(input *CreateDatasetImportJobInput) CreateDatasetImportJobRequest

CreateDatasetImportJobRequest returns a request value for making 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.

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

    // Example sending a request using CreateDatasetImportJobRequest. req := client.CreateDatasetImportJobRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateDatasetRequest

func (c *Client) CreateDatasetRequest(input *CreateDatasetInput) CreateDatasetRequest

CreateDatasetRequest returns a request value for making 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

    // Example sending a request using CreateDatasetRequest. req := client.CreateDatasetRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateEventTrackerRequest

func (c *Client) CreateEventTrackerRequest(input *CreateEventTrackerInput) CreateEventTrackerRequest

CreateEventTrackerRequest returns a request value for making 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

    // Example sending a request using CreateEventTrackerRequest. req := client.CreateEventTrackerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateSchemaRequest

func (c *Client) CreateSchemaRequest(input *CreateSchemaInput) CreateSchemaRequest

CreateSchemaRequest returns a request value for making 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

    // Example sending a request using CreateSchemaRequest. req := client.CreateSchemaRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

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

func (*Client) CreateSolutionRequest

func (c *Client) CreateSolutionRequest(input *CreateSolutionInput) CreateSolutionRequest

CreateSolutionRequest returns a request value for making 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

    // Example sending a request using CreateSolutionRequest. req := client.CreateSolutionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolution

func (*Client) CreateSolutionVersionRequest

func (c *Client) CreateSolutionVersionRequest(input *CreateSolutionVersionInput) CreateSolutionVersionRequest

CreateSolutionVersionRequest returns a request value for making 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

    // Example sending a request using CreateSolutionVersionRequest. req := client.CreateSolutionVersionRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersion

func (*Client) DeleteCampaignRequest

func (c *Client) DeleteCampaignRequest(input *DeleteCampaignInput) DeleteCampaignRequest

DeleteCampaignRequest returns a request value for making 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.

// Example sending a request using DeleteCampaignRequest.
req := client.DeleteCampaignRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteCampaign

func (*Client) DeleteDatasetGroupRequest

func (c *Client) DeleteDatasetGroupRequest(input *DeleteDatasetGroupInput) DeleteDatasetGroupRequest

DeleteDatasetGroupRequest returns a request value for making 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.

    // Example sending a request using DeleteDatasetGroupRequest. req := client.DeleteDatasetGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDatasetGroup

func (*Client) DeleteDatasetRequest

func (c *Client) DeleteDatasetRequest(input *DeleteDatasetInput) DeleteDatasetRequest

DeleteDatasetRequest returns a request value for making 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.

// Example sending a request using DeleteDatasetRequest.
req := client.DeleteDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteDataset

func (*Client) DeleteEventTrackerRequest

func (c *Client) DeleteEventTrackerRequest(input *DeleteEventTrackerInput) DeleteEventTrackerRequest

DeleteEventTrackerRequest returns a request value for making 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.

// Example sending a request using DeleteEventTrackerRequest.
req := client.DeleteEventTrackerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteEventTracker

func (*Client) DeleteSchemaRequest

func (c *Client) DeleteSchemaRequest(input *DeleteSchemaInput) DeleteSchemaRequest

DeleteSchemaRequest returns a request value for making 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.

// Example sending a request using DeleteSchemaRequest.
req := client.DeleteSchemaRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSchema

func (*Client) DeleteSolutionRequest

func (c *Client) DeleteSolutionRequest(input *DeleteSolutionInput) DeleteSolutionRequest

DeleteSolutionRequest returns a request value for making 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.

// Example sending a request using DeleteSolutionRequest.
req := client.DeleteSolutionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteSolution

func (*Client) DescribeAlgorithmRequest

func (c *Client) DescribeAlgorithmRequest(input *DescribeAlgorithmInput) DescribeAlgorithmRequest

DescribeAlgorithmRequest returns a request value for making API operation for Amazon Personalize.

Describes the given algorithm.

// Example sending a request using DescribeAlgorithmRequest.
req := client.DescribeAlgorithmRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeAlgorithm

func (*Client) DescribeBatchInferenceJobRequest added in v0.17.0

func (c *Client) DescribeBatchInferenceJobRequest(input *DescribeBatchInferenceJobInput) DescribeBatchInferenceJobRequest

DescribeBatchInferenceJobRequest returns a request value for making 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.

// Example sending a request using DescribeBatchInferenceJobRequest.
req := client.DescribeBatchInferenceJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchInferenceJob

func (*Client) DescribeCampaignRequest

func (c *Client) DescribeCampaignRequest(input *DescribeCampaignInput) DescribeCampaignRequest

DescribeCampaignRequest returns a request value for making 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.

// Example sending a request using DescribeCampaignRequest.
req := client.DescribeCampaignRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign

func (*Client) DescribeDatasetGroupRequest

func (c *Client) DescribeDatasetGroupRequest(input *DescribeDatasetGroupInput) DescribeDatasetGroupRequest

DescribeDatasetGroupRequest returns a request value for making API operation for Amazon Personalize.

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

// Example sending a request using DescribeDatasetGroupRequest.
req := client.DescribeDatasetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetGroup

func (*Client) DescribeDatasetImportJobRequest

func (c *Client) DescribeDatasetImportJobRequest(input *DescribeDatasetImportJobInput) DescribeDatasetImportJobRequest

DescribeDatasetImportJobRequest returns a request value for making API operation for Amazon Personalize.

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

// Example sending a request using DescribeDatasetImportJobRequest.
req := client.DescribeDatasetImportJobRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJob

func (*Client) DescribeDatasetRequest

func (c *Client) DescribeDatasetRequest(input *DescribeDatasetInput) DescribeDatasetRequest

DescribeDatasetRequest returns a request value for making API operation for Amazon Personalize.

Describes the given dataset. For more information on datasets, see CreateDataset.

// Example sending a request using DescribeDatasetRequest.
req := client.DescribeDatasetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset

func (*Client) DescribeEventTrackerRequest

func (c *Client) DescribeEventTrackerRequest(input *DescribeEventTrackerInput) DescribeEventTrackerRequest

DescribeEventTrackerRequest returns a request value for making 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.

// Example sending a request using DescribeEventTrackerRequest.
req := client.DescribeEventTrackerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeEventTracker

func (*Client) DescribeFeatureTransformationRequest

func (c *Client) DescribeFeatureTransformationRequest(input *DescribeFeatureTransformationInput) DescribeFeatureTransformationRequest

DescribeFeatureTransformationRequest returns a request value for making API operation for Amazon Personalize.

Describes the given feature transformation.

// Example sending a request using DescribeFeatureTransformationRequest.
req := client.DescribeFeatureTransformationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeFeatureTransformation

func (*Client) DescribeRecipeRequest

func (c *Client) DescribeRecipeRequest(input *DescribeRecipeInput) DescribeRecipeRequest

DescribeRecipeRequest returns a request value for making 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.

// Example sending a request using DescribeRecipeRequest.
req := client.DescribeRecipeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecipe

func (*Client) DescribeSchemaRequest

func (c *Client) DescribeSchemaRequest(input *DescribeSchemaInput) DescribeSchemaRequest

DescribeSchemaRequest returns a request value for making API operation for Amazon Personalize.

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

// Example sending a request using DescribeSchemaRequest.
req := client.DescribeSchemaRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSchema

func (*Client) DescribeSolutionRequest

func (c *Client) DescribeSolutionRequest(input *DescribeSolutionInput) DescribeSolutionRequest

DescribeSolutionRequest returns a request value for making API operation for Amazon Personalize.

Describes a solution. For more information on solutions, see CreateSolution.

// Example sending a request using DescribeSolutionRequest.
req := client.DescribeSolutionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolution

func (*Client) DescribeSolutionVersionRequest

func (c *Client) DescribeSolutionVersionRequest(input *DescribeSolutionVersionInput) DescribeSolutionVersionRequest

DescribeSolutionVersionRequest returns a request value for making API operation for Amazon Personalize.

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

// Example sending a request using DescribeSolutionVersionRequest.
req := client.DescribeSolutionVersionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersion

func (*Client) GetSolutionMetricsRequest

func (c *Client) GetSolutionMetricsRequest(input *GetSolutionMetricsInput) GetSolutionMetricsRequest

GetSolutionMetricsRequest returns a request value for making API operation for Amazon Personalize.

Gets the metrics for the specified solution version.

// Example sending a request using GetSolutionMetricsRequest.
req := client.GetSolutionMetricsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/GetSolutionMetrics

func (*Client) ListBatchInferenceJobsRequest added in v0.17.0

func (c *Client) ListBatchInferenceJobsRequest(input *ListBatchInferenceJobsInput) ListBatchInferenceJobsRequest

ListBatchInferenceJobsRequest returns a request value for making API operation for Amazon Personalize.

Gets a list of the batch inference jobs that have been performed off of a solution version.

// Example sending a request using ListBatchInferenceJobsRequest.
req := client.ListBatchInferenceJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs

func (*Client) ListCampaignsRequest

func (c *Client) ListCampaignsRequest(input *ListCampaignsInput) ListCampaignsRequest

ListCampaignsRequest returns a request value for making 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.

// Example sending a request using ListCampaignsRequest.
req := client.ListCampaignsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns

func (*Client) ListDatasetGroupsRequest

func (c *Client) ListDatasetGroupsRequest(input *ListDatasetGroupsInput) ListDatasetGroupsRequest

ListDatasetGroupsRequest returns a request value for making 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.

// Example sending a request using ListDatasetGroupsRequest.
req := client.ListDatasetGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetGroups

func (*Client) ListDatasetImportJobsRequest

func (c *Client) ListDatasetImportJobsRequest(input *ListDatasetImportJobsInput) ListDatasetImportJobsRequest

ListDatasetImportJobsRequest returns a request value for making 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.

// Example sending a request using ListDatasetImportJobsRequest.
req := client.ListDatasetImportJobsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetImportJobs

func (*Client) ListDatasetsRequest

func (c *Client) ListDatasetsRequest(input *ListDatasetsInput) ListDatasetsRequest

ListDatasetsRequest returns a request value for making 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.

// Example sending a request using ListDatasetsRequest.
req := client.ListDatasetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasets

func (*Client) ListEventTrackersRequest

func (c *Client) ListEventTrackersRequest(input *ListEventTrackersInput) ListEventTrackersRequest

ListEventTrackersRequest returns a request value for making 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.

// Example sending a request using ListEventTrackersRequest.
req := client.ListEventTrackersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListEventTrackers

func (*Client) ListRecipesRequest

func (c *Client) ListRecipesRequest(input *ListRecipesInput) ListRecipesRequest

ListRecipesRequest returns a request value for making 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).

// Example sending a request using ListRecipesRequest.
req := client.ListRecipesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes

func (*Client) ListSchemasRequest

func (c *Client) ListSchemasRequest(input *ListSchemasInput) ListSchemasRequest

ListSchemasRequest returns a request value for making 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.

// Example sending a request using ListSchemasRequest.
req := client.ListSchemasRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSchemas

func (*Client) ListSolutionVersionsRequest

func (c *Client) ListSolutionVersionsRequest(input *ListSolutionVersionsInput) ListSolutionVersionsRequest

ListSolutionVersionsRequest returns a request value for making 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.

// Example sending a request using ListSolutionVersionsRequest.
req := client.ListSolutionVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutionVersions

func (*Client) ListSolutionsRequest

func (c *Client) ListSolutionsRequest(input *ListSolutionsInput) ListSolutionsRequest

ListSolutionsRequest returns a request value for making 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.

// Example sending a request using ListSolutionsRequest.
req := client.ListSolutionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutions

func (*Client) UpdateCampaignRequest

func (c *Client) UpdateCampaignRequest(input *UpdateCampaignInput) UpdateCampaignRequest

UpdateCampaignRequest returns a request value for making 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.

// Example sending a request using UpdateCampaignRequest.
req := client.UpdateCampaignRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateCampaign

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

type CreateBatchInferenceJobInput struct {

	// 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) String added in v0.17.0

String returns the string representation

func (*CreateBatchInferenceJobInput) Validate added in v0.17.0

func (s *CreateBatchInferenceJobInput) Validate() error

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

type CreateBatchInferenceJobOutput added in v0.17.0

type CreateBatchInferenceJobOutput struct {

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

func (CreateBatchInferenceJobOutput) String added in v0.17.0

String returns the string representation

type CreateBatchInferenceJobRequest added in v0.17.0

type CreateBatchInferenceJobRequest struct {
	*aws.Request
	Input *CreateBatchInferenceJobInput
	Copy  func(*CreateBatchInferenceJobInput) CreateBatchInferenceJobRequest
}

CreateBatchInferenceJobRequest is the request type for the CreateBatchInferenceJob API operation.

func (CreateBatchInferenceJobRequest) Send added in v0.17.0

Send marshals and sends the CreateBatchInferenceJob API request.

type CreateBatchInferenceJobResponse added in v0.17.0

type CreateBatchInferenceJobResponse struct {
	*CreateBatchInferenceJobOutput
	// contains filtered or unexported fields
}

CreateBatchInferenceJobResponse is the response type for the CreateBatchInferenceJob API operation.

func (*CreateBatchInferenceJobResponse) SDKResponseMetdata added in v0.17.0

func (r *CreateBatchInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateBatchInferenceJob request.

type CreateCampaignInput

type CreateCampaignInput struct {

	// 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) 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) String

func (s CreateCampaignOutput) String() string

String returns the string representation

type CreateCampaignRequest

type CreateCampaignRequest struct {
	*aws.Request
	Input *CreateCampaignInput
	Copy  func(*CreateCampaignInput) CreateCampaignRequest
}

CreateCampaignRequest is the request type for the CreateCampaign API operation.

func (CreateCampaignRequest) Send

Send marshals and sends the CreateCampaign API request.

type CreateCampaignResponse

type CreateCampaignResponse struct {
	*CreateCampaignOutput
	// contains filtered or unexported fields
}

CreateCampaignResponse is the response type for the CreateCampaign API operation.

func (*CreateCampaignResponse) SDKResponseMetdata

func (r *CreateCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCampaign request.

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

func (s CreateDatasetGroupOutput) String() string

String returns the string representation

type CreateDatasetGroupRequest

type CreateDatasetGroupRequest struct {
	*aws.Request
	Input *CreateDatasetGroupInput
	Copy  func(*CreateDatasetGroupInput) CreateDatasetGroupRequest
}

CreateDatasetGroupRequest is the request type for the CreateDatasetGroup API operation.

func (CreateDatasetGroupRequest) Send

Send marshals and sends the CreateDatasetGroup API request.

type CreateDatasetGroupResponse

type CreateDatasetGroupResponse struct {
	*CreateDatasetGroupOutput
	// contains filtered or unexported fields
}

CreateDatasetGroupResponse is the response type for the CreateDatasetGroup API operation.

func (*CreateDatasetGroupResponse) SDKResponseMetdata

func (r *CreateDatasetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDatasetGroup request.

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

String returns the string representation

type CreateDatasetImportJobRequest

type CreateDatasetImportJobRequest struct {
	*aws.Request
	Input *CreateDatasetImportJobInput
	Copy  func(*CreateDatasetImportJobInput) CreateDatasetImportJobRequest
}

CreateDatasetImportJobRequest is the request type for the CreateDatasetImportJob API operation.

func (CreateDatasetImportJobRequest) Send

Send marshals and sends the CreateDatasetImportJob API request.

type CreateDatasetImportJobResponse

type CreateDatasetImportJobResponse struct {
	*CreateDatasetImportJobOutput
	// contains filtered or unexported fields
}

CreateDatasetImportJobResponse is the response type for the CreateDatasetImportJob API operation.

func (*CreateDatasetImportJobResponse) SDKResponseMetdata

func (r *CreateDatasetImportJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDatasetImportJob request.

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

func (s CreateDatasetOutput) String() string

String returns the string representation

type CreateDatasetRequest

type CreateDatasetRequest struct {
	*aws.Request
	Input *CreateDatasetInput
	Copy  func(*CreateDatasetInput) CreateDatasetRequest
}

CreateDatasetRequest is the request type for the CreateDataset API operation.

func (CreateDatasetRequest) Send

Send marshals and sends the CreateDataset API request.

type CreateDatasetResponse

type CreateDatasetResponse struct {
	*CreateDatasetOutput
	// contains filtered or unexported fields
}

CreateDatasetResponse is the response type for the CreateDataset API operation.

func (*CreateDatasetResponse) SDKResponseMetdata

func (r *CreateDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDataset request.

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

func (s CreateEventTrackerOutput) String() string

String returns the string representation

type CreateEventTrackerRequest

type CreateEventTrackerRequest struct {
	*aws.Request
	Input *CreateEventTrackerInput
	Copy  func(*CreateEventTrackerInput) CreateEventTrackerRequest
}

CreateEventTrackerRequest is the request type for the CreateEventTracker API operation.

func (CreateEventTrackerRequest) Send

Send marshals and sends the CreateEventTracker API request.

type CreateEventTrackerResponse

type CreateEventTrackerResponse struct {
	*CreateEventTrackerOutput
	// contains filtered or unexported fields
}

CreateEventTrackerResponse is the response type for the CreateEventTracker API operation.

func (*CreateEventTrackerResponse) SDKResponseMetdata

func (r *CreateEventTrackerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateEventTracker request.

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

func (s CreateSchemaOutput) String() string

String returns the string representation

type CreateSchemaRequest

type CreateSchemaRequest struct {
	*aws.Request
	Input *CreateSchemaInput
	Copy  func(*CreateSchemaInput) CreateSchemaRequest
}

CreateSchemaRequest is the request type for the CreateSchema API operation.

func (CreateSchemaRequest) Send

Send marshals and sends the CreateSchema API request.

type CreateSchemaResponse

type CreateSchemaResponse struct {
	*CreateSchemaOutput
	// contains filtered or unexported fields
}

CreateSchemaResponse is the response type for the CreateSchema API operation.

func (*CreateSchemaResponse) SDKResponseMetdata

func (r *CreateSchemaResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSchema request.

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

func (s CreateSolutionOutput) String() string

String returns the string representation

type CreateSolutionRequest

type CreateSolutionRequest struct {
	*aws.Request
	Input *CreateSolutionInput
	Copy  func(*CreateSolutionInput) CreateSolutionRequest
}

CreateSolutionRequest is the request type for the CreateSolution API operation.

func (CreateSolutionRequest) Send

Send marshals and sends the CreateSolution API request.

type CreateSolutionResponse

type CreateSolutionResponse struct {
	*CreateSolutionOutput
	// contains filtered or unexported fields
}

CreateSolutionResponse is the response type for the CreateSolution API operation.

func (*CreateSolutionResponse) SDKResponseMetdata

func (r *CreateSolutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSolution request.

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

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

String returns the string representation

type CreateSolutionVersionRequest

type CreateSolutionVersionRequest struct {
	*aws.Request
	Input *CreateSolutionVersionInput
	Copy  func(*CreateSolutionVersionInput) CreateSolutionVersionRequest
}

CreateSolutionVersionRequest is the request type for the CreateSolutionVersion API operation.

func (CreateSolutionVersionRequest) Send

Send marshals and sends the CreateSolutionVersion API request.

type CreateSolutionVersionResponse

type CreateSolutionVersionResponse struct {
	*CreateSolutionVersionOutput
	// contains filtered or unexported fields
}

CreateSolutionVersionResponse is the response type for the CreateSolutionVersion API operation.

func (*CreateSolutionVersionResponse) SDKResponseMetdata

func (r *CreateSolutionVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateSolutionVersion request.

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

func (s DeleteCampaignOutput) String() string

String returns the string representation

type DeleteCampaignRequest

type DeleteCampaignRequest struct {
	*aws.Request
	Input *DeleteCampaignInput
	Copy  func(*DeleteCampaignInput) DeleteCampaignRequest
}

DeleteCampaignRequest is the request type for the DeleteCampaign API operation.

func (DeleteCampaignRequest) Send

Send marshals and sends the DeleteCampaign API request.

type DeleteCampaignResponse

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

DeleteCampaignResponse is the response type for the DeleteCampaign API operation.

func (*DeleteCampaignResponse) SDKResponseMetdata

func (r *DeleteCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCampaign request.

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

func (s DeleteDatasetGroupOutput) String() string

String returns the string representation

type DeleteDatasetGroupRequest

type DeleteDatasetGroupRequest struct {
	*aws.Request
	Input *DeleteDatasetGroupInput
	Copy  func(*DeleteDatasetGroupInput) DeleteDatasetGroupRequest
}

DeleteDatasetGroupRequest is the request type for the DeleteDatasetGroup API operation.

func (DeleteDatasetGroupRequest) Send

Send marshals and sends the DeleteDatasetGroup API request.

type DeleteDatasetGroupResponse

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

DeleteDatasetGroupResponse is the response type for the DeleteDatasetGroup API operation.

func (*DeleteDatasetGroupResponse) SDKResponseMetdata

func (r *DeleteDatasetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDatasetGroup request.

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

func (s DeleteDatasetOutput) String() string

String returns the string representation

type DeleteDatasetRequest

type DeleteDatasetRequest struct {
	*aws.Request
	Input *DeleteDatasetInput
	Copy  func(*DeleteDatasetInput) DeleteDatasetRequest
}

DeleteDatasetRequest is the request type for the DeleteDataset API operation.

func (DeleteDatasetRequest) Send

Send marshals and sends the DeleteDataset API request.

type DeleteDatasetResponse

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

DeleteDatasetResponse is the response type for the DeleteDataset API operation.

func (*DeleteDatasetResponse) SDKResponseMetdata

func (r *DeleteDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDataset request.

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

func (s DeleteEventTrackerOutput) String() string

String returns the string representation

type DeleteEventTrackerRequest

type DeleteEventTrackerRequest struct {
	*aws.Request
	Input *DeleteEventTrackerInput
	Copy  func(*DeleteEventTrackerInput) DeleteEventTrackerRequest
}

DeleteEventTrackerRequest is the request type for the DeleteEventTracker API operation.

func (DeleteEventTrackerRequest) Send

Send marshals and sends the DeleteEventTracker API request.

type DeleteEventTrackerResponse

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

DeleteEventTrackerResponse is the response type for the DeleteEventTracker API operation.

func (*DeleteEventTrackerResponse) SDKResponseMetdata

func (r *DeleteEventTrackerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteEventTracker request.

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

func (s DeleteSchemaOutput) String() string

String returns the string representation

type DeleteSchemaRequest

type DeleteSchemaRequest struct {
	*aws.Request
	Input *DeleteSchemaInput
	Copy  func(*DeleteSchemaInput) DeleteSchemaRequest
}

DeleteSchemaRequest is the request type for the DeleteSchema API operation.

func (DeleteSchemaRequest) Send

Send marshals and sends the DeleteSchema API request.

type DeleteSchemaResponse

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

DeleteSchemaResponse is the response type for the DeleteSchema API operation.

func (*DeleteSchemaResponse) SDKResponseMetdata

func (r *DeleteSchemaResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSchema request.

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

func (s DeleteSolutionOutput) String() string

String returns the string representation

type DeleteSolutionRequest

type DeleteSolutionRequest struct {
	*aws.Request
	Input *DeleteSolutionInput
	Copy  func(*DeleteSolutionInput) DeleteSolutionRequest
}

DeleteSolutionRequest is the request type for the DeleteSolution API operation.

func (DeleteSolutionRequest) Send

Send marshals and sends the DeleteSolution API request.

type DeleteSolutionResponse

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

DeleteSolutionResponse is the response type for the DeleteSolution API operation.

func (*DeleteSolutionResponse) SDKResponseMetdata

func (r *DeleteSolutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteSolution request.

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

func (s DescribeAlgorithmOutput) String() string

String returns the string representation

type DescribeAlgorithmRequest

type DescribeAlgorithmRequest struct {
	*aws.Request
	Input *DescribeAlgorithmInput
	Copy  func(*DescribeAlgorithmInput) DescribeAlgorithmRequest
}

DescribeAlgorithmRequest is the request type for the DescribeAlgorithm API operation.

func (DescribeAlgorithmRequest) Send

Send marshals and sends the DescribeAlgorithm API request.

type DescribeAlgorithmResponse

type DescribeAlgorithmResponse struct {
	*DescribeAlgorithmOutput
	// contains filtered or unexported fields
}

DescribeAlgorithmResponse is the response type for the DescribeAlgorithm API operation.

func (*DescribeAlgorithmResponse) SDKResponseMetdata

func (r *DescribeAlgorithmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAlgorithm request.

type DescribeBatchInferenceJobInput added in v0.17.0

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) String added in v0.17.0

String returns the string representation

func (*DescribeBatchInferenceJobInput) Validate added in v0.17.0

func (s *DescribeBatchInferenceJobInput) Validate() error

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

type DescribeBatchInferenceJobOutput added in v0.17.0

type DescribeBatchInferenceJobOutput struct {

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

func (DescribeBatchInferenceJobOutput) String added in v0.17.0

String returns the string representation

type DescribeBatchInferenceJobRequest added in v0.17.0

type DescribeBatchInferenceJobRequest struct {
	*aws.Request
	Input *DescribeBatchInferenceJobInput
	Copy  func(*DescribeBatchInferenceJobInput) DescribeBatchInferenceJobRequest
}

DescribeBatchInferenceJobRequest is the request type for the DescribeBatchInferenceJob API operation.

func (DescribeBatchInferenceJobRequest) Send added in v0.17.0

Send marshals and sends the DescribeBatchInferenceJob API request.

type DescribeBatchInferenceJobResponse added in v0.17.0

type DescribeBatchInferenceJobResponse struct {
	*DescribeBatchInferenceJobOutput
	// contains filtered or unexported fields
}

DescribeBatchInferenceJobResponse is the response type for the DescribeBatchInferenceJob API operation.

func (*DescribeBatchInferenceJobResponse) SDKResponseMetdata added in v0.17.0

func (r *DescribeBatchInferenceJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeBatchInferenceJob request.

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

func (s DescribeCampaignOutput) String() string

String returns the string representation

type DescribeCampaignRequest

type DescribeCampaignRequest struct {
	*aws.Request
	Input *DescribeCampaignInput
	Copy  func(*DescribeCampaignInput) DescribeCampaignRequest
}

DescribeCampaignRequest is the request type for the DescribeCampaign API operation.

func (DescribeCampaignRequest) Send

Send marshals and sends the DescribeCampaign API request.

type DescribeCampaignResponse

type DescribeCampaignResponse struct {
	*DescribeCampaignOutput
	// contains filtered or unexported fields
}

DescribeCampaignResponse is the response type for the DescribeCampaign API operation.

func (*DescribeCampaignResponse) SDKResponseMetdata

func (r *DescribeCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCampaign request.

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

String returns the string representation

type DescribeDatasetGroupRequest

type DescribeDatasetGroupRequest struct {
	*aws.Request
	Input *DescribeDatasetGroupInput
	Copy  func(*DescribeDatasetGroupInput) DescribeDatasetGroupRequest
}

DescribeDatasetGroupRequest is the request type for the DescribeDatasetGroup API operation.

func (DescribeDatasetGroupRequest) Send

Send marshals and sends the DescribeDatasetGroup API request.

type DescribeDatasetGroupResponse

type DescribeDatasetGroupResponse struct {
	*DescribeDatasetGroupOutput
	// contains filtered or unexported fields
}

DescribeDatasetGroupResponse is the response type for the DescribeDatasetGroup API operation.

func (*DescribeDatasetGroupResponse) SDKResponseMetdata

func (r *DescribeDatasetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDatasetGroup request.

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

String returns the string representation

type DescribeDatasetImportJobRequest

type DescribeDatasetImportJobRequest struct {
	*aws.Request
	Input *DescribeDatasetImportJobInput
	Copy  func(*DescribeDatasetImportJobInput) DescribeDatasetImportJobRequest
}

DescribeDatasetImportJobRequest is the request type for the DescribeDatasetImportJob API operation.

func (DescribeDatasetImportJobRequest) Send

Send marshals and sends the DescribeDatasetImportJob API request.

type DescribeDatasetImportJobResponse

type DescribeDatasetImportJobResponse struct {
	*DescribeDatasetImportJobOutput
	// contains filtered or unexported fields
}

DescribeDatasetImportJobResponse is the response type for the DescribeDatasetImportJob API operation.

func (*DescribeDatasetImportJobResponse) SDKResponseMetdata

func (r *DescribeDatasetImportJobResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDatasetImportJob request.

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

func (s DescribeDatasetOutput) String() string

String returns the string representation

type DescribeDatasetRequest

type DescribeDatasetRequest struct {
	*aws.Request
	Input *DescribeDatasetInput
	Copy  func(*DescribeDatasetInput) DescribeDatasetRequest
}

DescribeDatasetRequest is the request type for the DescribeDataset API operation.

func (DescribeDatasetRequest) Send

Send marshals and sends the DescribeDataset API request.

type DescribeDatasetResponse

type DescribeDatasetResponse struct {
	*DescribeDatasetOutput
	// contains filtered or unexported fields
}

DescribeDatasetResponse is the response type for the DescribeDataset API operation.

func (*DescribeDatasetResponse) SDKResponseMetdata

func (r *DescribeDatasetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDataset request.

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

String returns the string representation

type DescribeEventTrackerRequest

type DescribeEventTrackerRequest struct {
	*aws.Request
	Input *DescribeEventTrackerInput
	Copy  func(*DescribeEventTrackerInput) DescribeEventTrackerRequest
}

DescribeEventTrackerRequest is the request type for the DescribeEventTracker API operation.

func (DescribeEventTrackerRequest) Send

Send marshals and sends the DescribeEventTracker API request.

type DescribeEventTrackerResponse

type DescribeEventTrackerResponse struct {
	*DescribeEventTrackerOutput
	// contains filtered or unexported fields
}

DescribeEventTrackerResponse is the response type for the DescribeEventTracker API operation.

func (*DescribeEventTrackerResponse) SDKResponseMetdata

func (r *DescribeEventTrackerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventTracker request.

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

String returns the string representation

type DescribeFeatureTransformationRequest

type DescribeFeatureTransformationRequest struct {
	*aws.Request
	Input *DescribeFeatureTransformationInput
	Copy  func(*DescribeFeatureTransformationInput) DescribeFeatureTransformationRequest
}

DescribeFeatureTransformationRequest is the request type for the DescribeFeatureTransformation API operation.

func (DescribeFeatureTransformationRequest) Send

Send marshals and sends the DescribeFeatureTransformation API request.

type DescribeFeatureTransformationResponse

type DescribeFeatureTransformationResponse struct {
	*DescribeFeatureTransformationOutput
	// contains filtered or unexported fields
}

DescribeFeatureTransformationResponse is the response type for the DescribeFeatureTransformation API operation.

func (*DescribeFeatureTransformationResponse) SDKResponseMetdata

func (r *DescribeFeatureTransformationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeFeatureTransformation request.

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

func (s DescribeRecipeOutput) String() string

String returns the string representation

type DescribeRecipeRequest

type DescribeRecipeRequest struct {
	*aws.Request
	Input *DescribeRecipeInput
	Copy  func(*DescribeRecipeInput) DescribeRecipeRequest
}

DescribeRecipeRequest is the request type for the DescribeRecipe API operation.

func (DescribeRecipeRequest) Send

Send marshals and sends the DescribeRecipe API request.

type DescribeRecipeResponse

type DescribeRecipeResponse struct {
	*DescribeRecipeOutput
	// contains filtered or unexported fields
}

DescribeRecipeResponse is the response type for the DescribeRecipe API operation.

func (*DescribeRecipeResponse) SDKResponseMetdata

func (r *DescribeRecipeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeRecipe request.

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

func (s DescribeSchemaOutput) String() string

String returns the string representation

type DescribeSchemaRequest

type DescribeSchemaRequest struct {
	*aws.Request
	Input *DescribeSchemaInput
	Copy  func(*DescribeSchemaInput) DescribeSchemaRequest
}

DescribeSchemaRequest is the request type for the DescribeSchema API operation.

func (DescribeSchemaRequest) Send

Send marshals and sends the DescribeSchema API request.

type DescribeSchemaResponse

type DescribeSchemaResponse struct {
	*DescribeSchemaOutput
	// contains filtered or unexported fields
}

DescribeSchemaResponse is the response type for the DescribeSchema API operation.

func (*DescribeSchemaResponse) SDKResponseMetdata

func (r *DescribeSchemaResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSchema request.

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

func (s DescribeSolutionOutput) String() string

String returns the string representation

type DescribeSolutionRequest

type DescribeSolutionRequest struct {
	*aws.Request
	Input *DescribeSolutionInput
	Copy  func(*DescribeSolutionInput) DescribeSolutionRequest
}

DescribeSolutionRequest is the request type for the DescribeSolution API operation.

func (DescribeSolutionRequest) Send

Send marshals and sends the DescribeSolution API request.

type DescribeSolutionResponse

type DescribeSolutionResponse struct {
	*DescribeSolutionOutput
	// contains filtered or unexported fields
}

DescribeSolutionResponse is the response type for the DescribeSolution API operation.

func (*DescribeSolutionResponse) SDKResponseMetdata

func (r *DescribeSolutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSolution request.

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

String returns the string representation

type DescribeSolutionVersionRequest

type DescribeSolutionVersionRequest struct {
	*aws.Request
	Input *DescribeSolutionVersionInput
	Copy  func(*DescribeSolutionVersionInput) DescribeSolutionVersionRequest
}

DescribeSolutionVersionRequest is the request type for the DescribeSolutionVersion API operation.

func (DescribeSolutionVersionRequest) Send

Send marshals and sends the DescribeSolutionVersion API request.

type DescribeSolutionVersionResponse

type DescribeSolutionVersionResponse struct {
	*DescribeSolutionVersionOutput
	// contains filtered or unexported fields
}

DescribeSolutionVersionResponse is the response type for the DescribeSolutionVersion API operation.

func (*DescribeSolutionVersionResponse) SDKResponseMetdata

func (r *DescribeSolutionVersionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeSolutionVersion request.

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

func (s FeatureTransformation) 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) 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) String

func (s GetSolutionMetricsOutput) String() string

String returns the string representation

type GetSolutionMetricsRequest

type GetSolutionMetricsRequest struct {
	*aws.Request
	Input *GetSolutionMetricsInput
	Copy  func(*GetSolutionMetricsInput) GetSolutionMetricsRequest
}

GetSolutionMetricsRequest is the request type for the GetSolutionMetrics API operation.

func (GetSolutionMetricsRequest) Send

Send marshals and sends the GetSolutionMetrics API request.

type GetSolutionMetricsResponse

type GetSolutionMetricsResponse struct {
	*GetSolutionMetricsOutput
	// contains filtered or unexported fields
}

GetSolutionMetricsResponse is the response type for the GetSolutionMetrics API operation.

func (*GetSolutionMetricsResponse) SDKResponseMetdata

func (r *GetSolutionMetricsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetSolutionMetrics request.

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) 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 data type of the metric.
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

The metric to optimize during hyperparameter optimization (HPO).

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) 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) 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) 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 ListBatchInferenceJobsInput added in v0.17.0

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) String added in v0.17.0

String returns the string representation

func (*ListBatchInferenceJobsInput) Validate added in v0.17.0

func (s *ListBatchInferenceJobsInput) Validate() error

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

type ListBatchInferenceJobsOutput added in v0.17.0

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) String added in v0.17.0

String returns the string representation

type ListBatchInferenceJobsPaginator added in v0.17.0

type ListBatchInferenceJobsPaginator struct {
	aws.Pager
}

ListBatchInferenceJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListBatchInferenceJobsPaginator added in v0.17.0

func NewListBatchInferenceJobsPaginator(req ListBatchInferenceJobsRequest) ListBatchInferenceJobsPaginator

NewListBatchInferenceJobsRequestPaginator returns a paginator for ListBatchInferenceJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListBatchInferenceJobsRequest(input)
p := personalize.NewListBatchInferenceJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListBatchInferenceJobsPaginator) CurrentPage added in v0.17.0

type ListBatchInferenceJobsRequest added in v0.17.0

type ListBatchInferenceJobsRequest struct {
	*aws.Request
	Input *ListBatchInferenceJobsInput
	Copy  func(*ListBatchInferenceJobsInput) ListBatchInferenceJobsRequest
}

ListBatchInferenceJobsRequest is the request type for the ListBatchInferenceJobs API operation.

func (ListBatchInferenceJobsRequest) Send added in v0.17.0

Send marshals and sends the ListBatchInferenceJobs API request.

type ListBatchInferenceJobsResponse added in v0.17.0

type ListBatchInferenceJobsResponse struct {
	*ListBatchInferenceJobsOutput
	// contains filtered or unexported fields
}

ListBatchInferenceJobsResponse is the response type for the ListBatchInferenceJobs API operation.

func (*ListBatchInferenceJobsResponse) SDKResponseMetdata added in v0.17.0

func (r *ListBatchInferenceJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListBatchInferenceJobs request.

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

func (s ListCampaignsOutput) String() string

String returns the string representation

type ListCampaignsPaginator

type ListCampaignsPaginator struct {
	aws.Pager
}

ListCampaignsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListCampaignsPaginator

func NewListCampaignsPaginator(req ListCampaignsRequest) ListCampaignsPaginator

NewListCampaignsRequestPaginator returns a paginator for ListCampaigns. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListCampaignsRequest(input)
p := personalize.NewListCampaignsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListCampaignsPaginator) CurrentPage

func (p *ListCampaignsPaginator) CurrentPage() *ListCampaignsOutput

type ListCampaignsRequest

type ListCampaignsRequest struct {
	*aws.Request
	Input *ListCampaignsInput
	Copy  func(*ListCampaignsInput) ListCampaignsRequest
}

ListCampaignsRequest is the request type for the ListCampaigns API operation.

func (ListCampaignsRequest) Send

Send marshals and sends the ListCampaigns API request.

type ListCampaignsResponse

type ListCampaignsResponse struct {
	*ListCampaignsOutput
	// contains filtered or unexported fields
}

ListCampaignsResponse is the response type for the ListCampaigns API operation.

func (*ListCampaignsResponse) SDKResponseMetdata

func (r *ListCampaignsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListCampaigns request.

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

func (s ListDatasetGroupsOutput) String() string

String returns the string representation

type ListDatasetGroupsPaginator

type ListDatasetGroupsPaginator struct {
	aws.Pager
}

ListDatasetGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatasetGroupsPaginator

func NewListDatasetGroupsPaginator(req ListDatasetGroupsRequest) ListDatasetGroupsPaginator

NewListDatasetGroupsRequestPaginator returns a paginator for ListDatasetGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatasetGroupsRequest(input)
p := personalize.NewListDatasetGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatasetGroupsPaginator) CurrentPage

type ListDatasetGroupsRequest

type ListDatasetGroupsRequest struct {
	*aws.Request
	Input *ListDatasetGroupsInput
	Copy  func(*ListDatasetGroupsInput) ListDatasetGroupsRequest
}

ListDatasetGroupsRequest is the request type for the ListDatasetGroups API operation.

func (ListDatasetGroupsRequest) Send

Send marshals and sends the ListDatasetGroups API request.

type ListDatasetGroupsResponse

type ListDatasetGroupsResponse struct {
	*ListDatasetGroupsOutput
	// contains filtered or unexported fields
}

ListDatasetGroupsResponse is the response type for the ListDatasetGroups API operation.

func (*ListDatasetGroupsResponse) SDKResponseMetdata

func (r *ListDatasetGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatasetGroups request.

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

String returns the string representation

type ListDatasetImportJobsPaginator

type ListDatasetImportJobsPaginator struct {
	aws.Pager
}

ListDatasetImportJobsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatasetImportJobsPaginator

func NewListDatasetImportJobsPaginator(req ListDatasetImportJobsRequest) ListDatasetImportJobsPaginator

NewListDatasetImportJobsRequestPaginator returns a paginator for ListDatasetImportJobs. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatasetImportJobsRequest(input)
p := personalize.NewListDatasetImportJobsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatasetImportJobsPaginator) CurrentPage

type ListDatasetImportJobsRequest

type ListDatasetImportJobsRequest struct {
	*aws.Request
	Input *ListDatasetImportJobsInput
	Copy  func(*ListDatasetImportJobsInput) ListDatasetImportJobsRequest
}

ListDatasetImportJobsRequest is the request type for the ListDatasetImportJobs API operation.

func (ListDatasetImportJobsRequest) Send

Send marshals and sends the ListDatasetImportJobs API request.

type ListDatasetImportJobsResponse

type ListDatasetImportJobsResponse struct {
	*ListDatasetImportJobsOutput
	// contains filtered or unexported fields
}

ListDatasetImportJobsResponse is the response type for the ListDatasetImportJobs API operation.

func (*ListDatasetImportJobsResponse) SDKResponseMetdata

func (r *ListDatasetImportJobsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatasetImportJobs request.

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

func (s ListDatasetsOutput) String() string

String returns the string representation

type ListDatasetsPaginator

type ListDatasetsPaginator struct {
	aws.Pager
}

ListDatasetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDatasetsPaginator

func NewListDatasetsPaginator(req ListDatasetsRequest) ListDatasetsPaginator

NewListDatasetsRequestPaginator returns a paginator for ListDatasets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDatasetsRequest(input)
p := personalize.NewListDatasetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDatasetsPaginator) CurrentPage

func (p *ListDatasetsPaginator) CurrentPage() *ListDatasetsOutput

type ListDatasetsRequest

type ListDatasetsRequest struct {
	*aws.Request
	Input *ListDatasetsInput
	Copy  func(*ListDatasetsInput) ListDatasetsRequest
}

ListDatasetsRequest is the request type for the ListDatasets API operation.

func (ListDatasetsRequest) Send

Send marshals and sends the ListDatasets API request.

type ListDatasetsResponse

type ListDatasetsResponse struct {
	*ListDatasetsOutput
	// contains filtered or unexported fields
}

ListDatasetsResponse is the response type for the ListDatasets API operation.

func (*ListDatasetsResponse) SDKResponseMetdata

func (r *ListDatasetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDatasets request.

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

func (s ListEventTrackersOutput) String() string

String returns the string representation

type ListEventTrackersPaginator

type ListEventTrackersPaginator struct {
	aws.Pager
}

ListEventTrackersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListEventTrackersPaginator

func NewListEventTrackersPaginator(req ListEventTrackersRequest) ListEventTrackersPaginator

NewListEventTrackersRequestPaginator returns a paginator for ListEventTrackers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListEventTrackersRequest(input)
p := personalize.NewListEventTrackersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListEventTrackersPaginator) CurrentPage

type ListEventTrackersRequest

type ListEventTrackersRequest struct {
	*aws.Request
	Input *ListEventTrackersInput
	Copy  func(*ListEventTrackersInput) ListEventTrackersRequest
}

ListEventTrackersRequest is the request type for the ListEventTrackers API operation.

func (ListEventTrackersRequest) Send

Send marshals and sends the ListEventTrackers API request.

type ListEventTrackersResponse

type ListEventTrackersResponse struct {
	*ListEventTrackersOutput
	// contains filtered or unexported fields
}

ListEventTrackersResponse is the response type for the ListEventTrackers API operation.

func (*ListEventTrackersResponse) SDKResponseMetdata

func (r *ListEventTrackersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEventTrackers request.

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

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

func (s ListRecipesOutput) String() string

String returns the string representation

type ListRecipesPaginator

type ListRecipesPaginator struct {
	aws.Pager
}

ListRecipesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListRecipesPaginator

func NewListRecipesPaginator(req ListRecipesRequest) ListRecipesPaginator

NewListRecipesRequestPaginator returns a paginator for ListRecipes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListRecipesRequest(input)
p := personalize.NewListRecipesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListRecipesPaginator) CurrentPage

func (p *ListRecipesPaginator) CurrentPage() *ListRecipesOutput

type ListRecipesRequest

type ListRecipesRequest struct {
	*aws.Request
	Input *ListRecipesInput
	Copy  func(*ListRecipesInput) ListRecipesRequest
}

ListRecipesRequest is the request type for the ListRecipes API operation.

func (ListRecipesRequest) Send

Send marshals and sends the ListRecipes API request.

type ListRecipesResponse

type ListRecipesResponse struct {
	*ListRecipesOutput
	// contains filtered or unexported fields
}

ListRecipesResponse is the response type for the ListRecipes API operation.

func (*ListRecipesResponse) SDKResponseMetdata

func (r *ListRecipesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListRecipes request.

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

func (s ListSchemasOutput) String() string

String returns the string representation

type ListSchemasPaginator

type ListSchemasPaginator struct {
	aws.Pager
}

ListSchemasPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSchemasPaginator

func NewListSchemasPaginator(req ListSchemasRequest) ListSchemasPaginator

NewListSchemasRequestPaginator returns a paginator for ListSchemas. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSchemasRequest(input)
p := personalize.NewListSchemasRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSchemasPaginator) CurrentPage

func (p *ListSchemasPaginator) CurrentPage() *ListSchemasOutput

type ListSchemasRequest

type ListSchemasRequest struct {
	*aws.Request
	Input *ListSchemasInput
	Copy  func(*ListSchemasInput) ListSchemasRequest
}

ListSchemasRequest is the request type for the ListSchemas API operation.

func (ListSchemasRequest) Send

Send marshals and sends the ListSchemas API request.

type ListSchemasResponse

type ListSchemasResponse struct {
	*ListSchemasOutput
	// contains filtered or unexported fields
}

ListSchemasResponse is the response type for the ListSchemas API operation.

func (*ListSchemasResponse) SDKResponseMetdata

func (r *ListSchemasResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSchemas request.

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

String returns the string representation

type ListSolutionVersionsPaginator

type ListSolutionVersionsPaginator struct {
	aws.Pager
}

ListSolutionVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSolutionVersionsPaginator

func NewListSolutionVersionsPaginator(req ListSolutionVersionsRequest) ListSolutionVersionsPaginator

NewListSolutionVersionsRequestPaginator returns a paginator for ListSolutionVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSolutionVersionsRequest(input)
p := personalize.NewListSolutionVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSolutionVersionsPaginator) CurrentPage

type ListSolutionVersionsRequest

type ListSolutionVersionsRequest struct {
	*aws.Request
	Input *ListSolutionVersionsInput
	Copy  func(*ListSolutionVersionsInput) ListSolutionVersionsRequest
}

ListSolutionVersionsRequest is the request type for the ListSolutionVersions API operation.

func (ListSolutionVersionsRequest) Send

Send marshals and sends the ListSolutionVersions API request.

type ListSolutionVersionsResponse

type ListSolutionVersionsResponse struct {
	*ListSolutionVersionsOutput
	// contains filtered or unexported fields
}

ListSolutionVersionsResponse is the response type for the ListSolutionVersions API operation.

func (*ListSolutionVersionsResponse) SDKResponseMetdata

func (r *ListSolutionVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSolutionVersions request.

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

func (s ListSolutionsOutput) String() string

String returns the string representation

type ListSolutionsPaginator

type ListSolutionsPaginator struct {
	aws.Pager
}

ListSolutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSolutionsPaginator

func NewListSolutionsPaginator(req ListSolutionsRequest) ListSolutionsPaginator

NewListSolutionsRequestPaginator returns a paginator for ListSolutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListSolutionsRequest(input)
p := personalize.NewListSolutionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSolutionsPaginator) CurrentPage

func (p *ListSolutionsPaginator) CurrentPage() *ListSolutionsOutput

type ListSolutionsRequest

type ListSolutionsRequest struct {
	*aws.Request
	Input *ListSolutionsInput
	Copy  func(*ListSolutionsInput) ListSolutionsRequest
}

ListSolutionsRequest is the request type for the ListSolutions API operation.

func (ListSolutionsRequest) Send

Send marshals and sends the ListSolutions API request.

type ListSolutionsResponse

type ListSolutionsResponse struct {
	*ListSolutionsOutput
	// contains filtered or unexported fields
}

ListSolutionsResponse is the response type for the ListSolutions API operation.

func (*ListSolutionsResponse) SDKResponseMetdata

func (r *ListSolutionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSolutions request.

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

func (s Recipe) String() string

String returns the string representation

type RecipeProvider

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

Enum values for RecipeProvider

func (RecipeProvider) MarshalValue

func (enum RecipeProvider) MarshalValue() (string, error)

func (RecipeProvider) MarshalValueBuf

func (enum RecipeProvider) MarshalValueBuf(b []byte) ([]byte, error)

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

func (s RecipeSummary) String() string

String returns the string representation

type S3DataConfig added in v0.17.0

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) String added in v0.17.0

func (s S3DataConfig) String() string

String returns the string representation

func (*S3DataConfig) Validate added in v0.17.0

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) 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) 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) 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 TrainingMode `locationName:"trainingMode" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

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

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

func (s SolutionVersionSummary) String() string

String returns the string representation

type TrainingMode added in v0.15.0

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

Enum values for TrainingMode

func (TrainingMode) MarshalValue added in v0.15.0

func (enum TrainingMode) MarshalValue() (string, error)

func (TrainingMode) MarshalValueBuf added in v0.15.0

func (enum TrainingMode) MarshalValueBuf(b []byte) ([]byte, error)

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"`

	// 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) 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) String

func (s UpdateCampaignOutput) String() string

String returns the string representation

type UpdateCampaignRequest

type UpdateCampaignRequest struct {
	*aws.Request
	Input *UpdateCampaignInput
	Copy  func(*UpdateCampaignInput) UpdateCampaignRequest
}

UpdateCampaignRequest is the request type for the UpdateCampaign API operation.

func (UpdateCampaignRequest) Send

Send marshals and sends the UpdateCampaign API request.

type UpdateCampaignResponse

type UpdateCampaignResponse struct {
	*UpdateCampaignOutput
	// contains filtered or unexported fields
}

UpdateCampaignResponse is the response type for the UpdateCampaign API operation.

func (*UpdateCampaignResponse) SDKResponseMetdata

func (r *UpdateCampaignResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateCampaign request.

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