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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EventsRequest

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  batch_item: { # required
    "__string" => {
      endpoint: { # required
        address: "__string",
        attributes: {
          "__string" => ["__string"],
        },
        channel_type: "PUSH", # accepts PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM, IN_APP
        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: { # required
        "__string" => {
          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 a batch of events to process.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_item ⇒ Hash<String,Types::EventsBatch>

  The batch of events to process.

Instance Attribute Details

#batch_item ⇒ Hash<String,Types::EventsBatch>

The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

Returns:

• (Hash<String,Types::EventsBatch>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8362

class EventsRequest < Struct.new(
  :batch_item)
  SENSITIVE = []
  include Aws::Structure
end