/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DynamoDB::KeySchemaElement

NAME

Paws::DynamoDB::KeySchemaElement

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::DynamoDB::KeySchemaElement object:

$service_obj->Method(Att1 => { AttributeName => $value, ..., KeyType => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::KeySchemaElement object:

$result = $service_obj->Method(...);
$result->Att1->AttributeName

DESCRIPTION

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

ATTRIBUTES

REQUIRED AttributeName => Str

The name of a key attribute.

REQUIRED KeyType => Str

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::DynamoDB

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues