« blib/lib/Paws/DynamoDBStreams/AttributeMap.pm
↑ Summary
blib/lib/Paws/DynamoDBStreams/DescribeStream.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDBStreams::AttributeValue; | ||
| 3 | use Moose; | ||
| 4 | has B => (is => 'ro', isa => 'Str'); | ||
| 5 | has BOOL => (is => 'ro', isa => 'Bool'); | ||
| 6 | has BS => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has L => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDBStreams::AttributeValue]'); | ||
| 8 | has M => (is => 'ro', isa => 'Paws::DynamoDBStreams::MapAttributeValue'); | ||
| 9 | has N => (is => 'ro', isa => 'Str'); | ||
| 10 | has NS => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | has NULL => (is => 'ro', isa => 'Bool'); | ||
| 12 | has S => (is => 'ro', isa => 'Str'); | ||
| 13 | has SS => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::DynamoDBStreams::AttributeValue | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::DynamoDBStreams::AttributeValue object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { B => $value, ..., SS => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDBStreams::AttributeValue object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->B | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Represents the data for an attribute. | ||
| 46 | |||
| 47 | Each attribute value is described as a name-value pair. The name is the | ||
| 48 | data type, and the value is the data itself. | ||
| 49 | |||
| 50 | For more information, see Data Types | ||
| 51 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) | ||
| 52 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B => Str | ||
| 58 | |||
| 59 | An attribute of type Binary. For example: | ||
| 60 | |||
| 61 | C<"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"> | ||
| 62 | |||
| 63 | |||
| 64 | =head2 BOOL => Bool | ||
| 65 | |||
| 66 | An attribute of type Boolean. For example: | ||
| 67 | |||
| 68 | C<"BOOL": true> | ||
| 69 | |||
| 70 | |||
| 71 | =head2 BS => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | An attribute of type Binary Set. For example: | ||
| 74 | |||
| 75 | C<"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]> | ||
| 76 | |||
| 77 | |||
| 78 | =head2 L => ArrayRef[L<Paws::DynamoDBStreams::AttributeValue>] | ||
| 79 | |||
| 80 | An attribute of type List. For example: | ||
| 81 | |||
| 82 | C<"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]> | ||
| 83 | |||
| 84 | |||
| 85 | =head2 M => L<Paws::DynamoDBStreams::MapAttributeValue> | ||
| 86 | |||
| 87 | An attribute of type Map. For example: | ||
| 88 | |||
| 89 | C<"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}> | ||
| 90 | |||
| 91 | |||
| 92 | =head2 N => Str | ||
| 93 | |||
| 94 | An attribute of type Number. For example: | ||
| 95 | |||
| 96 | C<"N": "123.45"> | ||
| 97 | |||
| 98 | Numbers are sent across the network to DynamoDB as strings, to maximize | ||
| 99 | compatibility across languages and libraries. However, DynamoDB treats | ||
| 100 | them as number type attributes for mathematical operations. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 NS => ArrayRef[Str|Undef] | ||
| 104 | |||
| 105 | An attribute of type Number Set. For example: | ||
| 106 | |||
| 107 | C<"NS": ["42.2", "-19", "7.5", "3.14"]> | ||
| 108 | |||
| 109 | Numbers are sent across the network to DynamoDB as strings, to maximize | ||
| 110 | compatibility across languages and libraries. However, DynamoDB treats | ||
| 111 | them as number type attributes for mathematical operations. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 NULL => Bool | ||
| 115 | |||
| 116 | An attribute of type Null. For example: | ||
| 117 | |||
| 118 | C<"NULL": true> | ||
| 119 | |||
| 120 | |||
| 121 | =head2 S => Str | ||
| 122 | |||
| 123 | An attribute of type String. For example: | ||
| 124 | |||
| 125 | C<"S": "Hello"> | ||
| 126 | |||
| 127 | |||
| 128 | =head2 SS => ArrayRef[Str|Undef] | ||
| 129 | |||
| 130 | An attribute of type String Set. For example: | ||
| 131 | |||
| 132 | C<"SS": ["Giraffe", "Hippo" ,"Zebra"]> | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head1 SEE ALSO | ||
| 137 | |||
| 138 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDBStreams> | ||
| 139 | |||
| 140 | =head1 BUGS and CONTRIBUTIONS | ||
| 141 | |||
| 142 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 143 | |||
| 144 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 145 | |||
| 146 | =cut | ||
| 147 |