Class: Aws::Pinpoint::Types::EventsRequest

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 EventsRequest data as a hash:

{
  batch_item: {
    "__string" => {
      endpoint: {
        address: "__string",
        attributes: {
          "__string" => ["__string"],
        },
        channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
        demographic: {
          app_version: "__string",
          locale: "__string",
          make: "__string",
          model: "__string",
          model_version: "__string",
          platform: "__string",
          platform_version: "__string",
          timezone: "__string",
        },
        effective_date: "__string",
        endpoint_status: "__string",
        location: {
          city: "__string",
          country: "__string",
          latitude: 1.0,
          longitude: 1.0,
          postal_code: "__string",
          region: "__string",
        },
        metrics: {
          "__string" => 1.0,
        },
        opt_out: "__string",
        request_id: "__string",
        user: {
          user_attributes: {
            "__string" => ["__string"],
          },
          user_id: "__string",
        },
      },
      events: {
        "__string" => {
          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",
        },
      },
    },
  },
}

A set of events to process.

Instance Attribute Summary collapse

Instance Attribute Details

#batch_itemHash<String,Types::EventsBatch>

A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value.

Returns:



4512
4513
4514
4515
# File 'lib/aws-sdk-pinpoint/types.rb', line 4512

class EventsRequest < Struct.new(
  :batch_item)
  include Aws::Structure
end