File Coverage

blib/lib/Paws/SES/CloudWatchDimensionConfiguration.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SES::CloudWatchDimensionConfiguration;
2 1     1   699 use Moose;
  1         5  
  1         12  
3             has DefaultDimensionValue => (is => 'ro', isa => 'Str', required => 1);
4             has DimensionName => (is => 'ro', isa => 'Str', required => 1);
5             has DimensionValueSource => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SES::CloudWatchDimensionConfiguration
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::SES::CloudWatchDimensionConfiguration object:
24              
25             $service_obj->Method(Att1 => { DefaultDimensionValue => $value, ..., DimensionValueSource => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::SES::CloudWatchDimensionConfiguration object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->DefaultDimensionValue
33              
34             =head1 DESCRIPTION
35              
36             Contains the dimension configuration to use when you publish email
37             sending events to Amazon CloudWatch.
38              
39             For information about publishing email sending events to Amazon
40             CloudWatch, see the Amazon SES Developer Guide.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> DefaultDimensionValue => Str
46              
47             The default value of the dimension that is published to Amazon
48             CloudWatch if you do not provide the value of the dimension when you
49             send an email. The default value must:
50              
51             =over
52              
53             =item *
54              
55             Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
56             or dashes (-).
57              
58             =item *
59              
60             Contain less than 256 characters.
61              
62             =back
63              
64              
65              
66             =head2 B<REQUIRED> DimensionName => Str
67              
68             The name of an Amazon CloudWatch dimension associated with an email
69             sending metric. The name must:
70              
71             =over
72              
73             =item *
74              
75             Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_),
76             or dashes (-).
77              
78             =item *
79              
80             Contain less than 256 characters.
81              
82             =back
83              
84              
85              
86             =head2 B<REQUIRED> DimensionValueSource => Str
87              
88             The place where Amazon SES finds the value of a dimension to publish to
89             Amazon CloudWatch. If you want Amazon SES to use the message tags that
90             you specify using an C<X-SES-MESSAGE-TAGS> header or a parameter to the
91             C<SendEmail>/C<SendRawEmail> API, choose C<messageTag>. If you want
92             Amazon SES to use your own email headers, choose C<emailHeader>.
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107