Class: Aws::Pinpoint::Types::EndpointResponse

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EndpointResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Endpoint response

See Also:

• AWS API Documentation

Instance Attribute Summary

• #address ⇒ String

  The address of the endpoint as provided by your push provider.

• #application_id ⇒ String

  The ID of the application that is associated with the endpoint.

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

  Custom attributes that describe the endpoint by associating a name with an array of values.

• #channel_type ⇒ String

  The channel type.

• #cohort_id ⇒ String

  A number from 0-99 that represents the cohort the endpoint is assigned to.

• #creation_date ⇒ String

  The date and time when the endpoint was created, shown in ISO 8601 format.

• #demographic ⇒ Types::EndpointDemographic

  The endpoint demographic attributes.

• #effective_date ⇒ String

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

• #endpoint_status ⇒ String

  Unused.

• #id ⇒ String

  The unique ID that you assigned to the endpoint.

• #location ⇒ Types::EndpointLocation

  The endpoint location attributes.

• #metrics ⇒ Hash<String,Float>

  Custom metrics that your app reports to Amazon Pinpoint.

• #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 of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.

Returns:

• (String)

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

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

#application_id ⇒ String

The ID of the application that is associated with the endpoint.

Returns:

• (String)

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

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

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

Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named “interests” might have the following values: [“science”, “politics”, “travel”]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can’t display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Returns:

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

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

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

• (String)

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

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

#cohort_id ⇒ String

A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.

Returns:

• (String)

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

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

#creation_date ⇒ String

The date and time when the endpoint was created, shown in ISO 8601 format.

Returns:

• (String)

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

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 4053

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

#effective_date ⇒ String

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

Returns:

• (String)

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

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

#endpoint_status ⇒ String

Unused.

Returns:

• (String)

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

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

#id ⇒ String

The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn’t conflict with other endpoint IDs associated with the application.

Returns:

• (String)

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

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 4053

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :demographic,
  :effective_date,
  :endpoint_status,
  :id,
  :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>)

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

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 4053

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 4053

class EndpointResponse < Struct.new(
  :address,
  :application_id,
  :attributes,
  :channel_type,
  :cohort_id,
  :creation_date,
  :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 4053

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