mobileanalytics

Documentation

Overview

Package mobileanalytics provides the client and types for making API requests to Amazon Mobile Analytics.

Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale.

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

Using the Client

To Amazon Mobile Analytics 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 Mobile Analytics client MobileAnalytics for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mobileanalytics/#New

Index

• Constants
• type Event
  • func (s Event) GoString() string
  • func (s *Event) MarshalFields(e protocol.FieldEncoder) error
  • func (s *Event) SetAttributes(v map[string]*string) *Event
  • func (s *Event) SetEventType(v string) *Event
  • func (s *Event) SetMetrics(v map[string]*float64) *Event
  • func (s *Event) SetSession(v *Session) *Event
  • func (s *Event) SetTimestamp(v string) *Event
  • func (s *Event) SetVersion(v string) *Event
  • func (s Event) String() string
  • func (s *Event) Validate() error
• type MobileAnalytics
  • func New(p client.ConfigProvider, cfgs ...*aws.Config) *MobileAnalytics
  • func (c *MobileAnalytics) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)
  • func (c *MobileAnalytics) PutEventsRequest(input *PutEventsInput) (req *request.Request, output *PutEventsOutput)
  • func (c *MobileAnalytics) PutEventsWithContext(ctx aws.Context, input *PutEventsInput, opts ...request.Option) (*PutEventsOutput, error)
• type PutEventsInput
  • func (s PutEventsInput) GoString() string
  • func (s *PutEventsInput) MarshalFields(e protocol.FieldEncoder) error
  • func (s *PutEventsInput) SetClientContext(v string) *PutEventsInput
  • func (s *PutEventsInput) SetClientContextEncoding(v string) *PutEventsInput
  • func (s *PutEventsInput) SetEvents(v []*Event) *PutEventsInput
  • func (s PutEventsInput) String() string
  • func (s *PutEventsInput) Validate() error
• type PutEventsOutput
  • func (s PutEventsOutput) GoString() string
  • func (s *PutEventsOutput) MarshalFields(e protocol.FieldEncoder) error
  • func (s PutEventsOutput) String() string
• type Session
  • func (s Session) GoString() string
  • func (s *Session) MarshalFields(e protocol.FieldEncoder) error
  • func (s *Session) SetDuration(v int64) *Session
  • func (s *Session) SetId(v string) *Session
  • func (s *Session) SetStartTimestamp(v string) *Session
  • func (s *Session) SetStopTimestamp(v string) *Session
  • func (s Session) String() string
  • func (s *Session) Validate() error

Constants

const (
	ServiceName = "mobileanalytics" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName       // Service ID for Regions and Endpoints metadata.
)

Service information constants

const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// An exception object returned when a request fails.
	ErrCodeBadRequestException = "BadRequestException"
)

Types

type Event

