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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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, 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",
  },
}

Endpoint update request

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

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 +1206XXX5550100. For the email channel, use an email address.

Returns:

  • (String)


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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_typeString

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

Returns:

  • (String)


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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

#demographicTypes::EndpointDemographic

The endpoint demographic attributes.



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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_dateString

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

Returns:

  • (String)


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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_statusString

Unused.

Returns:

  • (String)


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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

#locationTypes::EndpointLocation

The endpoint location attributes.



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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_idString

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

Returns:

  • (String)


3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3639

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