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

Class: Aws::Pinpoint::Types::EndpointBatchRequest

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

Overview

Note:

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

{
  item: [ # 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",
      id: "__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",
      },
    },
  ],
}

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#itemArray<Types::EndpointBatchItem>

An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

Returns:

  • (Array<Types::EndpointBatchItem>)

    An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change.