MessageResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-message-result-schema.json",
  "title": "MessageResult",
  "description": "Provides information about the results of sending a message directly to an endpoint address.",
  "type": "object",
  "properties": {
    "DeliveryStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryStatus"
        },
        {
          "description": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>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.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li>   <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"
        }
      ]
    },
    "MessageId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the message that was sent."
        }
      ]
    },
    "StatusCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The downstream service status code for delivering the message."
        }
      ]
    },
    "StatusMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The status message for delivering the message."
        }
      ]
    },
    "UpdatedToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "DeliveryStatus",
    "StatusCode"
  ]
}