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

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_idString

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

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#attributesHash<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>>)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_typeString

The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_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)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_dateString

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

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#demographicTypes::EndpointDemographic

The endpoint demographic attributes.



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_dateString

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

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_statusString

Unused.

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#idString

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)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#locationTypes::EndpointLocation

The endpoint location attributes.



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#metricsHash<String,Float>

Custom metrics that your app reports to Amazon Pinpoint.

Returns:

  • (Hash<String,Float>)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_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)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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_idString

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

Returns:

  • (String)


3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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

#userTypes::EndpointUser

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

Returns:



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3785

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