Documentation

Overview

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

    Amazon Personalize can consume real-time user event data, such as stream or click data, and use it for model training either alone or combined with historical data. For more information see recording-events.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-03-22"
    View Source
    const ServiceID = "Personalize Events"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

                func (c *Client) PutEvents(ctx context.Context, params *PutEventsInput, optFns ...func(*Options)) (*PutEventsOutput, error)

                  Records user interaction event data. For more information see event-record-api.

                  func (*Client) PutItems

                  func (c *Client) PutItems(ctx context.Context, params *PutItemsInput, optFns ...func(*Options)) (*PutItemsOutput, error)

                    Adds one or more items to an Items dataset. For more information see importing-items.

                    func (*Client) PutUsers

                    func (c *Client) PutUsers(ctx context.Context, params *PutUsersInput, optFns ...func(*Options)) (*PutUsersOutput, error)

                      Adds one or more users to a Users dataset. For more information see importing-users.

                      type EndpointResolver

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

                        EndpointResolver interface for resolving service endpoints.

                        func EndpointResolverFromURL

                        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

                            type EndpointResolverOptions = internalendpoints.Options

                              EndpointResolverOptions is the service endpoint resolver options

                              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 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 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
                              
                              	// Retryer guides how HTTP requests should be retried in case of recoverable
                              	// failures. When nil the API client will use a default retryer.
                              	Retryer aws.Retryer
                              
                              	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                              	// implementation if nil.
                              	HTTPClient HTTPClient
                              }

                              func (Options) Copy

                              func (o Options) Copy() Options

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

                                type PutEventsInput

                                type PutEventsInput struct {
                                
                                	// A list of event data from the session.
                                	//
                                	// This member is required.
                                	EventList []types.Event
                                
                                	// The session ID associated with the user's visit. Your application generates the
                                	// sessionId when a user first visits your website or uses your application. Amazon
                                	// Personalize uses the sessionId to associate events with the user before they log
                                	// in. For more information see event-record-api.
                                	//
                                	// This member is required.
                                	SessionId *string
                                
                                	// The tracking ID for the event. The ID is generated by a call to the
                                	// CreateEventTracker
                                	// (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)
                                	// API.
                                	//
                                	// This member is required.
                                	TrackingId *string
                                
                                	// The user associated with the event.
                                	UserId *string
                                }

                                type PutEventsOutput

                                type PutEventsOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type PutItemsInput

                                type PutItemsInput struct {
                                
                                	// The Amazon Resource Number (ARN) of the Items dataset you are adding the item or
                                	// items to.
                                	//
                                	// This member is required.
                                	DatasetArn *string
                                
                                	// A list of item data.
                                	//
                                	// This member is required.
                                	Items []types.Item
                                }

                                type PutItemsOutput

                                type PutItemsOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type PutUsersInput

                                type PutUsersInput struct {
                                
                                	// The Amazon Resource Number (ARN) of the Users dataset you are adding the user or
                                	// users to.
                                	//
                                	// This member is required.
                                	DatasetArn *string
                                
                                	// A list of user data.
                                	//
                                	// This member is required.
                                	Users []types.User
                                }

                                type PutUsersOutput

                                type PutUsersOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type ResolveEndpoint

                                type ResolveEndpoint struct {
                                	Resolver EndpointResolver
                                	Options  EndpointResolverOptions
                                }

                                func (*ResolveEndpoint) HandleSerialize

                                func (*ResolveEndpoint) ID

                                func (*ResolveEndpoint) ID() string

                                Directories

                                Path Synopsis
                                internal