AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::Event

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Event as input to an Aws::Client method, you can use a vanilla Hash:

{
  app_package_name: "__string",
  app_title: "__string",
  app_version_code: "__string",
  attributes: {
    "__string" => "__string",
  },
  client_sdk_version: "__string",
  event_type: "__string", # required
  metrics: {
    "__string" => 1.0,
  },
  sdk_name: "__string",
  session: {
    duration: 1,
    id: "__string", # required
    start_timestamp: "__string", # required
    stop_timestamp: "__string",
  },
  timestamp: "__string", # required
}

Specifies information about an event that reports data to Amazon Pinpoint.

Instance Attribute Summary collapse

Instance Attribute Details

#app_package_nameString

The package name of the app that\'s recording the event.

Returns:

  • (String)

    The package name of the app that\'s recording the event.

#app_titleString

The title of the app that\'s recording the event.

Returns:

  • (String)

    The title of the app that\'s recording the event.

#app_version_codeString

The version number of the app that\'s recording the event.

Returns:

  • (String)

    The version number of the app that\'s recording the event.

#attributesHash<String,String>

One or more custom attributes that are associated with the event.

Returns:

  • (Hash<String,String>)

    One or more custom attributes that are associated with the event.

#client_sdk_versionString

The version of the SDK that\'s running on the client device.

Returns:

  • (String)

    The version of the SDK that\'s running on the client device.

#event_typeString

The name of the event.

Returns:

  • (String)

    The name of the event.

#metricsHash<String,Float>

One or more custom metrics that are associated with the event.

Returns:

  • (Hash<String,Float>)

    One or more custom metrics that are associated with the event.

#sdk_nameString

The name of the SDK that\'s being used to record the event.

Returns:

  • (String)

    The name of the SDK that\'s being used to record the event.

#sessionTypes::Session

Information about the session in which the event occurred.

Returns:

  • (Types::Session)

    Information about the session in which the event occurred.

#timestampString

The date and time, in ISO 8601 format, when the event occurred.

Returns:

  • (String)

    The date and time, in ISO 8601 format, when the event occurred.