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