File Coverage

blib/lib/Paws/SNS/MessageAttributeValue.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::SNS::MessageAttributeValue;
2 1     1   389 use Moose;
  1         2  
  1         7  
3             has BinaryValue => (is => 'ro', isa => 'Str');
4             has DataType => (is => 'ro', isa => 'Str', required => 1);
5             has StringValue => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SNS::MessageAttributeValue
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::SNS::MessageAttributeValue object:
24              
25             $service_obj->Method(Att1 => { BinaryValue => $value, ..., StringValue => $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::SNS::MessageAttributeValue object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->BinaryValue
33              
34             =head1 DESCRIPTION
35              
36             The user-specified message attribute value. For string data types, the
37             value attribute has the same restrictions on the content as the message
38             body. For more information, see Publish.
39              
40             Name, type, and value must not be empty or null. In addition, the
41             message body should not be empty or null. All parts of the message
42             attribute, including name, type, and value, are included in the message
43             size restriction, which is currently 256 KB (262,144 bytes). For more
44             information, see Using Amazon SNS Message Attributes.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 BinaryValue => Str
50              
51             Binary type attributes can store any binary data, for example,
52             compressed data, encrypted data, or images.
53              
54              
55             =head2 B<REQUIRED> DataType => Str
56              
57             Amazon SNS supports the following logical data types: String, Number,
58             and Binary. For more information, see Message Attribute Data Types.
59              
60              
61             =head2 StringValue => Str
62              
63             Strings are Unicode with UTF8 binary encoding. For a list of code
64             values, see
65             http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
66              
67              
68              
69             =head1 SEE ALSO
70              
71             This class forms part of L<Paws>, describing an object used in L<Paws::SNS>
72              
73             =head1 BUGS and CONTRIBUTIONS
74              
75             The source code is located here: https://github.com/pplu/aws-sdk-perl
76              
77             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
78              
79             =cut
80