Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Documentation

data LocalSecondaryIndexDescription

Represents the properties of a local secondary index.

See: newLocalSecondaryIndexDescription smart constructor.

Constructors

LocalSecondaryIndexDescription'

Fields

• indexArn :: Maybe Text

  The Amazon Resource Name (ARN) that uniquely identifies the index.

• indexName :: Maybe Text

  Represents the name of the local secondary index.

• indexSizeBytes :: Maybe Integer

  The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

• itemCount :: Maybe Integer

  The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

• keySchema :: Maybe (NonEmpty KeySchemaElement)

  The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • 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.

• projection :: Maybe Projection

  Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Instances

FromJSON LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

parseJSON :: Value -> Parser LocalSecondaryIndexDescription

parseJSONList :: Value -> Parser [LocalSecondaryIndexDescription]

Generic LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Associated Types

type Rep LocalSecondaryIndexDescription :: Type -> Type

Methods

from :: LocalSecondaryIndexDescription -> Rep LocalSecondaryIndexDescription x

to :: Rep LocalSecondaryIndexDescription x -> LocalSecondaryIndexDescription

Read LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

readsPrec :: Int -> ReadS LocalSecondaryIndexDescription

readList :: ReadS [LocalSecondaryIndexDescription]

readPrec :: ReadPrec LocalSecondaryIndexDescription

readListPrec :: ReadPrec [LocalSecondaryIndexDescription]

Show LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

showsPrec :: Int -> LocalSecondaryIndexDescription -> ShowS

show :: LocalSecondaryIndexDescription -> String

showList :: [LocalSecondaryIndexDescription] -> ShowS

NFData LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

rnf :: LocalSecondaryIndexDescription -> ()

Eq LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

(==) :: LocalSecondaryIndexDescription -> LocalSecondaryIndexDescription -> Bool

(/=) :: LocalSecondaryIndexDescription -> LocalSecondaryIndexDescription -> Bool

Hashable LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

Methods

hashWithSalt :: Int -> LocalSecondaryIndexDescription -> Int

hash :: LocalSecondaryIndexDescription -> Int

type Rep LocalSecondaryIndexDescription

Defined in Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription

type Rep LocalSecondaryIndexDescription = D1 ('MetaData "LocalSecondaryIndexDescription" "Amazonka.DynamoDB.Types.LocalSecondaryIndexDescription" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "LocalSecondaryIndexDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "indexArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "itemCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "keySchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty KeySchemaElement))) :*: S1 ('MetaSel ('Just "projection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Projection))))))

newLocalSecondaryIndexDescription :: LocalSecondaryIndexDescription

Create a value of LocalSecondaryIndexDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:indexArn:LocalSecondaryIndexDescription', localSecondaryIndexDescription_indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.

$sel:indexName:LocalSecondaryIndexDescription', localSecondaryIndexDescription_indexName - Represents the name of the local secondary index.

$sel:indexSizeBytes:LocalSecondaryIndexDescription', localSecondaryIndexDescription_indexSizeBytes - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

$sel:itemCount:LocalSecondaryIndexDescription', localSecondaryIndexDescription_itemCount - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

$sel:keySchema:LocalSecondaryIndexDescription', localSecondaryIndexDescription_keySchema - The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

• 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.

$sel:projection:LocalSecondaryIndexDescription', localSecondaryIndexDescription_projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

localSecondaryIndexDescription_indexArn :: Lens' LocalSecondaryIndexDescription (Maybe Text)

The Amazon Resource Name (ARN) that uniquely identifies the index.

localSecondaryIndexDescription_indexName :: Lens' LocalSecondaryIndexDescription (Maybe Text)

Represents the name of the local secondary index.

localSecondaryIndexDescription_indexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer)

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

localSecondaryIndexDescription_itemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer)

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

localSecondaryIndexDescription_keySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement))

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

• 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.

localSecondaryIndexDescription_projection :: Lens' LocalSecondaryIndexDescription (Maybe Projection)

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.