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

Instance Attribute Summary

• #address ⇒ String

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

• #application_id ⇒ String

  The ID of the application associated with the endpoint.

• #attributes ⇒ Hash<String,Array<String>>
• #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 last time the endpoint was created.

• #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 that you assigned to the endpoint.

• #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.

• #shard_id ⇒ String
• #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 2086

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#application_id ⇒ String

The ID of the application associated with the endpoint.

Returns:

• (String)

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

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,
  :shard_id,
  :user)
  include Aws::Structure
end

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

Returns:

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

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

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,
  :shard_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 2086

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,
  :shard_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 2086

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#creation_date ⇒ String

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

Returns:

• (String)

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

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#demographic ⇒ Types::EndpointDemographic

The endpoint demographic attributes.

Returns:

• (Types::EndpointDemographic)

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

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,
  :shard_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 2086

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,
  :shard_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 2086

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,
  :shard_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 is unique compared to all other endpoints for the application.

Returns:

• (String)

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

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#location ⇒ Types::EndpointLocation

The endpoint location attributes.

Returns:

• (Types::EndpointLocation)

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

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#metrics ⇒ Hash<String,Float>

Returns:

• (Hash<String,Float>)

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

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,
  :shard_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 2086

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,
  :shard_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 2086

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,
  :shard_id,
  :user)
  include Aws::Structure
end

#shard_id ⇒ String

Returns:

• (String)

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

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,
  :shard_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 2086

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,
  :shard_id,
  :user)
  include Aws::Structure
end