Class: Aws::Pinpoint::Types::PublicEndpoint

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

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

Public endpoint attributes.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String

The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.

Returns:

  • (String) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

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

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.

Returns:

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


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#channel_type ⇒ String

The channel type. Valid values: APNS, GCM

Returns:

  • (String) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#demographic ⇒ Types::EndpointDemographic

The endpoint demographic attributes.

Returns:



7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#effective_date ⇒ String

The date and time when the endpoint was last updated, in ISO 8601 format.

Returns:

  • (String) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#endpoint_status ⇒ String

The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.

Returns:

  • (String) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#location ⇒ Types::EndpointLocation

The endpoint location attributes.

Returns:



7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#metrics ⇒ Hash<String,Float>

Custom metrics that your app reports to Amazon Pinpoint.

Returns:

  • (Hash<String,Float>) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

class PublicEndpoint < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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

#request_id ⇒ String

A unique identifier that is generated each time the endpoint is updated.

Returns:

  • (String) 


7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

class PublicEndpoint < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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:



7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 7184

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