Class: Aws::Pinpoint::Types::EndpointMessageResult

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

Overview

Provides information about the delivery status and results of sending a message directly to an endpoint.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String

The endpoint address that the message was delivered to.

Returns:

  • (String) 


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end

#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 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. Amazon Pinpoint won't attempt to send the message again.

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

  • 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.

  • UNKNOWN_FAILURE - An unknown error occurred.

Returns:

  • (String) 


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end

#message_id ⇒ String

The unique identifier for the message that was sent.

Returns:

  • (String) 


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end

#status_code ⇒ Integer

The downstream service status code for delivering the message.

Returns:

  • (Integer) 


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

The status message for delivering the message.

Returns:

  • (String) 


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end

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


4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4839

class EndpointMessageResult < Struct.new(
  :address,
  :delivery_status,
  :message_id,
  :status_code,
  :status_message,
  :updated_token)
  SENSITIVE = []
  include Aws::Structure
end