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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::PublicEndpoint

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Specifies the properties and attributes of an endpoint that’s associated with an event.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #address ⇒ String

  The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

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

  One or more custom attributes that describe the endpoint by associating a name with an array of values.

• #channel_type ⇒ String

  The channel that’s used when sending messages or push notifications to the endpoint.

• #demographic ⇒ Types::EndpointDemographic

  The demographic information for the endpoint, such as the time zone and platform.

• #effective_date ⇒ String

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

• #endpoint_status ⇒ String

  Specifies whether to send messages or push notifications to the endpoint.

• #location ⇒ Types::EndpointLocation

  The geographic information for the endpoint.

• #metrics ⇒ Hash<String,Float>

  One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

• #opt_out ⇒ String

  Specifies whether the user who’s associated with the endpoint has opted out of receiving messages and push notifications from you.

• #request_id ⇒ String

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

• #user ⇒ Types::EndpointUser

  One or more custom user attributes that your app reports to Amazon Pinpoint for the user who’s associated with the endpoint.

Instance Attribute Details

#address ⇒ String

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

Returns:

• (String)

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

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

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

One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

Returns:

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

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

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

#channel_type ⇒ String

The channel that’s used when sending messages or push notifications to the endpoint.

Returns:

• (String)

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

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

#demographic ⇒ Types::EndpointDemographic

The demographic information for the endpoint, such as the time zone and platform.

Returns:

• (Types::EndpointDemographic)

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

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

#effective_date ⇒ String

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

Returns:

• (String)

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

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

#endpoint_status ⇒ String

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

Returns:

• (String)

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

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

#location ⇒ Types::EndpointLocation

The geographic information for the endpoint.

Returns:

• (Types::EndpointLocation)

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

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

#metrics ⇒ Hash<String,Float>

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

Returns:

• (Hash<String,Float>)

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

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

#opt_out ⇒ String

Specifies whether the user who’s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn’t want to receive any messages or push notifications; and, NONE, the user hasn’t opted out and wants to receive all messages and push notifications.

Returns:

• (String)

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

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

#request_id ⇒ String

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

Returns:

• (String)

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

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

#user ⇒ Types::EndpointUser

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who’s associated with the endpoint.

Returns:

• (Types::EndpointUser)

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

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