personalize

package module
v1.20.2 Latest Latest
Warning

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

 Go to latest Published: Jun 29, 2022 License: Apache-2.0 Imports: 34 Imported by: 7

Documentation

Overview

Package personalize provides the API client, operations, and parameter types for Amazon Personalize.

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

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-22"
View Source 
const ServiceID = "Personalize"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

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

Client provides the API client to make operations call for Amazon Personalize.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateBatchInferenceJob 

func (c *Client) CreateBatchInferenceJob(ctx context.Context, params *CreateBatchInferenceJobInput, optFns ...func(*Options)) (*CreateBatchInferenceJobOutput, error)

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 Creating a batch inference job (https://docs.aws.amazon.com/personalize/latest/dg/creating-batch-inference-job.html).

func (*Client) CreateBatchSegmentJob added in v1.12.0 

func (c *Client) CreateBatchSegmentJob(ctx context.Context, params *CreateBatchSegmentJobInput, optFns ...func(*Options)) (*CreateBatchSegmentJobOutput, error)

Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see Getting batch recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html).

func (*Client) CreateCampaign 

func (c *Client) CreateCampaign(ctx context.Context, params *CreateCampaignInput, optFns ...func(*Options)) (*CreateCampaignOutput, error)

Creates a campaign that deploys 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. There's a short time delay while the capacity is increased that might cause loss of transactions. The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html). Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations. Related APIs

* ListCampaigns (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html)

* DescribeCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)

* UpdateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html)

* DeleteCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html)

func (*Client) CreateDataset 

func (c *Client) CreateDataset(ctx context.Context, params *CreateDatasetInput, optFns ...func(*Options)) (*CreateDatasetOutput, error)

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html). Related APIs

* CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)

* ListDatasets (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html)

* DescribeDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)

* DeleteDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html)

func (*Client) CreateDatasetExportJob added in v1.3.0 

func (c *Client) CreateDatasetExportJob(ctx context.Context, params *CreateDatasetExportJobInput, optFns ...func(*Options)) (*CreateDatasetExportJobOutput, error)

Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset (https://docs.aws.amazon.com/personalize/latest/dg/export-data.html) in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states:

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

To get the status of the export job, call DescribeDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html), and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.

func (*Client) CreateDatasetGroup 

func (c *Client) CreateDatasetGroup(ctx context.Context, params *CreateDatasetGroupInput, optFns ...func(*Options)) (*CreateDatasetGroupOutput, error)

Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:

* Interactions

* Items

* Users

A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns. 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html). 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 Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request

* CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)

* CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)

* CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)

Related APIs

* ListDatasetGroups (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html)

* DescribeDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html)

* DeleteDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html)

func (*Client) CreateDatasetImportJob 

func (c *Client) CreateDatasetImportJob(ctx context.Context, params *CreateDatasetImportJobInput, optFns ...func(*Options)) (*CreateDatasetImportJobOutput, error)

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 IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources (https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html). The dataset import job replaces any existing data in the dataset that you imported in bulk. 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html), 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html)

* DescribeDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html)

func (*Client) CreateEventTracker 

func (c *Client) CreateEventTracker(ctx context.Context, params *CreateEventTrackerInput, optFns ...func(*Options)) (*CreateEventTrackerOutput, error)

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API. 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 create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents (https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker. 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html). The event tracker must be in the ACTIVE state before using the tracking ID. Related APIs

* ListEventTrackers (https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html)

* DescribeEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html)

* DeleteEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html)

func (*Client) CreateFilter 

func (c *Client) CreateFilter(ctx context.Context, params *CreateFilterInput, optFns ...func(*Options)) (*CreateFilterOutput, error)

Creates a recommendation filter. For more information, see Filtering recommendations and user segments (https://docs.aws.amazon.com/personalize/latest/dg/filter.html).

func (*Client) CreateRecommender added in v1.12.0 

func (c *Client) CreateRecommender(ctx context.Context, params *CreateRecommenderInput, optFns ...func(*Options)) (*CreateRecommenderOutput, error)

Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) request. Minimum recommendation requests per second When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (minRecommendationRequestsPerSecond) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is 1. A recommendation request is a single GetRecommendations operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage. If your requests per second increases beyond minRecommendationRequestsPerSecond, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minRecommendationRequestsPerSecond. There's a short time delay while the capacity is increased that might cause loss of requests. Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default minRecommendationRequestsPerSecond, track your usage using Amazon CloudWatch metrics, and then increase the minRecommendationRequestsPerSecond as necessary. Status A recommender can be in one of the following states:

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

* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

* DELETE PENDING > DELETE IN_PROGRESS

To get the recommender status, call DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html). Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations. Related APIs

* ListRecommenders (https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html)

* DescribeRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html)

* UpdateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html)

* DeleteRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html)

func (*Client) CreateSchema 

func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error)

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. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html). Related APIs

* ListSchemas (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html)

* DescribeSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html)

* DeleteSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html)

func (*Client) CreateSolution 

func (c *Client) CreateSolution(ctx context.Context, params *CreateSolutionInput, optFns ...func(*Options)) (*CreateSolutionOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html). When you are satisfied with the version, you deploy it using CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html). 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. Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time. 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html). Wait until the status shows as ACTIVE before calling CreateSolutionVersion. Related APIs

* ListSolutions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html)

* CreateSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html)

* DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)

* DeleteSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html)

* ListSolutionVersions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)

* DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)

func (*Client) CreateSolutionVersion 

func (c *Client) CreateSolutionVersion(ctx context.Context, params *CreateSolutionVersionInput, optFns ...func(*Options)) (*CreateSolutionVersionOutput, error)

Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 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

* CREATE FAILED

* CREATE STOPPING

* CREATE STOPPED

To get the status of the version, call DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html). 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)

* DescribeSolutionVersion (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)

* ListSolutions (https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html)

* CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)

* DescribeSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)

* DeleteSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html)

func (*Client) DeleteCampaign 

func (c *Client) DeleteCampaign(ctx context.Context, params *DeleteCampaignInput, optFns ...func(*Options)) (*DeleteCampaignOutput, error)

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 information on creating campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

func (*Client) DeleteDataset 

func (c *Client) DeleteDataset(ctx context.Context, params *DeleteDatasetInput, optFns ...func(*Options)) (*DeleteDatasetOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

func (*Client) DeleteDatasetGroup 

func (c *Client) DeleteDatasetGroup(ctx context.Context, params *DeleteDatasetGroupInput, optFns ...func(*Options)) (*DeleteDatasetGroupOutput, error)

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.

func (*Client) DeleteEventTracker 

func (c *Client) DeleteEventTracker(ctx context.Context, params *DeleteEventTrackerInput, optFns ...func(*Options)) (*DeleteEventTrackerOutput, error)

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html).

func (*Client) DeleteFilter 

func (c *Client) DeleteFilter(ctx context.Context, params *DeleteFilterInput, optFns ...func(*Options)) (*DeleteFilterOutput, error)

Deletes a filter.

func (*Client) DeleteRecommender added in v1.12.0 

func (c *Client) DeleteRecommender(ctx context.Context, params *DeleteRecommenderInput, optFns ...func(*Options)) (*DeleteRecommenderOutput, error)

Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) request.

func (*Client) DeleteSchema 

func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error)

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

func (*Client) DeleteSolution 

func (c *Client) DeleteSolution(ctx context.Context, params *DeleteSolutionInput, optFns ...func(*Options)) (*DeleteSolutionOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) 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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

func (*Client) DescribeAlgorithm 

func (c *Client) DescribeAlgorithm(ctx context.Context, params *DescribeAlgorithmInput, optFns ...func(*Options)) (*DescribeAlgorithmOutput, error)

Describes the given algorithm.

func (*Client) DescribeBatchInferenceJob 

