Class: Aws::Pinpoint::Types::EndpointBatchItem

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EndpointBatchItem

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  address: "__string",
  attributes: {
    "__string" => ["__string"],
  },
  channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, ADM, SMS, EMAIL
  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",
  },
}

Endpoint update request

Instance Attribute Summary

• #address ⇒ String

  The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

• #attributes ⇒ Hash<String,Array<String>>
• #channel_type ⇒ String

  The channel type.

• #demographic ⇒ Types::EndpointDemographic

  The endpoint demographic attributes.

• #effective_date ⇒ String

  The last time the endpoint was updated.

• #endpoint_status ⇒ String

  The endpoint status.

• #id ⇒ String

  The unique Id for the Endpoint in the batch.

• #location ⇒ Types::EndpointLocation

  The endpoint location attributes.

• #metrics ⇒ Hash<String,Float>
• #opt_out ⇒ String

  Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.

• #request_id ⇒ String

  The unique ID for the most recent request to update the endpoint.

• #user ⇒ Types::EndpointUser

  Custom user-specific attributes that your app reports to Amazon Pinpoint.

Instance Attribute Details

#address ⇒ String

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#attributes ⇒ Hash<String,Array<String>>

Returns:

• (Hash<String,Array<String>>)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#channel_type ⇒ String

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#demographic ⇒ Types::EndpointDemographic

The endpoint demographic attributes.

Returns:

• (Types::EndpointDemographic)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#effective_date ⇒ String

The last time the endpoint was updated. Provided in ISO 8601 format.

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#endpoint_status ⇒ String

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#id ⇒ String

The unique Id for the Endpoint in the batch.

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#location ⇒ Types::EndpointLocation

The endpoint location attributes.

Returns:

• (Types::EndpointLocation)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#metrics ⇒ Hash<String,Float>

Returns:

• (Hash<String,Float>)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#opt_out ⇒ String

Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#request_id ⇒ String

The unique ID for the most recent request to update the endpoint.

Returns:

• (String)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end

#user ⇒ Types::EndpointUser

Custom user-specific attributes that your app reports to Amazon Pinpoint.

Returns:

• (Types::EndpointUser)

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

class EndpointBatchItem < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :location,
  :metrics,
  :opt_out,
  :request_id,
  :user)
  include Aws::Structure
end