Safe Haskell	None
Language	Haskell2010

Aws.DynamoDb.Commands.Table

Contents

Commands
Data passed in the commands

Synopsis

Commands

data CreateTable Source

Constructors

CreateTable
Fields createTableName :: Text createAttributeDefinitions :: [AttributeDefinition] only attributes appearing in a key must be listed here createKeySchema :: KeySchema createProvisionedThroughput :: ProvisionedThroughput createLocalSecondaryIndexes :: [LocalSecondaryIndex] at most 5 local secondary indices are allowed createGlobalSecondaryIndexes :: [GlobalSecondaryIndex]

Instances

Show CreateTable Source
Generic CreateTable Source
ToJSON CreateTable Source
SignQuery CreateTable Source	ServiceConfiguration: `DdbConfiguration`
Transaction CreateTable CreateTableResult Source
type Rep CreateTable Source
type ServiceConfiguration CreateTable = DdbConfiguration Source

createTable Source

Arguments

:: Text	Table name
-> [AttributeDefinition]
-> KeySchema
-> ProvisionedThroughput
-> CreateTable

data DescribeTable Source

Constructors

DescribeTable
Fields dTableName :: Text

Instances

data UpdateTable Source

Constructors

UpdateTable
Fields updateTableName :: Text updateProvisionedThroughput :: ProvisionedThroughput updateGlobalSecondaryIndexUpdates :: [GlobalSecondaryIndexUpdate]

Instances

Show UpdateTable Source
Generic UpdateTable Source
ToJSON UpdateTable Source
SignQuery UpdateTable Source	ServiceConfiguration: `DdbConfiguration`
Transaction UpdateTable UpdateTableResult Source
type Rep UpdateTable Source
type ServiceConfiguration UpdateTable = DdbConfiguration Source

data DeleteTable Source

Constructors

DeleteTable
Fields deleteTableName :: Text

Instances

Show DeleteTable Source
Generic DeleteTable Source
ToJSON DeleteTable Source
SignQuery DeleteTable Source	ServiceConfiguration: `DdbConfiguration`
Transaction DeleteTable DeleteTableResult Source
type Rep DeleteTable Source
type ServiceConfiguration DeleteTable = DdbConfiguration Source

data ListTables Source

TODO: currently this does not support restarting a cutoff query because of size.

Constructors

ListTables

Instances

Show ListTables Source
ToJSON ListTables Source
SignQuery ListTables Source	ServiceConfiguration: `DdbConfiguration`
Transaction ListTables ListTablesResult Source
type ServiceConfiguration ListTables = DdbConfiguration Source

newtype ListTablesResult Source

Constructors

ListTablesResult
Fields tableNames :: [Text]

Data passed in the commands

data AttributeType Source

The type of a key attribute that appears in the table key or as a key in one of the indices.

Constructors

AttrString
AttrNumber
AttrBinary

data AttributeDefinition Source

A key attribute that appears in the table key or as a key in one of the indices.

Constructors

AttributeDefinition
Fields attributeName :: Text attributeType :: AttributeType

data KeySchema Source

The key schema can either be a hash of a single attribute name or a hash attribute name and a range attribute name.

Constructors

HashOnly Text
HashAndRange Text Text

data Projection Source

This determines which attributes are projected into a secondary index.

Constructors

ProjectKeysOnly
ProjectAll
ProjectInclude [Text]

Instances

Show Projection Source
ToJSON Projection Source
FromJSON Projection Source

data LocalSecondaryIndex Source

Describes a single local secondary index. The KeySchema MUST share the same hash key attribute as the parent table, only the range key can differ.

Constructors

LocalSecondaryIndex
Fields localIndexName :: Text localKeySchema :: KeySchema localProjection :: Projection

Instances

Show LocalSecondaryIndex Source
Generic LocalSecondaryIndex Source
ToJSON LocalSecondaryIndex Source
FromJSON LocalSecondaryIndex Source
type Rep LocalSecondaryIndex Source

data LocalSecondaryIndexStatus Source

This is returned by AWS to describe the local secondary index.

Constructors

LocalSecondaryIndexStatus
Fields locStatusIndexName :: Text locStatusIndexSizeBytes :: Integer locStatusItemCount :: Integer locStatusKeySchema :: KeySchema locStatusProjection :: Projection

Instances

Show LocalSecondaryIndexStatus Source
Generic LocalSecondaryIndexStatus Source
FromJSON LocalSecondaryIndexStatus Source
type Rep LocalSecondaryIndexStatus Source

data ProvisionedThroughput Source

The target provisioned throughput you are requesting for the table or global secondary index.

Constructors

ProvisionedThroughput
Fields readCapacityUnits :: Int writeCapacityUnits :: Int

Instances

Show ProvisionedThroughput Source
Generic ProvisionedThroughput Source
ToJSON ProvisionedThroughput Source
FromJSON ProvisionedThroughput Source
type Rep ProvisionedThroughput Source

data ProvisionedThroughputStatus Source

This is returned by AWS as the status of the throughput for a table or global secondary index.

Constructors

ProvisionedThroughputStatus
Fields statusLastDecreaseDateTime :: UTCTime statusLastIncreaseDateTime :: UTCTime statusNumberOfDecreasesToday :: Int statusReadCapacityUnits :: Int statusWriteCapacityUnits :: Int

Instances

Show ProvisionedThroughputStatus Source
Generic ProvisionedThroughputStatus Source
FromJSON ProvisionedThroughputStatus Source
type Rep ProvisionedThroughputStatus Source