func (c *Client) DescribeBatchInferenceJob(ctx context.Context, params *DescribeBatchInferenceJobInput, optFns ...func(*Options)) (*DescribeBatchInferenceJobOutput, error)

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.

func (*Client) DescribeBatchSegmentJob added in v1.12.0 

func (c *Client) DescribeBatchSegmentJob(ctx context.Context, params *DescribeBatchSegmentJobInput, optFns ...func(*Options)) (*DescribeBatchSegmentJobOutput, error)

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

func (*Client) DescribeCampaign 

func (c *Client) DescribeCampaign(ctx context.Context, params *DescribeCampaignInput, optFns ...func(*Options)) (*DescribeCampaignOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

func (*Client) DescribeDataset 

func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error)

Describes the given dataset. For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

func (*Client) DescribeDatasetExportJob added in v1.3.0 

func (c *Client) DescribeDatasetExportJob(ctx context.Context, params *DescribeDatasetExportJobInput, optFns ...func(*Options)) (*DescribeDatasetExportJobOutput, error)

Describes the dataset export job created by CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html), including the export job status.

func (*Client) DescribeDatasetGroup 

func (c *Client) DescribeDatasetGroup(ctx context.Context, params *DescribeDatasetGroupInput, optFns ...func(*Options)) (*DescribeDatasetGroupOutput, error)

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html).

func (*Client) DescribeDatasetImportJob 

func (c *Client) DescribeDatasetImportJob(ctx context.Context, params *DescribeDatasetImportJobInput, optFns ...func(*Options)) (*DescribeDatasetImportJobOutput, error)

Describes the dataset import job created by CreateDatasetImportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html), including the import job status.

func (*Client) DescribeEventTracker 

func (c *Client) DescribeEventTracker(ctx context.Context, params *DescribeEventTrackerInput, optFns ...func(*Options)) (*DescribeEventTrackerOutput, error)

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html).

func (*Client) DescribeFeatureTransformation 

func (c *Client) DescribeFeatureTransformation(ctx context.Context, params *DescribeFeatureTransformationInput, optFns ...func(*Options)) (*DescribeFeatureTransformationOutput, error)

Describes the given feature transformation.

func (*Client) DescribeFilter 

func (c *Client) DescribeFilter(ctx context.Context, params *DescribeFilterInput, optFns ...func(*Options)) (*DescribeFilterOutput, error)

Describes a filter's properties.

func (*Client) DescribeRecipe 

func (c *Client) DescribeRecipe(ctx context.Context, params *DescribeRecipeInput, optFns ...func(*Options)) (*DescribeRecipeOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 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.

func (*Client) DescribeRecommender added in v1.12.0 

func (c *Client) DescribeRecommender(ctx context.Context, params *DescribeRecommenderInput, optFns ...func(*Options)) (*DescribeRecommenderOutput, error)

Describes the given recommender, including its status. A recommender can be in one of the following states:

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

* STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE

* DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why. The modelMetrics key is null when the recommender is being created or deleted. For more information on recommenders, see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html).

func (*Client) DescribeSchema 

func (c *Client) DescribeSchema(ctx context.Context, params *DescribeSchemaInput, optFns ...func(*Options)) (*DescribeSchemaOutput, error)

Describes a schema. For more information on schemas, see CreateSchema (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

func (*Client) DescribeSolution 

func (c *Client) DescribeSolution(ctx context.Context, params *DescribeSolutionInput, optFns ...func(*Options)) (*DescribeSolutionOutput, error)

Describes a solution. For more information on solutions, see CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

func (*Client) DescribeSolutionVersion 

func (c *Client) DescribeSolutionVersion(ctx context.Context, params *DescribeSolutionVersionInput, optFns ...func(*Options)) (*DescribeSolutionVersionOutput, error)

Describes a specific version of a solution. For more information on solutions, see CreateSolution (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)

func (*Client) GetSolutionMetrics 

func (c *Client) GetSolutionMetrics(ctx context.Context, params *GetSolutionMetricsInput, optFns ...func(*Options)) (*GetSolutionMetricsOutput, error)

Gets the metrics for the specified solution version.

func (*Client) ListBatchInferenceJobs 

func (c *Client) ListBatchInferenceJobs(ctx context.Context, params *ListBatchInferenceJobsInput, optFns ...func(*Options)) (*ListBatchInferenceJobsOutput, error)

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

func (*Client) ListBatchSegmentJobs added in v1.12.0 

func (c *Client) ListBatchSegmentJobs(ctx context.Context, params *ListBatchSegmentJobsInput, optFns ...func(*Options)) (*ListBatchSegmentJobsOutput, error)

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

func (*Client) ListCampaigns 

func (c *Client) ListCampaigns(ctx context.Context, params *ListCampaignsInput, optFns ...func(*Options)) (*ListCampaignsOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

func (*Client) ListDatasetExportJobs added in v1.3.0 

func (c *Client) ListDatasetExportJobs(ctx context.Context, params *ListDatasetExportJobsInput, optFns ...func(*Options)) (*ListDatasetExportJobsOutput, error)

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html). For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

func (*Client) ListDatasetGroups 

func (c *Client) ListDatasetGroups(ctx context.Context, params *ListDatasetGroupsInput, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html).

func (*Client) ListDatasetImportJobs 

func (c *Client) ListDatasetImportJobs(ctx context.Context, params *ListDatasetImportJobsInput, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html). For more information on datasets, see CreateDataset (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

func (*Client) ListDatasets 

func (c *Client) ListDatasets(ctx context.Context, params *ListDatasetsInput, optFns ...func(*Options)) (*ListDatasetsOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html).

func (*Client) ListEventTrackers 

func (c *Client) ListEventTrackers(ctx context.Context, params *ListEventTrackersInput, optFns ...func(*Options)) (*ListEventTrackersOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html).

func (*Client) ListFilters 

func (c *Client) ListFilters(ctx context.Context, params *ListFiltersInput, optFns ...func(*Options)) (*ListFiltersOutput, error)

Lists all filters that belong to a given dataset group.

func (*Client) ListRecipes 

func (c *Client) ListRecipes(ctx context.Context, params *ListRecipesInput, optFns ...func(*Options)) (*ListRecipesOutput, error)

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

func (*Client) ListRecommenders added in v1.12.0 

func (c *Client) ListRecommenders(ctx context.Context, params *ListRecommendersInput, optFns ...func(*Options)) (*ListRecommendersOutput, error)

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html).

func (*Client) ListSchemas 

func (c *Client) ListSchemas(ctx context.Context, params *ListSchemasInput, optFns ...func(*Options)) (*ListSchemasOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html).

func (*Client) ListSolutionVersions 

func (c *Client) ListSolutionVersions(ctx context.Context, params *ListSolutionVersionsInput, optFns ...func(*Options)) (*ListSolutionVersionsOutput, error)

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

func (*Client) ListSolutions 

func (c *Client) ListSolutions(ctx context.Context, params *ListSolutionsInput, optFns ...func(*Options)) (*ListSolutionsOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html).

func (*Client) ListTagsForResource added in v1.18.0 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Get a list of tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) attached to a resource.

func (*Client) StartRecommender added in v1.19.0 

func (c *Client) StartRecommender(ctx context.Context, params *StartRecommenderInput, optFns ...func(*Options)) (*StartRecommenderOutput, error)

Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.

func (*Client) StopRecommender added in v1.19.0 

func (c *Client) StopRecommender(ctx context.Context, params *StopRecommenderInput, optFns ...func(*Options)) (*StopRecommenderOutput, error)

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

func (*Client) StopSolutionVersionCreation added in v1.5.0 

func (c *Client) StopSolutionVersionCreation(ctx context.Context, params *StopSolutionVersionCreationInput, optFns ...func(*Options)) (*StopSolutionVersionCreationOutput, error)

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on the current state of the solution version, the solution version state changes as follows:

