« blib/lib/Paws/Pinpoint/MessageConfiguration.pm
↑ Summary
blib/lib/Paws/Pinpoint/MessageResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::MessageRequest; | ||
| 3 | use Moose; | ||
| 4 | has Addresses => (is => 'ro', isa => 'Paws::Pinpoint::MapOfAddressConfiguration'); | ||
| 5 | has Context => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string'); | ||
| 6 | has Endpoints => (is => 'ro', isa => 'Paws::Pinpoint::MapOfEndpointSendConfiguration'); | ||
| 7 | has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::DirectMessageConfiguration', required => 1); | ||
| 8 | has TemplateConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::TemplateConfiguration'); | ||
| 9 | has TraceId => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Pinpoint::MessageRequest | ||
| 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::MessageRequest object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Addresses => $value, ..., TraceId => $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::MessageRequest object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Addresses | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Specifies the configuration and other settings for a message. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Addresses => L<Paws::Pinpoint::MapOfAddressConfiguration> | ||
| 47 | |||
| 48 | A map of key-value pairs, where each key is an address and each value | ||
| 49 | is an AddressConfiguration | ||
| 50 | (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) | ||
| 51 | object. An address can be a push notification token, a phone number, or | ||
| 52 | an email address. You can use an AddressConfiguration | ||
| 53 | (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration) | ||
| 54 | object to tailor the message for an address by specifying settings such | ||
| 55 | as content overrides and message variables. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Context => L<Paws::Pinpoint::MapOf__string> | ||
| 59 | |||
| 60 | A map of custom attributes to attach to the message. For a push | ||
| 61 | notification, this payload is added to the data.pinpoint object. For an | ||
| 62 | email or text message, this payload is added to email/SMS delivery | ||
| 63 | receipt event attributes. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Endpoints => L<Paws::Pinpoint::MapOfEndpointSendConfiguration> | ||
| 67 | |||
| 68 | A map of key-value pairs, where each key is an endpoint ID and each | ||
| 69 | value is an EndpointSendConfiguration | ||
| 70 | (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) | ||
| 71 | object. You can use an EndpointSendConfiguration | ||
| 72 | (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration) | ||
| 73 | object to tailor the message for an endpoint by specifying settings | ||
| 74 | such as content overrides and message variables. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> MessageConfiguration => L<Paws::Pinpoint::DirectMessageConfiguration> | ||
| 78 | |||
| 79 | The settings and content for the default message and any default | ||
| 80 | messages that you defined for specific channels. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 TemplateConfiguration => L<Paws::Pinpoint::TemplateConfiguration> | ||
| 84 | |||
| 85 | The message template to use for the message. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 TraceId => Str | ||
| 89 | |||
| 90 | The unique identifier for tracing the message. This identifier is | ||
| 91 | visible to message recipients. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |