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

Endpoint response

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

Returns:

  • (String)

    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).

#application_idString

The ID of the application associated with the endpoint.

Returns:

  • (String)

    The ID of the application associated with the endpoint.

#attributesHash<String,Array<String>>

Returns:

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

#channel_typeString

The channel type. Valid values: GCM | APNS | SMS | EMAIL

Possible values:

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

Returns:

  • (String)

    The channel type.

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

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

#creation_dateString

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

Returns:

  • (String)

    The last time the endpoint was created.

#demographicTypes::EndpointDemographic

The endpoint demographic attributes.

Returns:

#effective_dateString

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

Returns:

  • (String)

    The last time the endpoint was updated.

#endpoint_statusString

The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.

Returns:

  • (String)

    The endpoint status.

#idString

The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.

Returns:

  • (String)

    The unique ID that you assigned to the endpoint.

#locationTypes::EndpointLocation

The endpoint location attributes.

Returns:

#metricsHash<String,Float>

Returns:

  • (Hash<String,Float>)

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

    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.

#request_idString

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

Returns:

  • (String)

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

#userTypes::EndpointUser

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

Returns:

  • (Types::EndpointUser)

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