File Coverage

blib/lib/Paws/DynamoDBStreams/KeySchemaElement.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::DynamoDBStreams::KeySchemaElement;
2 1     1   403 use Moose;
  1         3  
  1         6  
3             has AttributeName => (is => 'ro', isa => 'Str', required => 1);
4             has KeyType => (is => 'ro', isa => 'Str', required => 1);
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::DynamoDBStreams::KeySchemaElement
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::DynamoDBStreams::KeySchemaElement object:
23              
24             $service_obj->Method(Att1 => { AttributeName => $value, ..., KeyType => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDBStreams::KeySchemaElement object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->AttributeName
32              
33             =head1 DESCRIPTION
34              
35             Represents I<a single element> of a key schema. A key schema specifies
36             the attributes that make up the primary key of a table, or the key
37             attributes of an index.
38              
39             A C<KeySchemaElement> represents exactly one attribute of the primary
40             key. For example, a simple primary key (partition key) would be
41             represented by one C<KeySchemaElement>. A composite primary key
42             (partition key and sort key) would require one C<KeySchemaElement> for
43             the partition key, and another C<KeySchemaElement> for the sort key.
44              
45             The partition key of an item is also known as its I<hash attribute>.
46             The term "hash attribute" derives from DynamoDB's usage of an internal
47             hash function to evenly distribute data items across partitions, based
48             on their partition key values.
49              
50             The sort key of an item is also known as its I<range attribute>. The
51             term "range attribute" derives from the way DynamoDB stores items with
52             the same partition key physically close together, in sorted order by
53             the sort key value.
54              
55             =head1 ATTRIBUTES
56              
57              
58             =head2 B<REQUIRED> AttributeName => Str
59              
60             The name of a key attribute.
61              
62              
63             =head2 B<REQUIRED> KeyType => Str
64              
65             The attribute data, consisting of the data type and the attribute value
66             itself.
67              
68              
69              
70             =head1 SEE ALSO
71              
72             This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDBStreams>
73              
74             =head1 BUGS and CONTRIBUTIONS
75              
76             The source code is located here: https://github.com/pplu/aws-sdk-perl
77              
78             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
79              
80             =cut
81