* CREATE_PENDING > CREATE_STOPPED or

* CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED

You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

func (*Client) TagResource added in v1.18.0 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Add a list of tags to a resource.

func (*Client) UntagResource added in v1.18.0 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Remove tags (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) that are attached to a resource.

func (*Client) UpdateCampaign 

func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput, optFns ...func(*Options)) (*UpdateCampaignOutput, error)

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 (https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) operation. You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active. For more information on campaigns, see CreateCampaign (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html).

func (*Client) UpdateRecommender added in v1.12.0 

func (c *Client) UpdateRecommender(ctx context.Context, params *UpdateRecommenderInput, optFns ...func(*Options)) (*UpdateRecommenderOutput, error)

Updates the recommender to modify the recommender configuration.

type CreateBatchInferenceJobInput 

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.
	//
	// This member is required.
	JobInput *types.BatchInferenceJobInput

	// The name of the batch inference job to create.
	//
	// This member is required.
	JobName *string

	// The path to the Amazon S3 bucket where the job's output will be stored.
	//
	// This member is required.
	JobOutput *types.BatchInferenceJobOutput

	// The ARN of the Amazon Identity and Access Management role that has permissions
	// to read and write to your input and output Amazon S3 buckets respectively.
	//
	// This member is required.
	RoleArn *string

	// The Amazon Resource Name (ARN) of the solution version that will be used to
	// generate the batch inference recommendations.
	//
	// This member is required.
	SolutionVersionArn *string

	// The configuration details of a batch inference job.
	BatchInferenceJobConfig *types.BatchInferenceJobConfig

	// The ARN of the filter to apply to the batch inference job. For more information
	// on using filters, see Filtering batch recommendations
	// (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).
	FilterArn *string

	// The number of recommendations to retrieve.
	NumResults *int32

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the batch inference job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBatchInferenceJobOutput 

