« blib/lib/Paws/Pinpoint/CustomDeliveryConfiguration.pm
↑ Summary
blib/lib/Paws/Pinpoint/DefaultMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::CustomMessageActivity; | ||
| 3 | use Moose; | ||
| 4 | has DeliveryUri => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndpointTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has MessageConfig => (is => 'ro', isa => 'Paws::Pinpoint::JourneyCustomMessage'); | ||
| 7 | has NextActivity => (is => 'ro', isa => 'Str'); | ||
| 8 | has TemplateName => (is => 'ro', isa => 'Str'); | ||
| 9 | has TemplateVersion => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Pinpoint::CustomMessageActivity | ||
| 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::CustomMessageActivity object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DeliveryUri => $value, ..., TemplateVersion => $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::CustomMessageActivity object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DeliveryUri | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The settings for a custom message activity. This type of activity calls | ||
| 42 | an AWS Lambda function or web hook that sends messages to participants. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DeliveryUri => Str | ||
| 48 | |||
| 49 | The destination to send the campaign or treatment to. This value can be | ||
| 50 | one of the following: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | The name or Amazon Resource Name (ARN) of an AWS Lambda function to | ||
| 57 | invoke to handle delivery of the campaign or treatment. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | The URL for a web application or service that supports HTTPS and can | ||
| 62 | receive the message. The URL has to be a full URL, including the HTTPS | ||
| 63 | protocol. | ||
| 64 | |||
| 65 | =back | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 EndpointTypes => ArrayRef[Str|Undef] | ||
| 70 | |||
| 71 | The types of endpoints to send the custom message to. Each valid value | ||
| 72 | maps to a type of channel that you can associate with an endpoint by | ||
| 73 | using the ChannelType property of an endpoint. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 MessageConfig => L<Paws::Pinpoint::JourneyCustomMessage> | ||
| 77 | |||
| 78 | Specifies the message data included in a custom channel message that's | ||
| 79 | sent to participants in a journey. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 NextActivity => Str | ||
| 83 | |||
| 84 | The unique identifier for the next activity to perform, after Amazon | ||
| 85 | Pinpoint calls the AWS Lambda function or web hook. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 TemplateName => Str | ||
| 89 | |||
| 90 | The name of the custom message template to use for the message. If | ||
| 91 | specified, this value must match the name of an existing message | ||
| 92 | template. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 TemplateVersion => Str | ||
| 96 | |||
| 97 | The unique identifier for the version of the message template to use | ||
| 98 | for the message. If specified, this value must match the identifier for | ||
| 99 | an existing template version. To retrieve a list of versions and | ||
| 100 | version identifiers for a template, use the | ||
| 101 | |||
| 102 | Template Versions resource. | ||
| 103 | |||
| 104 | If you don't specify a value for this property, Amazon Pinpoint uses | ||
| 105 | the I<active version> of the template. The I<active version> is | ||
| 106 | typically the version of a template that's been most recently reviewed | ||
| 107 | and approved for use, depending on your workflow. It isn't necessarily | ||
| 108 | the latest version of a template. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |