blib/lib/Paws/PinpointEmail/DkimAttributes.pm untested

filter: Statementstmt 0.0% 0 / 6 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 7 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::PinpointEmail::DkimAttributes;
3 use Moose;
4 has SigningEnabled => (is => 'ro', isa => 'Bool');
5 has Status => (is => 'ro', isa => 'Str');
6 has Tokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::PinpointEmail::DkimAttributes
15  
16 =head1 USAGE
17  
18 This class represents one of two things:
19  
20 =head3 Arguments in a call to a service
21  
22 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23 Each attribute should be used as a named argument in the calls that expect this type of object.
24  
25 As an example, if Att1 is expected to be a Paws::PinpointEmail::DkimAttributes object:
26  
27 $service_obj->Method(Att1 => { SigningEnabled => $value, ..., Tokens => $value });
28  
29 =head3 Results returned from an API call
30  
31 Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::DkimAttributes object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->SigningEnabled
35  
36 =head1 DESCRIPTION
37  
38 An object that contains information about the DKIM configuration for an
39 email identity.
40  
41 =head1 ATTRIBUTES
42  
43  
44 =head2 SigningEnabled => Bool
45  
46 If the value is C<true>, then the messages that Amazon Pinpoint sends
47 from the identity are DKIM-signed. If the value is C<false>, then the
48 messages that Amazon Pinpoint sends from the identity aren't
49 DKIM-signed.
50  
51  
52 =head2 Status => Str
53  
54 Describes whether or not Amazon Pinpoint has successfully located the
55 DKIM records in the DNS records for the domain. The status can be one
56 of the following:
57  
58 =over
59  
60 =item *
61  
62 C<PENDING> E<ndash> Amazon Pinpoint hasn't yet located the DKIM records
63 in the DNS configuration for the domain, but will continue to attempt
64 to locate them.
65  
66 =item *
67  
68 C<SUCCESS> E<ndash> Amazon Pinpoint located the DKIM records in the DNS
69 configuration for the domain and determined that they're correct.
70 Amazon Pinpoint can now send DKIM-signed email from the identity.
71  
72 =item *
73  
74 C<FAILED> E<ndash> Amazon Pinpoint was unable to locate the DKIM
75 records in the DNS settings for the domain, and won't continue to
76 search for them.
77  
78 =item *
79  
80 C<TEMPORARY_FAILURE> E<ndash> A temporary issue occurred, which
81 prevented Amazon Pinpoint from determining the DKIM status for the
82 domain.
83  
84 =item *
85  
86 C<NOT_STARTED> E<ndash> Amazon Pinpoint hasn't yet started searching
87 for the DKIM records in the DKIM records for the domain.
88  
89 =back
90  
91  
92  
93 =head2 Tokens => ArrayRef[Str|Undef]
94  
95 A set of unique strings that you use to create a set of CNAME records
96 that you add to the DNS configuration for your domain. When Amazon
97 Pinpoint detects these records in the DNS configuration for your
98 domain, the DKIM authentication process is complete. Amazon Pinpoint
99 usually detects these records within about 72 hours of adding them to
100 the DNS configuration for your domain.
101  
102  
103  
104 =head1 SEE ALSO
105  
106 This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail>
107  
108 =head1 BUGS and CONTRIBUTIONS
109  
110 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
111  
112 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
113  
114 =cut
115