Class: Aws::Pinpoint::Types::EndpointRequest

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

Overview

Note:

When making an API call, you may pass EndpointRequest data as a hash:

{
  address: "__string",
  attributes: {
    "__string" => ["__string"],
  },
  channel_type: "GCM", # accepts GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM
  demographic: {
    app_version: "__string",
    locale: "__string",
    make: "__string",
    model: "__string",
    model_version: "__string",
    platform: "__string",
    platform_version: "__string",
    timezone: "__string",
  },
  effective_date: "__string",
  endpoint_status: "__string",
  location: {
    city: "__string",
    country: "__string",
    latitude: 1.0,
    longitude: 1.0,
    postal_code: "__string",
    region: "__string",
  },
  metrics: {
    "__string" => 1.0,
  },
  opt_out: "__string",
  request_id: "__string",
  user: {
    user_attributes: {
      "__string" => ["__string"],
    },
    user_id: "__string",
  },
}

An endpoint update request.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String

The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

Returns:

  • (String) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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 values [“science”, “politics”, “travel”]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

Returns:

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


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

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

#demographic ⇒ Types::EndpointDemographic

Demographic attributes for the endpoint.

Returns:



3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

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

#effective_date ⇒ String

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

Returns:

  • (String) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

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

#endpoint_status ⇒ String

Unused.

Returns:

  • (String) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

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

#location ⇒ Types::EndpointLocation

The endpoint location attributes.

Returns:



3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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>) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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) 


3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

class EndpointRequest < Struct.new(
  :address,
  :attributes,
  :channel_type,
  :demographic,
  :effective_date,
  :endpoint_status,
  :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:



3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3953

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