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

Class: Aws::Pinpoint::Types::MessageResult

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

Overview

Provides information about the results of sending a message directly to an endpoint address.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_status ⇒ String

The delivery status of the message. Possible values are:

  • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won\'t attempt to send the message again.

  • OPT_OUT - The user who\'s associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won\'t attempt to send the message again.

  • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won\'t attempt to send the message again.

  • SUCCESSFUL - The message was successfully delivered to the endpoint address.

  • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won\'t attempt to send the message again.

  • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

  • TIMEOUT - The message couldn\'t be sent within the timeout period.

  • UNKNOWN_FAILURE - An unknown error occurred.

    Possible values:

    • SUCCESSFUL
    • THROTTLED
    • TEMPORARY_FAILURE
    • PERMANENT_FAILURE
    • UNKNOWN_FAILURE
    • OPT_OUT
    • DUPLICATE

Returns:

  • (String) —

    The delivery status of the message.

#message_id ⇒ String

The unique identifier for the message that was sent.

Returns:

  • (String) —

    The unique identifier for the message that was sent.

#status_code ⇒ Integer

The downstream service status code for delivering the message.

Returns:

  • (Integer) —

    The downstream service status code for delivering the message.

#status_message ⇒ String

The status message for delivering the message.

Returns:

  • (String) —

    The status message for delivering the message.

#updated_token ⇒ String

For push notifications that are sent through the GCM channel, specifies whether the endpoint\'s device registration token was updated as part of delivering the message.

Returns:

  • (String) —

    For push notifications that are sent through the GCM channel, specifies whether the endpoint\'s device registration token was updated as part of delivering the message.