| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::WriteApplicationSettingsRequest; | ||
| 3 | use Moose; | ||
| 4 | has CampaignHook => (is => 'ro', isa => 'Paws::Pinpoint::CampaignHook'); | ||
| 5 | has CloudWatchMetricsEnabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EventTaggingEnabled => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Limits => (is => 'ro', isa => 'Paws::Pinpoint::CampaignLimits'); | ||
| 8 | has QuietTime => (is => 'ro', isa => 'Paws::Pinpoint::QuietTime'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Pinpoint::WriteApplicationSettingsRequest | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Pinpoint::WriteApplicationSettingsRequest object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CampaignHook => $value, ..., QuietTime => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::WriteApplicationSettingsRequest object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CampaignHook | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the default settings for an application. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CampaignHook => L<Paws::Pinpoint::CampaignHook> | ||
| 46 | |||
| 47 | The settings for the AWS Lambda function to invoke by default as a code | ||
| 48 | hook for campaigns in the application. You can use this hook to | ||
| 49 | customize segments that are used by campaigns in the application. | ||
| 50 | |||
| 51 | To override these settings and define custom settings for a specific | ||
| 52 | campaign, use the CampaignHook object of the | ||
| 53 | |||
| 54 | Campaign resource. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CloudWatchMetricsEnabled => Bool | ||
| 58 | |||
| 59 | Specifies whether to enable application-related alarms in Amazon | ||
| 60 | CloudWatch. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 EventTaggingEnabled => Bool | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Limits => L<Paws::Pinpoint::CampaignLimits> | ||
| 69 | |||
| 70 | The default sending limits for campaigns in the application. To | ||
| 71 | override these limits and define custom limits for a specific campaign | ||
| 72 | or journey, use the | ||
| 73 | |||
| 74 | Campaign resource or the Journey resource, respectively. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 QuietTime => L<Paws::Pinpoint::QuietTime> | ||
| 78 | |||
| 79 | The default quiet time for campaigns in the application. Quiet time is | ||
| 80 | a specific time range when messages aren't sent to endpoints, if all | ||
| 81 | the following conditions are met: | ||
| 82 | |||
| 83 | =over | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | The EndpointDemographic.Timezone property of the endpoint is set to a | ||
| 88 | valid value. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | The current time in the endpoint's time zone is later than or equal to | ||
| 93 | the time specified by the QuietTime.Start property for the application | ||
| 94 | (or a campaign or journey that has custom quiet time settings). | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | The current time in the endpoint's time zone is earlier than or equal | ||
| 99 | to the time specified by the QuietTime.End property for the application | ||
| 100 | (or a campaign or journey that has custom quiet time settings). | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | If any of the preceding conditions isn't met, the endpoint will receive | ||
| 105 | messages from a campaign or journey, even if quiet time is enabled. | ||
| 106 | |||
| 107 | To override the default quiet time settings for a specific campaign or | ||
| 108 | journey, use the | ||
| 109 | |||
| 110 | Campaign resource or the Journey resource to define a custom quiet time | ||
| 111 | for the campaign or journey. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |