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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass Event data as a hash:

{
  attributes: {
    "__string" => "__string",
  },
  client_sdk_version: "__string",
  event_type: "__string",
  metrics: {
    "__string" => 1.0,
  },
  session: {
    duration: 1,
    id: "__string",
    start_timestamp: "__string",
    stop_timestamp: "__string",
  },
  timestamp: "__string",
}

Model for creating or updating events.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Custom attributes that are associated with the event you’re adding or updating.

Returns:

  • (Hash<String,String>) 


4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end

#client_sdk_version ⇒ String

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

Returns:

  • (String) 


4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end

#event_type ⇒ String

The name of the custom event that you’re recording.

Returns:

  • (String) 


4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end

#metrics ⇒ Hash<String,Float>

Custom metrics related to the event.

Returns:

  • (Hash<String,Float>) 


4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end

#session ⇒ Types::Session

Information about the session in which the event occurred.

Returns:



4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end

#timestamp ⇒ String

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

Returns:

  • (String) 


4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4226

class Event < Struct.new(
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :session,
  :timestamp)
  include Aws::Structure
end