AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing EndpointRequest as input to an Aws::Client method, you can use a vanilla 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",
  },
}

Specifies the channel type and other settings for an endpoint.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (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)

    The destination address for messages or push notifications that you send to the endpoint.

#attributesHash<String,Array<String>>

One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can\'t display attribute names that contain these characters. This restriction doesn\'t apply to attribute values.

Returns:

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

    One or more custom attributes that describe the endpoint by associating a name with an array of values.

#channel_typeString

The channel to use when sending messages or push notifications to the endpoint.

Possible values:

  • GCM
  • APNS
  • APNS_SANDBOX
  • APNS_VOIP
  • APNS_VOIP_SANDBOX
  • ADM
  • SMS
  • VOICE
  • EMAIL
  • BAIDU
  • CUSTOM

Returns:

  • (String)

    The channel to use when sending messages or push notifications to the endpoint.

#demographicTypes::EndpointDemographic

The demographic information for the endpoint, such as the time zone and platform.

Returns:

#effective_dateString

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

Returns:

  • (String)

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

#endpoint_statusString

Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

Returns:

  • (String)

    Specifies whether to send messages or push notifications to the endpoint.

#locationTypes::EndpointLocation

The geographic information for the endpoint.

Returns:

#metricsHash<String,Float>

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

Returns:

  • (Hash<String,Float>)

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

#opt_outString

Specifies whether the user who\'s associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn\'t want to receive any messages or push notifications; and, NONE, the user hasn\'t opted out and wants to receive all messages and push notifications.

Returns:

  • (String)

    Specifies whether the user who\'s associated with the endpoint has opted out of receiving messages and push notifications from you.

#request_idString

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

Returns:

  • (String)

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

#userTypes::EndpointUser

One or more custom attributes that describe the user who\'s associated with the endpoint.

Returns:

  • (Types::EndpointUser)

    One or more custom attributes that describe the user who\'s associated with the endpoint.