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

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

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

Overview

Provides information about 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 example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

Returns:

  • (String)

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

#application_idString

The unique identifier for the application that\'s associated with the endpoint.

Returns:

  • (String)

    The unique identifier for the application that\'s associated with 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.

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 that\'s used 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 that\'s used when sending messages or push notifications to the endpoint.

#cohort_idString

A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

Returns:

  • (String)

    A number from 0-99 that represents the cohort that the endpoint is assigned to.

#creation_dateString

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

Returns:

  • (String)

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

#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 was last updated.

Returns:

  • (String)

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

#endpoint_statusString

Not used.

Returns:

  • (String)

    Not used.

#idString

The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn\'t conflict with other endpoint identifiers that are associated with the application.

Returns:

  • (String)

    The unique identifier that you assigned 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 user attributes that your app reports to Amazon Pinpoint for the user who\'s associated with the endpoint.

Returns:

  • (Types::EndpointUser)

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who\'s associated with the endpoint.