type Event struct {

	// A collection of key-value pairs that give additional context to the event.
	// The key-value pairs are specified by the developer.
	//
	// This collection can be empty or the attribute object can be omitted.
	Attributes map[string]*string `locationName:"attributes" type:"map"`

	// A name signifying an event that occurred in your app. This is used for grouping
	// and aggregating like events together for reporting purposes.
	//
	// EventType is a required field
	EventType *string `locationName:"eventType" min:"1" type:"string" required:"true"`

	// A collection of key-value pairs that gives additional, measurable context
	// to the event. The key-value pairs are specified by the developer.
	//
	// This collection can be empty or the attribute object can be omitted.
	Metrics map[string]*float64 `locationName:"metrics" type:"map"`

	// The session the event occured within.
	Session *Session `locationName:"session" type:"structure"`

	// The time the event occurred in ISO 8601 standard date time format. For example,
	// 2014-06-30T19:07:47.885Z
	//
	// Timestamp is a required field
	Timestamp *string `locationName:"timestamp" type:"string" required:"true"`

	// The version of the event.
	Version *string `locationName:"version" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A JSON object representing a batch of unique event occurrences in your app.

func (Event) GoString

func (s Event) GoString() string

GoString returns the string representation

func (*Event) MarshalFields

func (s *Event) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (*Event) SetAttributes

func (s *Event) SetAttributes(v map[string]*string) *Event

SetAttributes sets the Attributes field's value.

func (*Event) SetEventType

func (s *Event) SetEventType(v string) *Event

SetEventType sets the EventType field's value.

func (*Event) SetMetrics

func (s *Event) SetMetrics(v map[string]*float64) *Event

SetMetrics sets the Metrics field's value.

func (*Event) SetSession

func (s *Event) SetSession(v *Session) *Event

SetSession sets the Session field's value.

func (*Event) SetTimestamp

func (s *Event) SetTimestamp(v string) *Event

SetTimestamp sets the Timestamp field's value.

func (*Event) SetVersion

func (s *Event) SetVersion(v string) *Event

SetVersion sets the Version field's value.

func (Event) String

func (s Event) String() string

String returns the string representation

func (*Event) Validate

func (s *Event) Validate() error

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

type MobileAnalytics

type MobileAnalytics struct {
	*client.Client
}

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

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

func New

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

New creates a new instance of the MobileAnalytics 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 MobileAnalytics client from just a session.
svc := mobileanalytics.New(mySession)

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

func (*MobileAnalytics) PutEvents

func (c *MobileAnalytics) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)

PutEvents API operation for Amazon Mobile Analytics.

The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values.

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 Mobile Analytics's API operation PutEvents for usage and error information.

Returned Error Codes:

• ErrCodeBadRequestException "BadRequestException" An exception object returned when a request fails.

func (*MobileAnalytics) PutEventsRequest

func (c *MobileAnalytics) PutEventsRequest(input *PutEventsInput) (req *request.Request, output *PutEventsOutput)

PutEventsRequest generates a "aws/request.Request" representing the client's request for the PutEvents operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 PutEvents for more information on using the PutEvents 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 PutEventsRequest method.
req, resp := client.PutEventsRequest(params)

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

func (*MobileAnalytics) PutEventsWithContext

func (c *MobileAnalytics) PutEventsWithContext(ctx aws.Context, input *PutEventsInput, opts ...request.Option) (*PutEventsOutput, error)

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

See PutEvents 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 PutEventsInput

type PutEventsInput struct {

	// The client context including the client ID, app title, app version and package
	// name.
	//
	// ClientContext is a required field
	ClientContext *string `location:"header" locationName:"x-amz-Client-Context" type:"string" required:"true"`

	// The encoding used for the client context.
	ClientContextEncoding *string `location:"header" locationName:"x-amz-Client-Context-Encoding" type:"string"`

	// An array of Event JSON objects
	//
	// Events is a required field
	Events []*Event `locationName:"events" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A container for the data needed for a PutEvent operation

func (PutEventsInput) GoString

func (s PutEventsInput) GoString() string

GoString returns the string representation

func (*PutEventsInput) MarshalFields

func (s *PutEventsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (*PutEventsInput) SetClientContext

func (s *PutEventsInput) SetClientContext(v string) *PutEventsInput

SetClientContext sets the ClientContext field's value.

func (*PutEventsInput) SetClientContextEncoding

func (s *PutEventsInput) SetClientContextEncoding(v string) *PutEventsInput

SetClientContextEncoding sets the ClientContextEncoding field's value.

func (*PutEventsInput) SetEvents

func (s *PutEventsInput) SetEvents(v []*Event) *PutEventsInput

SetEvents sets the Events field's value.

func (PutEventsInput) String

func (s PutEventsInput) String() string

String returns the string representation

func (*PutEventsInput) Validate

func (s *PutEventsInput) Validate() error

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

type PutEventsOutput

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

func (PutEventsOutput) GoString

func (s PutEventsOutput) GoString() string

GoString returns the string representation

func (*PutEventsOutput) MarshalFields

func (s *PutEventsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutEventsOutput) String

func (s PutEventsOutput) String() string

String returns the string representation

type Session

type Session struct {

	// The duration of the session.
	Duration *int64 `locationName:"duration" type:"long"`

	// A unique identifier for the session
	Id *string `locationName:"id" min:"1" type:"string"`

	// The time the event started in ISO 8601 standard date time format. For example,
	// 2014-06-30T19:07:47.885Z
	StartTimestamp *string `locationName:"startTimestamp" type:"string"`

	// The time the event terminated in ISO 8601 standard date time format. For
	// example, 2014-06-30T19:07:47.885Z
	StopTimestamp *string `locationName:"stopTimestamp" type:"string"`
	// contains filtered or unexported fields
}

Describes the session. Session information is required on ALL events.

func (Session) GoString

func (s Session) GoString() string

GoString returns the string representation

func (*Session) MarshalFields

func (s *Session) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (*Session) SetDuration

func (s *Session) SetDuration(v int64) *Session

SetDuration sets the Duration field's value.

func (*Session) SetId

func (s *Session) SetId(v string) *Session

SetId sets the Id field's value.

func (*Session) SetStartTimestamp

func (s *Session) SetStartTimestamp(v string) *Session

SetStartTimestamp sets the StartTimestamp field's value.

func (*Session) SetStopTimestamp

func (s *Session) SetStopTimestamp(v string) *Session

SetStopTimestamp sets the StopTimestamp field's value.

func (Session) String

func (s Session) String() string

String returns the string representation

func (*Session) Validate

func (s *Session) Validate() error

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