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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EndpointBatchRequest

Defined in:

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

Overview

Note:

When making an API call, you may pass EndpointBatchRequest data as a 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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #item ⇒ Array<Types::EndpointBatchItem>

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

Instance Attribute Details

#item ⇒ Array<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>)

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

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