type CreateBatchInferenceJobOutput struct {

	// The ARN of the batch inference job.
	BatchInferenceJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBatchSegmentJobInput added in v1.12.0 

type CreateBatchSegmentJobInput struct {

	// The Amazon S3 path for the input data used to generate the batch segment job.
	//
	// This member is required.
	JobInput *types.BatchSegmentJobInput

	// The name of the batch segment job to create.
	//
	// This member is required.
	JobName *string

	// The Amazon S3 path for the bucket where the job's output will be stored.
	//
	// This member is required.
	JobOutput *types.BatchSegmentJobOutput

	// The ARN of the Amazon Identity and Access Management role that has permissions
	// to read and write to your input and output Amazon S3 buckets respectively.
	//
	// This member is required.
	RoleArn *string

	// The Amazon Resource Name (ARN) of the solution version you want the batch
	// segment job to use to generate batch segments.
	//
	// This member is required.
	SolutionVersionArn *string

	// The ARN of the filter to apply to the batch segment job. For more information on
	// using filters, see Filtering batch recommendations
	// (https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html).
	FilterArn *string

	// The number of predicted users generated by the batch segment job for each line
	// of input data.
	NumResults *int32

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the batch segment job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateBatchSegmentJobOutput added in v1.12.0 

type CreateBatchSegmentJobOutput struct {

	// The ARN of the batch segment job.
	BatchSegmentJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCampaignInput 

type CreateCampaignInput struct {

	// A name for the new campaign. The campaign name must be unique within your
	// account.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the solution version to deploy.
	//
	// This member is required.
	SolutionVersionArn *string

	// The configuration details of a campaign.
	CampaignConfig *types.CampaignConfig

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

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the campaign.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCampaignOutput 

type CreateCampaignOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetExportJobInput added in v1.3.0 

type CreateDatasetExportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset that contains the data to export.
	//
	// This member is required.
	DatasetArn *string

	// The name for the dataset export job.
	//
	// This member is required.
	JobName *string

	// The path to the Amazon S3 bucket where the job's output is stored.
	//
	// This member is required.
	JobOutput *types.DatasetExportJobOutput

	// The Amazon Resource Name (ARN) of the IAM service role that has permissions to
	// add data to your output Amazon S3 bucket.
	//
	// This member is required.
	RoleArn *string

	// The data to export, based on how you imported the data. You can choose to export
	// only BULK data that you imported using a dataset import job, only PUT data that
	// you imported incrementally (using the console, PutEvents, PutUsers and PutItems
	// operations), or ALL for both types. The default value is PUT.
	IngestionMode types.IngestionMode

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the dataset export job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetExportJobOutput added in v1.3.0 

type CreateDatasetExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the dataset export job.
	DatasetExportJobArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetGroupInput 

type CreateDatasetGroupInput struct {

	// The name for the new dataset group.
	//
	// This member is required.
	Name *string

	// The domain of the dataset group. Specify a domain to create a Domain dataset
	// group. The domain you specify determines the default schemas for datasets and
	// the use cases available for recommenders. If you don't specify a domain, you
	// create a Custom dataset group with solution versions that you deploy with a
	// campaign.
	Domain types.Domain

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

	// The ARN of the Identity and Access Management (IAM) role that has permissions to
	// access the Key Management Service (KMS) key. Supplying an IAM role is only valid
	// when also specifying a KMS key.
	RoleArn *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the dataset group.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetGroupOutput 

type CreateDatasetGroupOutput struct {

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

	// The domain for the new Domain dataset group.
	Domain types.Domain

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetImportJobInput 

type CreateDatasetImportJobInput struct {

	// The Amazon S3 bucket that contains the training data to import.
	//
	// This member is required.
	DataSource *types.DataSource

	// The ARN of the dataset that receives the imported data.
	//
	// This member is required.
	DatasetArn *string

	// The name for the dataset import job.
	//
	// This member is required.
	JobName *string

	// The ARN of the IAM role that has permissions to read from the Amazon S3 data
	// source.
	//
	// This member is required.
	RoleArn *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the dataset import job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetImportJobOutput 

type CreateDatasetImportJobOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDatasetInput 

type CreateDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
	//
	// This member is required.
	DatasetGroupArn *string

	// The type of dataset. One of the following (case insensitive) values:
	//
	// *
	// Interactions
	//
	// * Items
	//
	// * Users
	//
	// This member is required.
	DatasetType *string

	// The name for the dataset.
	//
	// This member is required.
	Name *string

	// The ARN of the schema to associate with the dataset. The schema defines the
	// dataset fields.
	//
	// This member is required.
	SchemaArn *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the dataset.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDatasetOutput 

type CreateDatasetOutput struct {

	// The ARN of the dataset.
	DatasetArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEventTrackerInput 

type CreateEventTrackerInput struct {

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

	// The name for the event tracker.
	//
	// This member is required.
	Name *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the event tracker.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateEventTrackerOutput 

type CreateEventTrackerOutput struct {

	// The ARN of the event tracker.
	EventTrackerArn *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateFilterInput 

type CreateFilterInput struct {

	// The ARN of the dataset group that the filter will belong to.
	//
	// This member is required.
	DatasetGroupArn *string

	// The filter expression defines which items are included or excluded from
	// recommendations. Filter expression must follow specific format rules. For
	// information about filter expression structure and syntax, see Filter expressions
	// (https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html).
	//
	// This member is required.
	FilterExpression *string

	// The name of the filter to create.
	//
	// This member is required.
	Name *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the filter.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFilterOutput 

type CreateFilterOutput struct {

	// The ARN of the new filter.
	FilterArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateRecommenderInput added in v1.12.0 

type CreateRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the destination domain dataset group for the
	// recommender.
	//
	// This member is required.
	DatasetGroupArn *string

	// The name of the recommender.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the recipe that the recommender will use. For
	// a recommender, a recipe is a Domain dataset group use case. Only Domain dataset
	// group use cases can be used to create a recommender. For information about use
	// cases see Choosing recommender use cases
	// (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html).
	//
	// This member is required.
	RecipeArn *string

	// The configuration details of the recommender.
	RecommenderConfig *types.RecommenderConfig

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the recommender.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateRecommenderOutput added in v1.12.0 

type CreateRecommenderOutput struct {

	// The Amazon Resource Name (ARN) of the recommender.
	RecommenderArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSchemaInput 

type CreateSchemaInput struct {

	// The name for the schema.
	//
	// This member is required.
	Name *string

	// A schema in Avro JSON format.
	//
	// This member is required.
	Schema *string

	// The domain for the schema. If you are creating a schema for a dataset in a
	// Domain dataset group, specify the domain you chose when you created the Domain
	// dataset group.
	Domain types.Domain
	// contains filtered or unexported fields
}

type CreateSchemaOutput 

type CreateSchemaOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSolutionInput 

type CreateSolutionInput struct {

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

	// The name for the solution.
	//
	// This member is required.
	Name *string

	// When your have multiple event types (using an EVENT_TYPE schema field), this
	// parameter specifies which event type (for example, 'click' or 'like') is used
	// for training the model. If you do not provide an eventType, Amazon Personalize
	// will use all interactions for training with equal weight regardless of type.
	EventType *string

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

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

	// The ARN of the recipe to use for model training. Only specified when
	// performAutoML is false.
	RecipeArn *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. Amazon Personalize doesn't support configuring the hpoObjective
	// at this time.
	SolutionConfig *types.SolutionConfig

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the solution.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSolutionOutput 

type CreateSolutionOutput struct {

	// The ARN of the solution.
	SolutionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSolutionVersionInput 

type CreateSolutionVersionInput struct {

	// The Amazon Resource Name (ARN) of the solution containing the training
	// configuration information.
	//
	// This member is required.
	SolutionArn *string

	// A list of tags
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html) to
	// apply to the solution version.
	Tags []types.Tag

	// The scope of training to be performed when creating the solution version. The
	// FULL option trains the solution version based on the entirety of the input
	// solution's training data, while the UPDATE option processes only the data that
	// has changed in comparison to the input solution. Choose UPDATE when you want to
	// incrementally update your solution version instead of creating an entirely new
	// one. The UPDATE option can only be used when you already have an active solution
	// version created from the input solution using the FULL option and the input
	// solution was trained with the User-Personalization
	// (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)
	// recipe or the HRNN-Coldstart
	// (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html)
	// recipe.
	TrainingMode types.TrainingMode
	// contains filtered or unexported fields
}

type CreateSolutionVersionOutput 

type CreateSolutionVersionOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCampaignInput 

type DeleteCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign to delete.
	//
	// This member is required.
	CampaignArn *string
	// contains filtered or unexported fields
}

type DeleteCampaignOutput 

type DeleteCampaignOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetGroupInput 

type DeleteDatasetGroupInput struct {

	// The ARN of the dataset group to delete.
	//
	// This member is required.
	DatasetGroupArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetGroupOutput 

type DeleteDatasetGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDatasetInput 

type DeleteDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to delete.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DeleteDatasetOutput 

type DeleteDatasetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEventTrackerInput 

type DeleteEventTrackerInput struct {

	// The Amazon Resource Name (ARN) of the event tracker to delete.
	//
	// This member is required.
	EventTrackerArn *string
	// contains filtered or unexported fields
}

type DeleteEventTrackerOutput 

type DeleteEventTrackerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteFilterInput 

type DeleteFilterInput struct {

	// The ARN of the filter to delete.
	//
	// This member is required.
	FilterArn *string
	// contains filtered or unexported fields
}

type DeleteFilterOutput 

type DeleteFilterOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteRecommenderInput added in v1.12.0 

type DeleteRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the recommender to delete.
	//
	// This member is required.
	RecommenderArn *string
	// contains filtered or unexported fields
}

type DeleteRecommenderOutput added in v1.12.0 

type DeleteRecommenderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSchemaInput 

type DeleteSchemaInput struct {

	// The Amazon Resource Name (ARN) of the schema to delete.
	//
	// This member is required.
	SchemaArn *string
	// contains filtered or unexported fields
}

type DeleteSchemaOutput 

type DeleteSchemaOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSolutionInput 

type DeleteSolutionInput struct {

	// The ARN of the solution to delete.
	//
	// This member is required.
	SolutionArn *string
	// contains filtered or unexported fields
}

type DeleteSolutionOutput 

type DeleteSolutionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAlgorithmInput 

type DescribeAlgorithmInput struct {

	// The Amazon Resource Name (ARN) of the algorithm to describe.
	//
	// This member is required.
	AlgorithmArn *string
	// contains filtered or unexported fields
}

type DescribeAlgorithmOutput 

type DescribeAlgorithmOutput struct {

	// A listing of the properties of the algorithm.
	Algorithm *types.Algorithm

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBatchInferenceJobInput 

type DescribeBatchInferenceJobInput struct {

	// The ARN of the batch inference job to describe.
	//
	// This member is required.
	BatchInferenceJobArn *string
	// contains filtered or unexported fields
}

type DescribeBatchInferenceJobOutput 

type DescribeBatchInferenceJobOutput struct {

	// Information on the specified batch inference job.
	BatchInferenceJob *types.BatchInferenceJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBatchSegmentJobInput added in v1.12.0 

type DescribeBatchSegmentJobInput struct {

	// The ARN of the batch segment job to describe.
	//
	// This member is required.
	BatchSegmentJobArn *string
	// contains filtered or unexported fields
}

type DescribeBatchSegmentJobOutput added in v1.12.0 

type DescribeBatchSegmentJobOutput struct {

	// Information on the specified batch segment job.
	BatchSegmentJob *types.BatchSegmentJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCampaignInput 

type DescribeCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// This member is required.
	CampaignArn *string
	// contains filtered or unexported fields
}

type DescribeCampaignOutput 

type DescribeCampaignOutput struct {

	// The properties of the campaign.
	Campaign *types.Campaign

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetExportJobInput added in v1.3.0 

type DescribeDatasetExportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset export job to describe.
	//
	// This member is required.
	DatasetExportJobArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetExportJobOutput added in v1.3.0 

type DescribeDatasetExportJobOutput struct {

	// Information about the dataset export job, including the status. The status is
	// one of the following values:
	//
	// * CREATE PENDING
	//
	// * CREATE IN_PROGRESS
	//
	// *
	// ACTIVE
	//
	// * CREATE FAILED
	DatasetExportJob *types.DatasetExportJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetGroupInput 

type DescribeDatasetGroupInput struct {

	// The Amazon Resource Name (ARN) of the dataset group to describe.
	//
	// This member is required.
	DatasetGroupArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetGroupOutput 

type DescribeDatasetGroupOutput struct {

	// A listing of the dataset group's properties.
	DatasetGroup *types.DatasetGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetImportJobInput 

type DescribeDatasetImportJobInput struct {

	// The Amazon Resource Name (ARN) of the dataset import job to describe.
	//
	// This member is required.
	DatasetImportJobArn *string
	// contains filtered or unexported fields
}

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 *types.DatasetImportJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDatasetInput 

type DescribeDatasetInput struct {

	// The Amazon Resource Name (ARN) of the dataset to describe.
	//
	// This member is required.
	DatasetArn *string
	// contains filtered or unexported fields
}

type DescribeDatasetOutput 

type DescribeDatasetOutput struct {

	// A listing of the dataset's properties.
	Dataset *types.Dataset

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEventTrackerInput 

type DescribeEventTrackerInput struct {

	// The Amazon Resource Name (ARN) of the event tracker to describe.
	//
	// This member is required.
	EventTrackerArn *string
	// contains filtered or unexported fields
}

type DescribeEventTrackerOutput 

type DescribeEventTrackerOutput struct {

	// An object that describes the event tracker.
	EventTracker *types.EventTracker

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFeatureTransformationInput 

type DescribeFeatureTransformationInput struct {

	// The Amazon Resource Name (ARN) of the feature transformation to describe.
	//
	// This member is required.
	FeatureTransformationArn *string
	// contains filtered or unexported fields
}

type DescribeFeatureTransformationOutput 

type DescribeFeatureTransformationOutput struct {

	// A listing of the FeatureTransformation properties.
	FeatureTransformation *types.FeatureTransformation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeFilterInput 

type DescribeFilterInput struct {

	// The ARN of the filter to describe.
	//
	// This member is required.
	FilterArn *string
	// contains filtered or unexported fields
}

type DescribeFilterOutput 

type DescribeFilterOutput struct {

	// The filter's details.
	Filter *types.Filter

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRecipeInput 

type DescribeRecipeInput struct {

	// The Amazon Resource Name (ARN) of the recipe to describe.
	//
	// This member is required.
	RecipeArn *string
	// contains filtered or unexported fields
}

type DescribeRecipeOutput 

type DescribeRecipeOutput struct {

	// An object that describes the recipe.
	Recipe *types.Recipe

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeRecommenderInput added in v1.12.0 

type DescribeRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the recommender to describe.
	//
	// This member is required.
	RecommenderArn *string
	// contains filtered or unexported fields
}

type DescribeRecommenderOutput added in v1.12.0 

type DescribeRecommenderOutput struct {

	// The properties of the recommender.
	Recommender *types.Recommender

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSchemaInput 

type DescribeSchemaInput struct {

	// The Amazon Resource Name (ARN) of the schema to retrieve.
	//
	// This member is required.
	SchemaArn *string
	// contains filtered or unexported fields
}

type DescribeSchemaOutput 

type DescribeSchemaOutput struct {

	// The requested schema.
	Schema *types.DatasetSchema

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSolutionInput 

type DescribeSolutionInput struct {

	// The Amazon Resource Name (ARN) of the solution to describe.
	//
	// This member is required.
	SolutionArn *string
	// contains filtered or unexported fields
}

type DescribeSolutionOutput 

type DescribeSolutionOutput struct {

	// An object that describes the solution.
	Solution *types.Solution

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeSolutionVersionInput 

type DescribeSolutionVersionInput struct {

	// The Amazon Resource Name (ARN) of the solution version.
	//
	// This member is required.
	SolutionVersionArn *string
	// contains filtered or unexported fields
}

type DescribeSolutionVersionOutput 

type DescribeSolutionVersionOutput struct {

	// The solution version.
	SolutionVersion *types.SolutionVersion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetSolutionMetricsInput 

type GetSolutionMetricsInput struct {

	// The Amazon Resource Name (ARN) of the solution version for which to get metrics.
	//
	// This member is required.
	SolutionVersionArn *string
	// contains filtered or unexported fields
}

type GetSolutionMetricsOutput 

type GetSolutionMetricsOutput struct {

	// The metrics for the solution version. For more information, see  Evaluating a
	// solution version with metrics
	// (https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html).
	Metrics map[string]float64

	// The same solution version ARN as specified in the request.
	SolutionVersionArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListBatchInferenceJobsAPIClient added in v0.30.0 

type ListBatchInferenceJobsAPIClient interface {
	ListBatchInferenceJobs(context.Context, *ListBatchInferenceJobsInput, ...func(*Options)) (*ListBatchInferenceJobsOutput, error)
}

ListBatchInferenceJobsAPIClient is a client that implements the ListBatchInferenceJobs operation.

type ListBatchInferenceJobsInput 

type ListBatchInferenceJobsInput struct {

	// The maximum number of batch inference job results to return in each page. The
	// default value is 100.
	MaxResults *int32

	// The token to request the next page of results.
	NextToken *string

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

type ListBatchInferenceJobsOutput 

type ListBatchInferenceJobsOutput struct {

	// A list containing information on each job that is returned.
	BatchInferenceJobs []types.BatchInferenceJobSummary

	// The token to use to retrieve the next page of results. The value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBatchInferenceJobsPaginator added in v0.30.0 

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

ListBatchInferenceJobsPaginator is a paginator for ListBatchInferenceJobs

func NewListBatchInferenceJobsPaginator added in v0.30.0 

func NewListBatchInferenceJobsPaginator(client ListBatchInferenceJobsAPIClient, params *ListBatchInferenceJobsInput, optFns ...func(*ListBatchInferenceJobsPaginatorOptions)) *ListBatchInferenceJobsPaginator

NewListBatchInferenceJobsPaginator returns a new ListBatchInferenceJobsPaginator

func (*ListBatchInferenceJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListBatchInferenceJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBatchInferenceJobsPaginator) NextPage added in v0.30.0 

func (p *ListBatchInferenceJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBatchInferenceJobsOutput, error)

NextPage retrieves the next ListBatchInferenceJobs page.

type ListBatchInferenceJobsPaginatorOptions added in v0.30.0 

type ListBatchInferenceJobsPaginatorOptions struct {
	// The maximum number of batch inference job results to return in each page. The
	// default value is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBatchInferenceJobsPaginatorOptions is the paginator options for ListBatchInferenceJobs

type ListBatchSegmentJobsAPIClient added in v1.12.0 

type ListBatchSegmentJobsAPIClient interface {
	ListBatchSegmentJobs(context.Context, *ListBatchSegmentJobsInput, ...func(*Options)) (*ListBatchSegmentJobsOutput, error)
}

ListBatchSegmentJobsAPIClient is a client that implements the ListBatchSegmentJobs operation.

type ListBatchSegmentJobsInput added in v1.12.0 

type ListBatchSegmentJobsInput struct {

	// The maximum number of batch segment job results to return in each page. The
	// default value is 100.
	MaxResults *int32

	// The token to request the next page of results.
	NextToken *string

	// The Amazon Resource Name (ARN) of the solution version that the batch segment
	// jobs used to generate batch segments.
	SolutionVersionArn *string
	// contains filtered or unexported fields
}

type ListBatchSegmentJobsOutput added in v1.12.0 

type ListBatchSegmentJobsOutput struct {

	// A list containing information on each job that is returned.
	BatchSegmentJobs []types.BatchSegmentJobSummary

	// The token to use to retrieve the next page of results. The value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListBatchSegmentJobsPaginator added in v1.12.0 

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

ListBatchSegmentJobsPaginator is a paginator for ListBatchSegmentJobs

func NewListBatchSegmentJobsPaginator added in v1.12.0 

func NewListBatchSegmentJobsPaginator(client ListBatchSegmentJobsAPIClient, params *ListBatchSegmentJobsInput, optFns ...func(*ListBatchSegmentJobsPaginatorOptions)) *ListBatchSegmentJobsPaginator

NewListBatchSegmentJobsPaginator returns a new ListBatchSegmentJobsPaginator

func (*ListBatchSegmentJobsPaginator) HasMorePages added in v1.12.0 

func (p *ListBatchSegmentJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBatchSegmentJobsPaginator) NextPage added in v1.12.0 

func (p *ListBatchSegmentJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBatchSegmentJobsOutput, error)

NextPage retrieves the next ListBatchSegmentJobs page.

type ListBatchSegmentJobsPaginatorOptions added in v1.12.0 

type ListBatchSegmentJobsPaginatorOptions struct {
	// The maximum number of batch segment job results to return in each page. The
	// default value is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBatchSegmentJobsPaginatorOptions is the paginator options for ListBatchSegmentJobs

type ListCampaignsAPIClient added in v0.30.0 

type ListCampaignsAPIClient interface {
	ListCampaigns(context.Context, *ListCampaignsInput, ...func(*Options)) (*ListCampaignsOutput, error)
}

ListCampaignsAPIClient is a client that implements the ListCampaigns operation.

type ListCampaignsInput 

type ListCampaignsInput struct {

	// The maximum number of campaigns to return.
	MaxResults *int32

	// A token returned from the previous call to ListCampaigns
	// (https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) for
	// getting the next set of campaigns (if they exist).
	NextToken *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
	// contains filtered or unexported fields
}

type ListCampaignsOutput 

type ListCampaignsOutput struct {

	// A list of the campaigns.
	Campaigns []types.CampaignSummary

	// A token for getting the next set of campaigns (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCampaignsPaginator added in v0.30.0 

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

ListCampaignsPaginator is a paginator for ListCampaigns

func NewListCampaignsPaginator added in v0.30.0 

func NewListCampaignsPaginator(client ListCampaignsAPIClient, params *ListCampaignsInput, optFns ...func(*ListCampaignsPaginatorOptions)) *ListCampaignsPaginator

NewListCampaignsPaginator returns a new ListCampaignsPaginator

func (*ListCampaignsPaginator) HasMorePages added in v0.30.0 

func (p *ListCampaignsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCampaignsPaginator) NextPage added in v0.30.0 

func (p *ListCampaignsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCampaignsOutput, error)

NextPage retrieves the next ListCampaigns page.

type ListCampaignsPaginatorOptions added in v0.30.0 

type ListCampaignsPaginatorOptions struct {
	// The maximum number of campaigns to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCampaignsPaginatorOptions is the paginator options for ListCampaigns

type ListDatasetExportJobsAPIClient added in v1.3.0 

type ListDatasetExportJobsAPIClient interface {
	ListDatasetExportJobs(context.Context, *ListDatasetExportJobsInput, ...func(*Options)) (*ListDatasetExportJobsOutput, error)
}

ListDatasetExportJobsAPIClient is a client that implements the ListDatasetExportJobs operation.

type ListDatasetExportJobsInput added in v1.3.0 

type ListDatasetExportJobsInput struct {

	// The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs
	// for.
	DatasetArn *string

	// The maximum number of dataset export jobs to return.
	MaxResults *int32

	// A token returned from the previous call to ListDatasetExportJobs for getting the
	// next set of dataset export jobs (if they exist).
	NextToken *string
	// contains filtered or unexported fields
}

type ListDatasetExportJobsOutput added in v1.3.0 

type ListDatasetExportJobsOutput struct {

	// The list of dataset export jobs.
	DatasetExportJobs []types.DatasetExportJobSummary

	// A token for getting the next set of dataset export jobs (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetExportJobsPaginator added in v1.3.0 

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

ListDatasetExportJobsPaginator is a paginator for ListDatasetExportJobs

func NewListDatasetExportJobsPaginator added in v1.3.0 

func NewListDatasetExportJobsPaginator(client ListDatasetExportJobsAPIClient, params *ListDatasetExportJobsInput, optFns ...func(*ListDatasetExportJobsPaginatorOptions)) *ListDatasetExportJobsPaginator

NewListDatasetExportJobsPaginator returns a new ListDatasetExportJobsPaginator

func (*ListDatasetExportJobsPaginator) HasMorePages added in v1.3.0 

func (p *ListDatasetExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetExportJobsPaginator) NextPage added in v1.3.0 

func (p *ListDatasetExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetExportJobsOutput, error)

NextPage retrieves the next ListDatasetExportJobs page.

type ListDatasetExportJobsPaginatorOptions added in v1.3.0 

type ListDatasetExportJobsPaginatorOptions struct {
	// The maximum number of dataset export jobs to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetExportJobsPaginatorOptions is the paginator options for ListDatasetExportJobs

type ListDatasetGroupsAPIClient added in v0.30.0 

type ListDatasetGroupsAPIClient interface {
	ListDatasetGroups(context.Context, *ListDatasetGroupsInput, ...func(*Options)) (*ListDatasetGroupsOutput, error)
}

ListDatasetGroupsAPIClient is a client that implements the ListDatasetGroups operation.

type ListDatasetGroupsInput 

type ListDatasetGroupsInput struct {

	// The maximum number of dataset groups to return.
	MaxResults *int32

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

type ListDatasetGroupsOutput 

type ListDatasetGroupsOutput struct {

	// The list of your dataset groups.
	DatasetGroups []types.DatasetGroupSummary

	// A token for getting the next set of dataset groups (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetGroupsPaginator added in v0.30.0 

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

ListDatasetGroupsPaginator is a paginator for ListDatasetGroups

func NewListDatasetGroupsPaginator added in v0.30.0 

func NewListDatasetGroupsPaginator(client ListDatasetGroupsAPIClient, params *ListDatasetGroupsInput, optFns ...func(*ListDatasetGroupsPaginatorOptions)) *ListDatasetGroupsPaginator

NewListDatasetGroupsPaginator returns a new ListDatasetGroupsPaginator

func (*ListDatasetGroupsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetGroupsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetGroupsOutput, error)

NextPage retrieves the next ListDatasetGroups page.

type ListDatasetGroupsPaginatorOptions added in v0.30.0 

type ListDatasetGroupsPaginatorOptions struct {
	// The maximum number of dataset groups to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetGroupsPaginatorOptions is the paginator options for ListDatasetGroups

type ListDatasetImportJobsAPIClient added in v0.30.0 

type ListDatasetImportJobsAPIClient interface {
	ListDatasetImportJobs(context.Context, *ListDatasetImportJobsInput, ...func(*Options)) (*ListDatasetImportJobsOutput, error)
}

ListDatasetImportJobsAPIClient is a client that implements the ListDatasetImportJobs operation.

type ListDatasetImportJobsInput 

type ListDatasetImportJobsInput struct {

	// The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs
	// for.
	DatasetArn *string

	// The maximum number of dataset import jobs to return.
	MaxResults *int32

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

type ListDatasetImportJobsOutput 

type ListDatasetImportJobsOutput struct {

	// The list of dataset import jobs.
	DatasetImportJobs []types.DatasetImportJobSummary

	// A token for getting the next set of dataset import jobs (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetImportJobsPaginator added in v0.30.0 

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

ListDatasetImportJobsPaginator is a paginator for ListDatasetImportJobs

func NewListDatasetImportJobsPaginator added in v0.30.0 

func NewListDatasetImportJobsPaginator(client ListDatasetImportJobsAPIClient, params *ListDatasetImportJobsInput, optFns ...func(*ListDatasetImportJobsPaginatorOptions)) *ListDatasetImportJobsPaginator

NewListDatasetImportJobsPaginator returns a new ListDatasetImportJobsPaginator

func (*ListDatasetImportJobsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetImportJobsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetImportJobsOutput, error)

NextPage retrieves the next ListDatasetImportJobs page.

type ListDatasetImportJobsPaginatorOptions added in v0.30.0 

type ListDatasetImportJobsPaginatorOptions struct {
	// The maximum number of dataset import jobs to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetImportJobsPaginatorOptions is the paginator options for ListDatasetImportJobs

type ListDatasetsAPIClient added in v0.30.0 

type ListDatasetsAPIClient interface {
	ListDatasets(context.Context, *ListDatasetsInput, ...func(*Options)) (*ListDatasetsOutput, error)
}

ListDatasetsAPIClient is a client that implements the ListDatasets operation.

type ListDatasetsInput 

type ListDatasetsInput struct {

	// The Amazon Resource Name (ARN) of the dataset group that contains the datasets
	// to list.
	DatasetGroupArn *string

	// The maximum number of datasets to return.
	MaxResults *int32

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

type ListDatasetsOutput 

type ListDatasetsOutput struct {

	// An array of Dataset objects. Each object provides metadata information.
	Datasets []types.DatasetSummary

	// A token for getting the next set of datasets (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDatasetsPaginator added in v0.30.0 

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

ListDatasetsPaginator is a paginator for ListDatasets

func NewListDatasetsPaginator added in v0.30.0 

func NewListDatasetsPaginator(client ListDatasetsAPIClient, params *ListDatasetsInput, optFns ...func(*ListDatasetsPaginatorOptions)) *ListDatasetsPaginator

NewListDatasetsPaginator returns a new ListDatasetsPaginator

func (*ListDatasetsPaginator) HasMorePages added in v0.30.0 

func (p *ListDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDatasetsPaginator) NextPage added in v0.30.0 

func (p *ListDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDatasetsOutput, error)

NextPage retrieves the next ListDatasets page.

type ListDatasetsPaginatorOptions added in v0.30.0 

type ListDatasetsPaginatorOptions struct {
	// The maximum number of datasets to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDatasetsPaginatorOptions is the paginator options for ListDatasets

type ListEventTrackersAPIClient added in v0.30.0 

type ListEventTrackersAPIClient interface {
	ListEventTrackers(context.Context, *ListEventTrackersInput, ...func(*Options)) (*ListEventTrackersOutput, error)
}

ListEventTrackersAPIClient is a client that implements the ListEventTrackers operation.

type ListEventTrackersInput 

type ListEventTrackersInput struct {

	// The ARN of a dataset group used to filter the response.
	DatasetGroupArn *string

	// The maximum number of event trackers to return.
	MaxResults *int32

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

type ListEventTrackersOutput 

type ListEventTrackersOutput struct {

	// A list of event trackers.
	EventTrackers []types.EventTrackerSummary

	// A token for getting the next set of event trackers (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEventTrackersPaginator added in v0.30.0 

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

ListEventTrackersPaginator is a paginator for ListEventTrackers

func NewListEventTrackersPaginator added in v0.30.0 

func NewListEventTrackersPaginator(client ListEventTrackersAPIClient, params *ListEventTrackersInput, optFns ...func(*ListEventTrackersPaginatorOptions)) *ListEventTrackersPaginator

NewListEventTrackersPaginator returns a new ListEventTrackersPaginator

func (*ListEventTrackersPaginator) HasMorePages added in v0.30.0 

func (p *ListEventTrackersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEventTrackersPaginator) NextPage added in v0.30.0 

func (p *ListEventTrackersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEventTrackersOutput, error)

NextPage retrieves the next ListEventTrackers page.

type ListEventTrackersPaginatorOptions added in v0.30.0 

type ListEventTrackersPaginatorOptions struct {
	// The maximum number of event trackers to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEventTrackersPaginatorOptions is the paginator options for ListEventTrackers

type ListFiltersAPIClient added in v1.3.0 

type ListFiltersAPIClient interface {
	ListFilters(context.Context, *ListFiltersInput, ...func(*Options)) (*ListFiltersOutput, error)
}

ListFiltersAPIClient is a client that implements the ListFilters operation.

type ListFiltersInput 

type ListFiltersInput struct {

	// The ARN of the dataset group that contains the filters.
	DatasetGroupArn *string

	// The maximum number of filters to return.
	MaxResults *int32

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

type ListFiltersOutput 

type ListFiltersOutput struct {

	// A list of returned filters.
	Filters []types.FilterSummary

	// A token for getting the next set of filters (if they exist).
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFiltersPaginator added in v1.3.0 

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

ListFiltersPaginator is a paginator for ListFilters

func NewListFiltersPaginator added in v1.3.0 

func NewListFiltersPaginator(client ListFiltersAPIClient, params *ListFiltersInput, optFns ...func(*ListFiltersPaginatorOptions)) *ListFiltersPaginator

NewListFiltersPaginator returns a new ListFiltersPaginator

func (*ListFiltersPaginator) HasMorePages added in v1.3.0 

func (p *ListFiltersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFiltersPaginator) NextPage added in v1.3.0 

func (p *ListFiltersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFiltersOutput, error)

NextPage retrieves the next ListFilters page.

type ListFiltersPaginatorOptions added in v1.3.0 

type ListFiltersPaginatorOptions struct {
	// The maximum number of filters to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFiltersPaginatorOptions is the paginator options for ListFilters

type ListRecipesAPIClient added in v0.30.0 

type ListRecipesAPIClient interface {
	ListRecipes(context.Context, *ListRecipesInput, ...func(*Options)) (*ListRecipesOutput, error)
}

ListRecipesAPIClient is a client that implements the ListRecipes operation.

type ListRecipesInput 

type ListRecipesInput struct {

	// Filters returned recipes by domain for a Domain dataset group. Only recipes
	// (Domain dataset group use cases) for this domain are included in the response.
	// If you don't specify a domain, all recipes are returned.
	Domain types.Domain

	// The maximum number of recipes to return.
	MaxResults *int32

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

	// The default is SERVICE.
	RecipeProvider types.RecipeProvider
	// contains filtered or unexported fields
}

type ListRecipesOutput 

type ListRecipesOutput struct {

	// A token for getting the next set of recipes.
	NextToken *string

	// The list of available recipes.
	Recipes []types.RecipeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecipesPaginator added in v0.30.0 

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

ListRecipesPaginator is a paginator for ListRecipes

func NewListRecipesPaginator added in v0.30.0 

func NewListRecipesPaginator(client ListRecipesAPIClient, params *ListRecipesInput, optFns ...func(*ListRecipesPaginatorOptions)) *ListRecipesPaginator

NewListRecipesPaginator returns a new ListRecipesPaginator

func (*ListRecipesPaginator) HasMorePages added in v0.30.0 

func (p *ListRecipesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecipesPaginator) NextPage added in v0.30.0 

func (p *ListRecipesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecipesOutput, error)

NextPage retrieves the next ListRecipes page.

type ListRecipesPaginatorOptions added in v0.30.0 

type ListRecipesPaginatorOptions struct {
	// The maximum number of recipes to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecipesPaginatorOptions is the paginator options for ListRecipes

type ListRecommendersAPIClient added in v1.12.0 

type ListRecommendersAPIClient interface {
	ListRecommenders(context.Context, *ListRecommendersInput, ...func(*Options)) (*ListRecommendersOutput, error)
}

ListRecommendersAPIClient is a client that implements the ListRecommenders operation.

type ListRecommendersInput added in v1.12.0 

type ListRecommendersInput struct {

	// The Amazon Resource Name (ARN) of the Domain dataset group to list the
	// recommenders for. When a Domain dataset group is not specified, all the
	// recommenders associated with the account are listed.
	DatasetGroupArn *string

	// The maximum number of recommenders to return.
	MaxResults *int32

	// A token returned from the previous call to ListRecommenders for getting the next
	// set of recommenders (if they exist).
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecommendersOutput added in v1.12.0 

type ListRecommendersOutput struct {

	// A token for getting the next set of recommenders (if they exist).
	NextToken *string

	// A list of the recommenders.
	Recommenders []types.RecommenderSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListRecommendersPaginator added in v1.12.0 

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

ListRecommendersPaginator is a paginator for ListRecommenders

func NewListRecommendersPaginator added in v1.12.0 

func NewListRecommendersPaginator(client ListRecommendersAPIClient, params *ListRecommendersInput, optFns ...func(*ListRecommendersPaginatorOptions)) *ListRecommendersPaginator

NewListRecommendersPaginator returns a new ListRecommendersPaginator

func (*ListRecommendersPaginator) HasMorePages added in v1.12.0 

func (p *ListRecommendersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecommendersPaginator) NextPage added in v1.12.0 

func (p *ListRecommendersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendersOutput, error)

NextPage retrieves the next ListRecommenders page.

type ListRecommendersPaginatorOptions added in v1.12.0 

type ListRecommendersPaginatorOptions struct {
	// The maximum number of recommenders to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListRecommendersPaginatorOptions is the paginator options for ListRecommenders

type ListSchemasAPIClient added in v0.30.0 

type ListSchemasAPIClient interface {
	ListSchemas(context.Context, *ListSchemasInput, ...func(*Options)) (*ListSchemasOutput, error)
}

ListSchemasAPIClient is a client that implements the ListSchemas operation.

type ListSchemasInput 

type ListSchemasInput struct {

	// The maximum number of schemas to return.
	MaxResults *int32

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

type ListSchemasOutput 

type ListSchemasOutput struct {

	// A token used to get the next set of schemas (if they exist).
	NextToken *string

	// A list of schemas.
	Schemas []types.DatasetSchemaSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSchemasPaginator added in v0.30.0 

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

ListSchemasPaginator is a paginator for ListSchemas

func NewListSchemasPaginator added in v0.30.0 

func NewListSchemasPaginator(client ListSchemasAPIClient, params *ListSchemasInput, optFns ...func(*ListSchemasPaginatorOptions)) *ListSchemasPaginator

NewListSchemasPaginator returns a new ListSchemasPaginator

func (*ListSchemasPaginator) HasMorePages added in v0.30.0 

func (p *ListSchemasPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSchemasPaginator) NextPage added in v0.30.0 

func (p *ListSchemasPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSchemasOutput, error)

NextPage retrieves the next ListSchemas page.

type ListSchemasPaginatorOptions added in v0.30.0 

type ListSchemasPaginatorOptions struct {
	// The maximum number of schemas to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSchemasPaginatorOptions is the paginator options for ListSchemas

type ListSolutionVersionsAPIClient added in v0.30.0 

type ListSolutionVersionsAPIClient interface {
	ListSolutionVersions(context.Context, *ListSolutionVersionsInput, ...func(*Options)) (*ListSolutionVersionsOutput, error)
}

ListSolutionVersionsAPIClient is a client that implements the ListSolutionVersions operation.

type ListSolutionVersionsInput 

type ListSolutionVersionsInput struct {

	// The maximum number of solution versions to return.
	MaxResults *int32

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

	// The Amazon Resource Name (ARN) of the solution.
	SolutionArn *string
	// contains filtered or unexported fields
}

type ListSolutionVersionsOutput 

type ListSolutionVersionsOutput struct {

	// A token for getting the next set of solution versions (if they exist).
	NextToken *string

	// A list of solution versions describing the version properties.
	SolutionVersions []types.SolutionVersionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolutionVersionsPaginator added in v0.30.0 

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

ListSolutionVersionsPaginator is a paginator for ListSolutionVersions

func NewListSolutionVersionsPaginator added in v0.30.0 

func NewListSolutionVersionsPaginator(client ListSolutionVersionsAPIClient, params *ListSolutionVersionsInput, optFns ...func(*ListSolutionVersionsPaginatorOptions)) *ListSolutionVersionsPaginator

NewListSolutionVersionsPaginator returns a new ListSolutionVersionsPaginator

func (*ListSolutionVersionsPaginator) HasMorePages added in v0.30.0 

func (p *ListSolutionVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolutionVersionsPaginator) NextPage added in v0.30.0 

func (p *ListSolutionVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolutionVersionsOutput, error)

NextPage retrieves the next ListSolutionVersions page.

type ListSolutionVersionsPaginatorOptions added in v0.30.0 

type ListSolutionVersionsPaginatorOptions struct {
	// The maximum number of solution versions to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolutionVersionsPaginatorOptions is the paginator options for ListSolutionVersions

type ListSolutionsAPIClient added in v0.30.0 

type ListSolutionsAPIClient interface {
	ListSolutions(context.Context, *ListSolutionsInput, ...func(*Options)) (*ListSolutionsOutput, error)
}

ListSolutionsAPIClient is a client that implements the ListSolutions operation.

type ListSolutionsInput 

type ListSolutionsInput struct {

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

	// The maximum number of solutions to return.
	MaxResults *int32

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

type ListSolutionsOutput 

type ListSolutionsOutput struct {

	// A token for getting the next set of solutions (if they exist).
	NextToken *string

	// A list of the current solutions.
	Solutions []types.SolutionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListSolutionsPaginator added in v0.30.0 

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

ListSolutionsPaginator is a paginator for ListSolutions

func NewListSolutionsPaginator added in v0.30.0 

func NewListSolutionsPaginator(client ListSolutionsAPIClient, params *ListSolutionsInput, optFns ...func(*ListSolutionsPaginatorOptions)) *ListSolutionsPaginator

NewListSolutionsPaginator returns a new ListSolutionsPaginator

func (*ListSolutionsPaginator) HasMorePages added in v0.30.0 

func (p *ListSolutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSolutionsPaginator) NextPage added in v0.30.0 

func (p *ListSolutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSolutionsOutput, error)

NextPage retrieves the next ListSolutions page.

type ListSolutionsPaginatorOptions added in v0.30.0 

type ListSolutionsPaginatorOptions struct {
	// The maximum number of solutions to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListSolutionsPaginatorOptions is the paginator options for ListSolutions

type ListTagsForResourceInput added in v1.18.0 

type ListTagsForResourceInput struct {

	// The resource's Amazon Resource Name.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.18.0 

type ListTagsForResourceOutput struct {

	// The resource's tags.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartRecommenderInput added in v1.19.0 

type StartRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the recommender to start.
	//
	// This member is required.
	RecommenderArn *string
	// contains filtered or unexported fields
}

type StartRecommenderOutput added in v1.19.0 

type StartRecommenderOutput struct {

	// The Amazon Resource Name (ARN) of the recommender you started.
	RecommenderArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopRecommenderInput added in v1.19.0 

type StopRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the recommender to stop.
	//
	// This member is required.
	RecommenderArn *string
	// contains filtered or unexported fields
}

type StopRecommenderOutput added in v1.19.0 

type StopRecommenderOutput struct {

	// The Amazon Resource Name (ARN) of the recommender you stopped.
	RecommenderArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopSolutionVersionCreationInput added in v1.5.0 

type StopSolutionVersionCreationInput struct {

	// The Amazon Resource Name (ARN) of the solution version you want to stop
	// creating.
	//
	// This member is required.
	SolutionVersionArn *string
	// contains filtered or unexported fields
}

type StopSolutionVersionCreationOutput added in v1.5.0 

type StopSolutionVersionCreationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput added in v1.18.0 

type TagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// Tags to apply to the resource. For more information see Tagging Personalize
	// resources
	// (https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html).
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.18.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v1.18.0 

type UntagResourceInput struct {

	// The resource's Amazon Resource Name (ARN).
	//
	// This member is required.
	ResourceArn *string

	// Keys to remove from the resource's tags.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.18.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCampaignInput 

type UpdateCampaignInput struct {

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// This member is required.
	CampaignArn *string

	// The configuration details of a campaign.
	CampaignConfig *types.CampaignConfig

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

	// The ARN of a new solution version to deploy.
	SolutionVersionArn *string
	// contains filtered or unexported fields
}

type UpdateCampaignOutput 

type UpdateCampaignOutput struct {

	// The same campaign ARN as given in the request.
	CampaignArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateRecommenderInput added in v1.12.0 

type UpdateRecommenderInput struct {

	// The Amazon Resource Name (ARN) of the recommender to modify.
	//
	// This member is required.
	RecommenderArn *string

	// The configuration details of the recommender.
	//
	// This member is required.
	RecommenderConfig *types.RecommenderConfig
	// contains filtered or unexported fields
}

type UpdateRecommenderOutput added in v1.12.0 

type UpdateRecommenderOutput struct {

	// The same recommender Amazon Resource Name (ARN) as given in the request.
	RecommenderArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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