| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EndpointMessageResult; | ||
| 3 | use Moose; | ||
| 4 | has Address => (is => 'ro', isa => 'Str'); | ||
| 5 | has DeliveryStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MessageId => (is => 'ro', isa => 'Str'); | ||
| 7 | has StatusCode => (is => 'ro', isa => 'Int', required => 1); | ||
| 8 | has StatusMessage => (is => 'ro', isa => 'Str'); | ||
| 9 | has UpdatedToken => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Pinpoint::EndpointMessageResult | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Pinpoint::EndpointMessageResult object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Address => $value, ..., UpdatedToken => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EndpointMessageResult object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Address | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Provides information about the delivery status and results of sending a | ||
| 42 | message directly to an endpoint. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Address => Str | ||
| 48 | |||
| 49 | The endpoint address that the message was delivered to. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> DeliveryStatus => Str | ||
| 53 | |||
| 54 | The delivery status of the message. Possible values are: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | DUPLICATE - The endpoint address is a duplicate of another endpoint | ||
| 61 | address. Amazon Pinpoint won't attempt to send the message again. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | OPT_OUT - The user who's associated with the endpoint has opted out of | ||
| 66 | receiving messages from you. Amazon Pinpoint won't attempt to send the | ||
| 67 | message again. | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | PERMANENT_FAILURE - An error occurred when delivering the message to | ||
| 72 | the endpoint. Amazon Pinpoint won't attempt to send the message again. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | SUCCESSFUL - The message was successfully delivered to the endpoint. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't | ||
| 81 | attempt to send the message again. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | THROTTLED - Amazon Pinpoint throttled the operation to send the message | ||
| 86 | to the endpoint. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | TIMEOUT - The message couldn't be sent within the timeout period. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | UNKNOWN_FAILURE - An unknown error occurred. | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 MessageId => Str | ||
| 101 | |||
| 102 | The unique identifier for the message that was sent. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> StatusCode => Int | ||
| 106 | |||
| 107 | The downstream service status code for delivering the message. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 StatusMessage => Str | ||
| 111 | |||
| 112 | The status message for delivering the message. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 UpdatedToken => Str | ||
| 116 | |||
| 117 | For push notifications that are sent through the GCM channel, specifies | ||
| 118 | whether the endpoint's device registration token was updated as part of | ||
| 119 | delivering the message. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |