aws-sdk-go: github.com/aws/aws-sdk-go/service/personalizeruntime Index | Files | Directories

package personalizeruntime

import "github.com/aws/aws-sdk-go/service/personalizeruntime"

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

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    ServiceName = "Personalize Runtime" // Name of service.
    EndpointsID = "personalize-runtime" // ID to lookup a service endpoint with.
    ServiceID   = "Personalize Runtime" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type GetPersonalizedRankingInput Uses

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

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

func (s GetPersonalizedRankingInput) GoString() string

GoString returns the string representation

func (*GetPersonalizedRankingInput) SetCampaignArn Uses

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

SetCampaignArn sets the CampaignArn field's value.

func (*GetPersonalizedRankingInput) SetInputList Uses

func (s *GetPersonalizedRankingInput) SetInputList(v []*string) *GetPersonalizedRankingInput

SetInputList sets the InputList field's value.

func (*GetPersonalizedRankingInput) SetUserId Uses

func (s *GetPersonalizedRankingInput) SetUserId(v string) *GetPersonalizedRankingInput

SetUserId sets the UserId field's value.

func (GetPersonalizedRankingInput) String Uses

func (s GetPersonalizedRankingInput) String() string

String returns the string representation

func (*GetPersonalizedRankingInput) Validate Uses

func (s *GetPersonalizedRankingInput) Validate() error

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

type GetPersonalizedRankingOutput Uses

type GetPersonalizedRankingOutput struct {

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

func (GetPersonalizedRankingOutput) GoString Uses

func (s GetPersonalizedRankingOutput) GoString() string

GoString returns the string representation

func (*GetPersonalizedRankingOutput) SetPersonalizedRanking Uses

func (s *GetPersonalizedRankingOutput) SetPersonalizedRanking(v []*PredictedItem) *GetPersonalizedRankingOutput

SetPersonalizedRanking sets the PersonalizedRanking field's value.

func (GetPersonalizedRankingOutput) String Uses

func (s GetPersonalizedRankingOutput) String() string

String returns the string representation

type GetRecommendationsInput Uses

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 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 100.
    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 Uses

func (s GetRecommendationsInput) GoString() string

GoString returns the string representation

func (*GetRecommendationsInput) SetCampaignArn Uses

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

SetCampaignArn sets the CampaignArn field's value.

func (*GetRecommendationsInput) SetItemId Uses

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

SetItemId sets the ItemId field's value.

func (*GetRecommendationsInput) SetNumResults Uses

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

SetNumResults sets the NumResults field's value.

func (*GetRecommendationsInput) SetUserId Uses

func (s *GetRecommendationsInput) SetUserId(v string) *GetRecommendationsInput

SetUserId sets the UserId field's value.

func (GetRecommendationsInput) String Uses

func (s GetRecommendationsInput) String() string

String returns the string representation

func (*GetRecommendationsInput) Validate Uses

func (s *GetRecommendationsInput) Validate() error

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

type GetRecommendationsOutput Uses

type GetRecommendationsOutput struct {

    // A list of recommendations.
    ItemList []*PredictedItem `locationName:"itemList" type:"list"`
    // contains filtered or unexported fields
}

func (GetRecommendationsOutput) GoString Uses

func (s GetRecommendationsOutput) GoString() string

GoString returns the string representation

func (*GetRecommendationsOutput) SetItemList Uses

func (s *GetRecommendationsOutput) SetItemList(v []*PredictedItem) *GetRecommendationsOutput

SetItemList sets the ItemList field's value.

func (GetRecommendationsOutput) String Uses

func (s GetRecommendationsOutput) String() string

String returns the string representation

type PersonalizeRuntime Uses

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 Uses

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

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:

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

func (c *PersonalizeRuntime) GetPersonalizedRanking(input *GetPersonalizedRankingInput) (*GetPersonalizedRankingOutput, error)

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 Codes:

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

* ErrCodeResourceNotFoundException "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 Uses

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 Uses

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 Uses

func (c *PersonalizeRuntime) GetRecommendations(input *GetRecommendationsInput) (*GetRecommendationsOutput, error)

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 Codes:

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

* ErrCodeResourceNotFoundException "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 Uses

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 Uses

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 Uses

type PredictedItem struct {

    // The recommended item ID.
    ItemId *string `locationName:"itemId" type:"string"`
    // contains filtered or unexported fields
}

An object that identifies an item.

The and APIs return a list of PredictedItems.

func (PredictedItem) GoString Uses

func (s PredictedItem) GoString() string

GoString returns the string representation

func (*PredictedItem) SetItemId Uses

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

SetItemId sets the ItemId field's value.

func (PredictedItem) String Uses

func (s PredictedItem) String() string

String returns the string representation

Directories

PathSynopsis
personalizeruntimeifacePackage personalizeruntimeiface provides an interface to enable mocking the Amazon Personalize Runtime service client for testing your code.

Package personalizeruntime imports 7 packages (graph) and is imported by 7 packages. Updated 2019-10-30. Refresh now. Tools for package owners.