Documentation

Overview

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

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

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

Using the Client

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

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

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

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

Index

Constants

View Source
const (

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

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

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type GetPersonalizedRankingInput

type GetPersonalizedRankingInput struct {

	// The Amazon Resource Name (ARN) of the campaign to use for generating the
	// personalized ranking.
	//
	// CampaignArn is a required field
	CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`

	// The contextual metadata to use when getting recommendations. Contextual metadata
	// includes any interaction information that might be relevant when getting
	// a user's recommendations, such as the user's current location or device type.
	Context map[string]*string `locationName:"context" type:"map"`

	// A list of items (itemId's) to rank. If an item was not included in the training
	// dataset, the item is appended to the end of the reranked list. The maximum
	// is 500.
	//
	// InputList is a required field
	InputList []*string `locationName:"inputList" type:"list" required:"true"`

	// The user for which you want the campaign to provide a personalized ranking.
	//
	// UserId is a required field
	UserId *string `locationName:"userId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPersonalizedRankingInput) GoString

func (s GetPersonalizedRankingInput) GoString() string

GoString returns the string representation

func (*GetPersonalizedRankingInput) SetCampaignArn

SetCampaignArn sets the CampaignArn field's value.

func (*GetPersonalizedRankingInput) SetContext

SetContext sets the Context field's value.

func (*GetPersonalizedRankingInput) SetInputList

SetInputList sets the InputList field's value.

func (*GetPersonalizedRankingInput) SetUserId

SetUserId sets the UserId field's value.

func (GetPersonalizedRankingInput) String

String returns the string representation

func (*GetPersonalizedRankingInput) Validate

func (s *GetPersonalizedRankingInput) Validate() error

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

type GetPersonalizedRankingOutput

type GetPersonalizedRankingOutput struct {

	// A list of items in order of most likely interest to the user. The maximum
	// is 500.
	PersonalizedRanking []*PredictedItem `locationName:"personalizedRanking" type:"list"`
	// contains filtered or unexported fields
}

func (GetPersonalizedRankingOutput) GoString

func (s GetPersonalizedRankingOutput) GoString() string

GoString returns the string representation

func (*GetPersonalizedRankingOutput) SetPersonalizedRanking

SetPersonalizedRanking sets the PersonalizedRanking field's value.

func (GetPersonalizedRankingOutput) String

String returns the string representation

type GetRecommendationsInput

type GetRecommendationsInput struct {

	// The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
	//
	// CampaignArn is a required field
	CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"`

	// The contextual metadata to use when getting recommendations. Contextual metadata
	// includes any interaction information that might be relevant when getting
	// a user's recommendations, such as the user's current location or device type.
	Context map[string]*string `locationName:"context" type:"map"`

	// The ARN of the filter to apply to the returned recommendations. For more
	// information, see Using Filters with Amazon Personalize.
	FilterArn *string `locationName:"filterArn" type:"string"`

	// The item ID to provide recommendations for.
	//
	// Required for RELATED_ITEMS recipe type.
	ItemId *string `locationName:"itemId" type:"string"`

	// The number of results to return. The default is 25. The maximum is 500.
	NumResults *int64 `locationName:"numResults" type:"integer"`

	// The user ID to provide recommendations for.
	//
	// Required for USER_PERSONALIZATION recipe type.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

func (GetRecommendationsInput) GoString

func (s GetRecommendationsInput) GoString() string

GoString returns the string representation

func (*GetRecommendationsInput) SetCampaignArn

SetCampaignArn sets the CampaignArn field's value.

func (*GetRecommendationsInput) SetContext

SetContext sets the Context field's value.

func (*GetRecommendationsInput) SetFilterArn

SetFilterArn sets the FilterArn field's value.

func (*GetRecommendationsInput) SetItemId

SetItemId sets the ItemId field's value.

func (*GetRecommendationsInput) SetNumResults

SetNumResults sets the NumResults field's value.

func (*GetRecommendationsInput) SetUserId

SetUserId sets the UserId field's value.

func (GetRecommendationsInput) String

func (s GetRecommendationsInput) String() string

String returns the string representation

func (*GetRecommendationsInput) Validate

func (s *GetRecommendationsInput) Validate() error

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

type GetRecommendationsOutput

type GetRecommendationsOutput struct {

	// A list of recommendations sorted in ascending order by prediction score.
	// There can be a maximum of 500 items in the list.
	ItemList []*PredictedItem `locationName:"itemList" type:"list"`
	// contains filtered or unexported fields
}

func (GetRecommendationsOutput) GoString

func (s GetRecommendationsOutput) GoString() string

GoString returns the string representation

func (*GetRecommendationsOutput) SetItemList

SetItemList sets the ItemList field's value.

func (GetRecommendationsOutput) String

func (s GetRecommendationsOutput) String() string

String returns the string representation

type InvalidInputException

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

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

Provide a valid value for the field or parameter.

func (*InvalidInputException) Code

func (s *InvalidInputException) Code() string

Code returns the exception type name.

func (*InvalidInputException) Error

func (s *InvalidInputException) Error() string

func (InvalidInputException) GoString

func (s InvalidInputException) GoString() string

GoString returns the string representation

func (*InvalidInputException) Message

func (s *InvalidInputException) Message() string

Message returns the exception's message.

func (*InvalidInputException) OrigErr

func (s *InvalidInputException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInputException) RequestID

func (s *InvalidInputException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInputException) StatusCode

func (s *InvalidInputException) StatusCode() int

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

func (InvalidInputException) String

func (s InvalidInputException) String() string

String returns the string representation

type PersonalizeRuntime

type PersonalizeRuntime struct {
	*client.Client
}

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

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

func New

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

Example:

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

// Create a PersonalizeRuntime client from just a session.
svc := personalizeruntime.New(mySession)

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

func (*PersonalizeRuntime) GetPersonalizedRanking

GetPersonalizedRanking API operation for Amazon Personalize Runtime.

Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.

The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.

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

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

Returned Error Types:

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

* ResourceNotFoundException
The specified resource does not exist.

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

func (*PersonalizeRuntime) GetPersonalizedRankingRequest

func (c *PersonalizeRuntime) GetPersonalizedRankingRequest(input *GetPersonalizedRankingInput) (req *request.Request, output *GetPersonalizedRankingOutput)

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

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

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

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

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

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

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

func (*PersonalizeRuntime) GetPersonalizedRankingWithContext

func (c *PersonalizeRuntime) GetPersonalizedRankingWithContext(ctx aws.Context, input *GetPersonalizedRankingInput, opts ...request.Option) (*GetPersonalizedRankingOutput, error)

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

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

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

func (*PersonalizeRuntime) GetRecommendations

GetRecommendations API operation for Amazon Personalize Runtime.

Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

* RELATED_ITEMS - itemId required, userId not used

* USER_PERSONALIZATION - itemId optional, userId required

Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

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

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

Returned Error Types:

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

* ResourceNotFoundException
The specified resource does not exist.

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

func (*PersonalizeRuntime) GetRecommendationsRequest

func (c *PersonalizeRuntime) GetRecommendationsRequest(input *GetRecommendationsInput) (req *request.Request, output *GetRecommendationsOutput)

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

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

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

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

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

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

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

func (*PersonalizeRuntime) GetRecommendationsWithContext

func (c *PersonalizeRuntime) GetRecommendationsWithContext(ctx aws.Context, input *GetRecommendationsInput, opts ...request.Option) (*GetRecommendationsOutput, error)

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

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

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

type PredictedItem

type PredictedItem struct {

	// The recommended item ID.
	ItemId *string `locationName:"itemId" type:"string"`

	// A numeric representation of the model's certainty that the item will be the
	// next user selection. For more information on scoring logic, see how-scores-work.
	Score *float64 `locationName:"score" type:"double"`
	// contains filtered or unexported fields
}

An object that identifies an item.

The and APIs return a list of PredictedItems.

func (PredictedItem) GoString

func (s PredictedItem) GoString() string

GoString returns the string representation

func (*PredictedItem) SetItemId

func (s *PredictedItem) SetItemId(v string) *PredictedItem

SetItemId sets the ItemId field's value.

func (*PredictedItem) SetScore

func (s *PredictedItem) SetScore(v float64) *PredictedItem

SetScore sets the Score field's value.

func (PredictedItem) String

func (s PredictedItem) String() string

String returns the string representation

type ResourceNotFoundException

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

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

The specified resource does not exist.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

Directories

Path Synopsis
Package personalizeruntimeiface provides an interface to enable mocking the Amazon Personalize Runtime service client for testing your code.
Package personalizeruntimeiface provides an interface to enable mocking the Amazon Personalize Runtime service client for testing your code.