« blib/lib/Paws/DynamoDB/GetItemOutput.pm
↑ Summary
blib/lib/Paws/DynamoDB/ItemCollectionMetrics.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::GlobalSecondaryIndexDescription; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Backfilling => (is => 'ro', isa => 'Bool'); | |
| 5 | 1 | has IndexArn => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has IndexName => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has IndexSizeBytes => (is => 'ro', isa => 'Int'); | |
| 8 | 1 | has IndexStatus => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has ItemCount => (is => 'ro', isa => 'Int'); | |
| 10 | 1 | has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]'); | |
| 11 | 1 | has Projection => (is => 'ro', isa => 'Paws::DynamoDB::Projection'); | |
| 12 | 1 | has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughputDescription'); | |
| 13 | |||
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DynamoDB::GlobalSecondaryIndexDescription | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::DynamoDB::GlobalSecondaryIndexDescription object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Backfilling => $value, ..., ProvisionedThroughput => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::GlobalSecondaryIndexDescription object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Backfilling | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Represents the properties of a global secondary index. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Backfilling => Bool | ||
| 50 | |||
| 51 | Indicates whether the index is currently backfilling. I<Backfilling> is | ||
| 52 | the process of reading items from the table and determining whether | ||
| 53 | they can be added to the index. (Not all items will qualify: For | ||
| 54 | example, a partition key cannot have any duplicate values.) If an item | ||
| 55 | can be added to the index, DynamoDB will do so. After all items have | ||
| 56 | been processed, the backfilling operation is complete and | ||
| 57 | C<Backfilling> is false. | ||
| 58 | |||
| 59 | You can delete an index that is being created during the C<Backfilling> | ||
| 60 | phase when C<IndexStatus> is set to CREATING and C<Backfilling> is | ||
| 61 | true. You can't delete the index that is being created when | ||
| 62 | C<IndexStatus> is set to CREATING and C<Backfilling> is false. | ||
| 63 | |||
| 64 | For indexes that were created during a C<CreateTable> operation, the | ||
| 65 | C<Backfilling> attribute does not appear in the C<DescribeTable> | ||
| 66 | output. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 IndexArn => Str | ||
| 70 | |||
| 71 | The Amazon Resource Name (ARN) that uniquely identifies the index. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 IndexName => Str | ||
| 75 | |||
| 76 | The name of the global secondary index. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 IndexSizeBytes => Int | ||
| 80 | |||
| 81 | The total size of the specified index, in bytes. DynamoDB updates this | ||
| 82 | value approximately every six hours. Recent changes might not be | ||
| 83 | reflected in this value. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 IndexStatus => Str | ||
| 87 | |||
| 88 | The current state of the global secondary index: | ||
| 89 | |||
| 90 | =over | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<CREATING> - The index is being created. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<UPDATING> - The index is being updated. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<DELETING> - The index is being deleted. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<ACTIVE> - The index is ready for use. | ||
| 107 | |||
| 108 | =back | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 ItemCount => Int | ||
| 113 | |||
| 114 | The number of items in the specified index. DynamoDB updates this value | ||
| 115 | approximately every six hours. Recent changes might not be reflected in | ||
| 116 | this value. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>] | ||
| 120 | |||
| 121 | The complete key schema for a global secondary index, which consists of | ||
| 122 | one or more pairs of attribute names and key types: | ||
| 123 | |||
| 124 | =over | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<HASH> - partition key | ||
| 129 | |||
| 130 | =item * | ||
| 131 | |||
| 132 | C<RANGE> - sort key | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | The partition key of an item is also known as its I<hash attribute>. | ||
| 137 | The term "hash attribute" derives from DynamoDB's usage of an internal | ||
| 138 | hash function to evenly distribute data items across partitions, based | ||
| 139 | on their partition key values. | ||
| 140 | |||
| 141 | The sort key of an item is also known as its I<range attribute>. The | ||
| 142 | term "range attribute" derives from the way DynamoDB stores items with | ||
| 143 | the same partition key physically close together, in sorted order by | ||
| 144 | the sort key value. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 Projection => L<Paws::DynamoDB::Projection> | ||
| 148 | |||
| 149 | Represents attributes that are copied (projected) from the table into | ||
| 150 | the global secondary index. These are in addition to the primary key | ||
| 151 | attributes and index key attributes, which are automatically projected. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughputDescription> | ||
| 155 | |||
| 156 | Represents the provisioned throughput settings for the specified global | ||
| 157 | secondary index. | ||
| 158 | |||
| 159 | For current minimum and maximum provisioned throughput values, see | ||
| 160 | Service, Account, and Table Quotas | ||
| 161 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) | ||
| 162 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head1 SEE ALSO | ||
| 167 | |||
| 168 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 169 | |||
| 170 | =head1 BUGS and CONTRIBUTIONS | ||
| 171 | |||
| 172 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 173 | |||
| 174 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 175 | |||
| 176 | =cut | ||
| 177 | |||