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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

The result from sending a message to an address.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#delivery_status ⇒ String

The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT

  • An error occurred when delivering the message to the endpoint.

Amazon Pinpoint won’t attempt to send the message again. TIMEOUT - The message couldn’t be sent within the timeout period. QUIET_TIME

  • The local time for the endpoint was within the QuietTime for the

campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED

  • Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The

endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.

Returns:

  • (String) 


6897
6898
6899
6900
6901
6902
6903
6904
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 6897

class MessageResult < Struct.new(
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  include Aws::Structure
end

#message_id ⇒ String

Unique message identifier associated with the message that was sent.

Returns:

  • (String) 


6897
6898
6899
6900
6901
6902
6903
6904
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 6897

class MessageResult < Struct.new(
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  include Aws::Structure
end

#status_code ⇒ Integer

Downstream service status code.

Returns:

  • (Integer) 


6897
6898
6899
6900
6901
6902
6903
6904
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 6897

class MessageResult < Struct.new(
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  include Aws::Structure
end

#status_message ⇒ String

Status message for message delivery.

Returns:

  • (String) 


6897
6898
6899
6900
6901
6902
6903
6904
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 6897

class MessageResult < Struct.new(
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  include Aws::Structure
end

#updated_token ⇒ String

If token was updated as part of delivery. (This is GCM Specific)

Returns:

  • (String) 


6897
6898
6899
6900
6901
6902
6903
6904
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 6897

class MessageResult < Struct.new(
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  include Aws::Structure
end