data GlobalSecondaryIndex Source

Describes a global secondary index.

Constructors

GlobalSecondaryIndex
Fields globalIndexName :: Text globalKeySchema :: KeySchema globalProjection :: Projection globalProvisionedThroughput :: ProvisionedThroughput

Instances

Show GlobalSecondaryIndex Source
Generic GlobalSecondaryIndex Source
ToJSON GlobalSecondaryIndex Source
FromJSON GlobalSecondaryIndex Source
type Rep GlobalSecondaryIndex Source

data GlobalSecondaryIndexStatus Source

This is returned by AWS to describe the status of a global secondary index.

Constructors

GlobalSecondaryIndexStatus
Fields gStatusIndexName :: Text gStatusIndexSizeBytes :: Integer gStatusIndexStatus :: Text gStatusItemCount :: Integer gStatusKeySchema :: KeySchema gStatusProjection :: Projection gStatusProvisionedThroughput :: ProvisionedThroughputStatus

Instances

Show GlobalSecondaryIndexStatus Source
Generic GlobalSecondaryIndexStatus Source
FromJSON GlobalSecondaryIndexStatus Source
type Rep GlobalSecondaryIndexStatus Source

data GlobalSecondaryIndexUpdate Source

This is used to request a change in the provisioned throughput of a global secondary index as part of an UpdateTable operation.

Constructors

GlobalSecondaryIndexUpdate
Fields gUpdateIndexName :: Text gUpdateProvisionedThroughput :: ProvisionedThroughput

Instances

Show GlobalSecondaryIndexUpdate Source
Generic GlobalSecondaryIndexUpdate Source
ToJSON GlobalSecondaryIndexUpdate Source
type Rep GlobalSecondaryIndexUpdate Source

data TableDescription Source

This describes the table and is the return value from AWS for all the table-related commands.

Constructors

TableDescription

Fields

rTableName :: Text
rTableSizeBytes :: Integer
rTableStatus :: Text: one of CREATING, UPDATING, DELETING, ACTIVE
rCreationDateTime :: Maybe UTCTime
rItemCount :: Integer
rAttributeDefinitions :: [AttributeDefinition]
rKeySchema :: Maybe KeySchema
rProvisionedThroughput :: ProvisionedThroughputStatus
rLocalSecondaryIndexes :: [LocalSecondaryIndexStatus]
rGlobalSecondaryIndexes :: [GlobalSecondaryIndexStatus]

Instances

Show TableDescription Source
Generic TableDescription Source
FromJSON TableDescription Source
type Rep TableDescription Source

Show CreateTableResult Source
FromJSON CreateTableResult Source
AsMemoryResponse CreateTableResult Source
Transaction CreateTable CreateTableResult Source
ResponseConsumer r CreateTableResult Source
type MemoryResponse CreateTableResult = TableDescription Source
type ResponseMetadata CreateTableResult = DdbResponse Source

Show DescribeTable Source
Generic DescribeTable Source
ToJSON DescribeTable Source
SignQuery DescribeTable Source	ServiceConfiguration: `DdbConfiguration`
Transaction DescribeTable DescribeTableResult Source
type Rep DescribeTable Source
type ServiceConfiguration DescribeTable = DdbConfiguration Source

Show DescribeTableResult Source
FromJSON DescribeTableResult Source
AsMemoryResponse DescribeTableResult Source
Transaction DescribeTable DescribeTableResult Source
ResponseConsumer r DescribeTableResult Source
type MemoryResponse DescribeTableResult = TableDescription Source
type ResponseMetadata DescribeTableResult = DdbResponse Source

Show UpdateTableResult Source
FromJSON UpdateTableResult Source
AsMemoryResponse UpdateTableResult Source
Transaction UpdateTable UpdateTableResult Source
ResponseConsumer r UpdateTableResult Source
type MemoryResponse UpdateTableResult = TableDescription Source
type ResponseMetadata UpdateTableResult = DdbResponse Source

Show DeleteTableResult Source
FromJSON DeleteTableResult Source
AsMemoryResponse DeleteTableResult Source
Transaction DeleteTable DeleteTableResult Source
ResponseConsumer r DeleteTableResult Source
type MemoryResponse DeleteTableResult = TableDescription Source
type ResponseMetadata DeleteTableResult = DdbResponse Source

Show ListTablesResult Source
Generic ListTablesResult Source
FromJSON ListTablesResult Source
AsMemoryResponse ListTablesResult Source
Transaction ListTables ListTablesResult Source
ResponseConsumer r ListTablesResult Source
type Rep ListTablesResult Source
type MemoryResponse ListTablesResult = [Text] Source
type ResponseMetadata ListTablesResult = DdbResponse Source

Bounded AttributeType Source
Enum AttributeType Source
Eq AttributeType Source
Ord AttributeType Source
Read AttributeType Source
Show AttributeType Source
Generic AttributeType Source
ToJSON AttributeType Source
FromJSON AttributeType Source
type Rep AttributeType Source

Eq AttributeDefinition Source
Ord AttributeDefinition Source
Read AttributeDefinition Source
Show AttributeDefinition Source
Generic AttributeDefinition Source
ToJSON AttributeDefinition Source
FromJSON AttributeDefinition Source
type Rep AttributeDefinition Source

Eq KeySchema Source
Ord KeySchema Source
Read KeySchema Source
Show KeySchema Source
Generic KeySchema Source
ToJSON KeySchema Source
FromJSON KeySchema Source
type Rep KeySchema Source