You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Endpoint response

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

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

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_idString

The ID of the application associated with the endpoint.

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#attributesHash<String,Array<String>>

Returns:

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


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_typeString

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

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_idString

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)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_dateString

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

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#demographicTypes::EndpointDemographic

The endpoint demographic attributes.



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_dateString

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

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_statusString

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)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#idString

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)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#locationTypes::EndpointLocation

The endpoint location attributes.



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#metricsHash<String,Float>

Returns:

  • (Hash<String,Float>)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_outString

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)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_idString

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

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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_idString

Returns:

  • (String)


2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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

#userTypes::EndpointUser

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

Returns:



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
# File 'gems/aws-sdk-pinpoint/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