Documentation
¶
Overview ¶
Package mobileanalytics provides a client for Amazon Mobile Analytics.
Index ¶
Examples ¶
Constants ¶
const ServiceName = "mobileanalytics"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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.
type MobileAnalytics ¶
Amazon Mobile Analytics is a service for collecting, visualizing, and understanding app usage data at scale. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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:
- BadRequestException An exception object returned when a request fails.
Example ¶
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
package main
import (
"bytes"
"fmt"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/mobileanalytics"
)
var _ time.Duration
var _ bytes.Buffer
func main() {
sess, err := session.NewSession()
if err != nil {
fmt.Println("failed to create session,", err)
return
}
svc := mobileanalytics.New(sess)
params := &mobileanalytics.PutEventsInput{
ClientContext: aws.String("String"), // Required
Events: []*mobileanalytics.Event{ // Required
{ // Required
EventType: aws.String("String50Chars"), // Required
Timestamp: aws.String("ISO8601Timestamp"), // Required
Attributes: map[string]*string{
"Key": aws.String("String0to1000Chars"), // Required
// More values...
},
Metrics: map[string]*float64{
"Key": aws.Float64(1.0), // Required
// More values...
},
Session: &mobileanalytics.Session{
Duration: aws.Int64(1),
Id: aws.String("String50Chars"),
StartTimestamp: aws.String("ISO8601Timestamp"),
StopTimestamp: aws.String("ISO8601Timestamp"),
},
Version: aws.String("String10Chars"),
},
// More values...
},
ClientContextEncoding: aws.String("String"),
}
resp, err := svc.PutEvents(params)
if err != nil {
// Print the error, cast err to awserr.Error to get the Code and
// Message from an error.
fmt.Println(err.Error())
return
}
// Pretty-print the response data.
fmt.Println(resp)
}
Output:
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 can be used to capture response data after the request's "Send" method is called.
See PutEvents for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutEvents method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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)
}
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) 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) 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.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package mobileanalyticsiface provides an interface to enable mocking the Amazon Mobile Analytics service client for testing your code.
|
Package mobileanalyticsiface provides an interface to enable mocking the Amazon Mobile Analytics service client for testing your code. |