« blib/lib/Paws/Pinpoint/EndpointMessageResult.pm
↑ Summary
blib/lib/Paws/Pinpoint/EndpointResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EndpointRequest; | ||
| 3 | use Moose; | ||
| 4 | has Address => (is => 'ro', isa => 'Str'); | ||
| 5 | has Attributes => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string'); | ||
| 6 | has ChannelType => (is => 'ro', isa => 'Str'); | ||
| 7 | has Demographic => (is => 'ro', isa => 'Paws::Pinpoint::EndpointDemographic'); | ||
| 8 | has EffectiveDate => (is => 'ro', isa => 'Str'); | ||
| 9 | has EndpointStatus => (is => 'ro', isa => 'Str'); | ||
| 10 | has Location => (is => 'ro', isa => 'Paws::Pinpoint::EndpointLocation'); | ||
| 11 | has Metrics => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__double'); | ||
| 12 | has OptOut => (is => 'ro', isa => 'Str'); | ||
| 13 | has RequestId => (is => 'ro', isa => 'Str'); | ||
| 14 | has User => (is => 'ro', isa => 'Paws::Pinpoint::EndpointUser'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Pinpoint::EndpointRequest | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::Pinpoint::EndpointRequest object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Address => $value, ..., User => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EndpointRequest object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Address | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Specifies the channel type and other settings for an endpoint. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Address => Str | ||
| 52 | |||
| 53 | The destination address for messages or push notifications that you | ||
| 54 | send to the endpoint. The address varies by channel. For a | ||
| 55 | push-notification channel, use the token provided by the push | ||
| 56 | notification service, such as an Apple Push Notification service (APNs) | ||
| 57 | device token or a Firebase Cloud Messaging (FCM) registration token. | ||
| 58 | For the SMS channel, use a phone number in E.164 format, such as | ||
| 59 | +12065550100. For the email channel, use an email address. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Attributes => L<Paws::Pinpoint::MapOfListOf__string> | ||
| 63 | |||
| 64 | One or more custom attributes that describe the endpoint by associating | ||
| 65 | a name with an array of values. For example, the value of a custom | ||
| 66 | attribute named Interests might be: ["Science", "Music", "Travel"]. You | ||
| 67 | can use these attributes as filter criteria when you create segments. | ||
| 68 | Attribute names are case sensitive. | ||
| 69 | |||
| 70 | An attribute name can contain up to 50 characters. An attribute value | ||
| 71 | can contain up to 100 characters. When you define the name of a custom | ||
| 72 | attribute, avoid using the following characters: number sign (#), colon | ||
| 73 | (:), question mark (?), backslash (\), and slash (/). The Amazon | ||
| 74 | Pinpoint console can't display attribute names that contain these | ||
| 75 | characters. This restriction doesn't apply to attribute values. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ChannelType => Str | ||
| 79 | |||
| 80 | The channel to use when sending messages or push notifications to the | ||
| 81 | endpoint. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Demographic => L<Paws::Pinpoint::EndpointDemographic> | ||
| 85 | |||
| 86 | The demographic information for the endpoint, such as the time zone and | ||
| 87 | platform. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 EffectiveDate => Str | ||
| 91 | |||
| 92 | The date and time, in ISO 8601 format, when the endpoint is updated. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 EndpointStatus => Str | ||
| 96 | |||
| 97 | Specifies whether to send messages or push notifications to the | ||
| 98 | endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; | ||
| 99 | and, INACTIVE, messages arenE<rsquo>t sent to the endpoint. | ||
| 100 | |||
| 101 | Amazon Pinpoint automatically sets this value to ACTIVE when you create | ||
| 102 | an endpoint or update an existing endpoint. Amazon Pinpoint | ||
| 103 | automatically sets this value to INACTIVE if you update another | ||
| 104 | endpoint that has the same address specified by the Address property. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Location => L<Paws::Pinpoint::EndpointLocation> | ||
| 108 | |||
| 109 | The geographic information for the endpoint. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Metrics => L<Paws::Pinpoint::MapOf__double> | ||
| 113 | |||
| 114 | One or more custom metrics that your app reports to Amazon Pinpoint for | ||
| 115 | the endpoint. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 OptOut => Str | ||
| 119 | |||
| 120 | Specifies whether the user who's associated with the endpoint has opted | ||
| 121 | out of receiving messages and push notifications from you. Possible | ||
| 122 | values are: ALL, the user has opted out and doesn't want to receive any | ||
| 123 | messages or push notifications; and, NONE, the user hasn't opted out | ||
| 124 | and wants to receive all messages and push notifications. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 RequestId => Str | ||
| 128 | |||
| 129 | The unique identifier for the most recent request to update the | ||
| 130 | endpoint. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 User => L<Paws::Pinpoint::EndpointUser> | ||
| 134 | |||
| 135 | One or more custom attributes that describe the user who's associated | ||
| 136 | with the endpoint. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head1 SEE ALSO | ||
| 141 | |||
| 142 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 143 | |||
| 144 | =head1 BUGS and CONTRIBUTIONS | ||
| 145 | |||
| 146 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 147 | |||
| 148 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 149 | |||
| 150 | =cut | ||
| 151 |