Class: Aws::Pinpoint::Types::PutEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::PutEventsRequest

Defined in:

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

Overview

Note:

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

{
  application_id: "__string", # required
  events_request: { # required
    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
          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
          },
        },
      },
    },
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String
• #events_request ⇒ Types::EventsRequest

  Specifies a batch of events to process.

Instance Attribute Details

#application_id ⇒ String

Returns:

• (String)

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

class PutEventsRequest < Struct.new(
  :application_id,
  :events_request)
  SENSITIVE = []
  include Aws::Structure
end

#events_request ⇒ Types::EventsRequest

Specifies a batch of events to process.

Returns:

• (Types::EventsRequest)

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

class PutEventsRequest < Struct.new(
  :application_id,
  :events_request)
  SENSITIVE = []
  include Aws::Structure
end