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

Class: Aws::Pinpoint::Types::EventsBatch

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

Overview

Note:

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

{
  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
    },
  },
}

Specifies a batch of endpoints and events to process.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint ⇒ Types::PublicEndpoint

A set of properties and attributes that are associated with the endpoint.

Returns:

#events ⇒ Hash<String,Types::Event>

A set of properties that are associated with the event.

Returns:

  • (Hash<String,Types::Event>) —

    A set of properties that are associated with the event.