amazonka-dynamodb-1.4.5: Amazon DynamoDB SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DynamoDB

Contents

Description

Amazon DynamoDB

This is the Amazon DynamoDB API Reference. This guide provides descriptions of the low-level DynamoDB API.

This guide is intended for use with the following DynamoDB documentation:

Instead of making the requests to the low-level DynamoDB API directly from your application, we recommend that you use the AWS Software Development Kits (SDKs). The easy-to-use libraries in the AWS SDKs make it unnecessary to call the low-level DynamoDB API directly from your application. The libraries take care of request authentication, serialization, and connection management. For more information, see Using the AWS SDKs with DynamoDB in the Amazon DynamoDB Developer Guide.

If you decide to code against the low-level DynamoDB API directly, you will need to write the necessary code to authenticate your requests. For more information on signing your requests, see Using the DynamoDB API in the Amazon DynamoDB Developer Guide .

The following are short descriptions of each low-level API action, organized by function.

Managing Tables

  • CreateTable - Creates a table with user-specified provisioned throughput settings. You must define a primary key for the table - either a simple primary key (partition key), or a composite primary key (partition key and sort key). Optionally, you can create one or more secondary indexes, which provide fast data access using non-key attributes.
  • DescribeTable - Returns metadata for a table, such as table size, status, and index information.
  • UpdateTable - Modifies the provisioned throughput settings for a table. Optionally, you can modify the provisioned throughput settings for global secondary indexes on the table.
  • ListTables - Returns a list of all tables associated with the current AWS account and endpoint.
  • DeleteTable - Deletes a table and all of its indexes.

For conceptual information about managing tables, see Working with Tables in the Amazon DynamoDB Developer Guide .

Reading Data

  • GetItem - Returns a set of attributes for the item that has a given primary key. By default, GetItem performs an eventually consistent read; however, applications can request a strongly consistent read instead.
  • BatchGetItem - Performs multiple GetItem requests for data items using their primary keys, from one table or multiple tables. The response from BatchGetItem has a size limit of 16 MB and returns a maximum of 100 items. Both eventually consistent and strongly consistent reads can be used.
  • Query - Returns one or more items from a table or a secondary index. You must provide a specific value for the partition key. You can narrow the scope of the query using comparison operators against a sort key value, or on the index key. Query supports either eventual or strong consistency. A single response has a size limit of 1 MB.
  • Scan - Reads every item in a table; the result set is eventually consistent. You can limit the number of items returned by filtering the data attributes, using conditional expressions. Scan can be used to enable ad-hoc querying of a table against non-key attributes; however, since this is a full table scan without using an index, Scan should not be used for any application query use case that requires predictable performance.

For conceptual information about reading data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide .

Modifying Data

  • PutItem - Creates a new item, or replaces an existing item with a new item (including all the attributes). By default, if an item in the table already exists with the same primary key, the new item completely replaces the existing item. You can use conditional operators to replace an item only if its attribute values match certain conditions, or to insert a new item only if that item doesn't already exist.
  • UpdateItem - Modifies the attributes of an existing item. You can also use conditional operators to perform an update only if the item's attribute values match certain conditions.
  • DeleteItem - Deletes an item in a table by primary key. You can use conditional operators to perform a delete an item only if the item's attribute values match certain conditions.
  • BatchWriteItem - Performs multiple PutItem and DeleteItem requests across multiple tables in a single request. A failure of any request(s) in the batch will not cause the entire BatchWriteItem operation to fail. Supports batches of up to 25 items to put or delete, with a maximum total request size of 16 MB.

For conceptual information about modifying data, see Working with Items and Query and Scan Operations in the Amazon DynamoDB Developer Guide .

Synopsis

Service Configuration

dynamoDB :: Service #

API version 2012-08-10 of the Amazon DynamoDB SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by DynamoDB.

ProvisionedThroughputExceededException

_ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide .

ConditionalCheckFailedException

_ConditionalCheckFailedException :: AsError a => Getting (First ServiceError) a ServiceError #

A condition specified in the operation could not be evaluated.

ItemCollectionSizeLimitExceededException

_ItemCollectionSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

InternalServerError

_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError #

An error occurred on the server side.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE .

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #

The number of concurrent table requests (cumulative number of tables in the CREATING , DELETING or UPDATING state) exceeds the maximum allowed of 10.

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

The total limit of tables in the ACTIVE state is 250.

ResourceInUseException

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError #

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

TableNotExists

tableNotExists :: Wait DescribeTable #

Polls DescribeTable every 20 seconds until a successful state is reached. An error is returned after 25 failed checks.

TableExists

tableExists :: Wait DescribeTable #

Polls DescribeTable every 20 seconds until a successful state is reached. An error is returned after 25 failed checks.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

PutItem

DeleteItem

UpdateItem

DeleteTable

UpdateTable

BatchGetItem

DescribeTable

DescribeLimits

GetItem

BatchWriteItem

ListTables (Paginated)

Scan (Paginated)

Query (Paginated)

CreateTable

Types

AttributeAction

data AttributeAction #

Constructors

Add 
Delete 
Put 

Instances

Bounded AttributeAction # 
Enum AttributeAction # 
Eq AttributeAction # 
Data AttributeAction # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeAction -> c AttributeAction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeAction #

toConstr :: AttributeAction -> Constr #

dataTypeOf :: AttributeAction -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeAction) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeAction) #

gmapT :: (forall b. Data b => b -> b) -> AttributeAction -> AttributeAction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeAction -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeAction -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeAction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeAction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeAction -> m AttributeAction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeAction -> m AttributeAction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeAction -> m AttributeAction #

Ord AttributeAction # 
Read AttributeAction # 
Show AttributeAction # 
Generic AttributeAction # 
Hashable AttributeAction # 
ToJSON AttributeAction # 
NFData AttributeAction # 

Methods

rnf :: AttributeAction -> () #

ToQuery AttributeAction # 
ToHeader AttributeAction # 
ToByteString AttributeAction # 
FromText AttributeAction # 
ToText AttributeAction # 
type Rep AttributeAction # 
type Rep AttributeAction = D1 (MetaData "AttributeAction" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "Add" PrefixI False) U1) ((:+:) (C1 (MetaCons "Delete" PrefixI False) U1) (C1 (MetaCons "Put" PrefixI False) U1)))

ComparisonOperator

data ComparisonOperator #

Instances

Bounded ComparisonOperator # 
Enum ComparisonOperator # 
Eq ComparisonOperator # 
Data ComparisonOperator # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ComparisonOperator -> c ComparisonOperator #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ComparisonOperator #

toConstr :: ComparisonOperator -> Constr #

dataTypeOf :: ComparisonOperator -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ComparisonOperator) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ComparisonOperator) #

gmapT :: (forall b. Data b => b -> b) -> ComparisonOperator -> ComparisonOperator #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ComparisonOperator -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ComparisonOperator -> r #

gmapQ :: (forall d. Data d => d -> u) -> ComparisonOperator -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ComparisonOperator -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ComparisonOperator -> m ComparisonOperator #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ComparisonOperator -> m ComparisonOperator #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ComparisonOperator -> m ComparisonOperator #

Ord ComparisonOperator # 
Read ComparisonOperator # 
Show ComparisonOperator # 
Generic ComparisonOperator # 
Hashable ComparisonOperator # 
ToJSON ComparisonOperator # 
NFData ComparisonOperator # 

Methods

rnf :: ComparisonOperator -> () #

ToQuery ComparisonOperator # 
ToHeader ComparisonOperator # 
ToByteString ComparisonOperator # 
FromText ComparisonOperator # 
ToText ComparisonOperator # 
type Rep ComparisonOperator # 
type Rep ComparisonOperator = D1 (MetaData "ComparisonOperator" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "BeginsWith" PrefixI False) U1) ((:+:) (C1 (MetaCons "Between" PrefixI False) U1) (C1 (MetaCons "Contains" PrefixI False) U1))) ((:+:) (C1 (MetaCons "EQ'" PrefixI False) U1) ((:+:) (C1 (MetaCons "GE" PrefixI False) U1) (C1 (MetaCons "GT'" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "IN" PrefixI False) U1) ((:+:) (C1 (MetaCons "LE" PrefixI False) U1) (C1 (MetaCons "LT'" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "NE" PrefixI False) U1) (C1 (MetaCons "NotContains" PrefixI False) U1)) ((:+:) (C1 (MetaCons "NotNull" PrefixI False) U1) (C1 (MetaCons "Null" PrefixI False) U1)))))

ConditionalOperator

data ConditionalOperator #

Constructors

And 
OR 

Instances

Bounded ConditionalOperator # 
Enum ConditionalOperator # 
Eq ConditionalOperator # 
Data ConditionalOperator # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConditionalOperator -> c ConditionalOperator #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConditionalOperator #

toConstr :: ConditionalOperator -> Constr #

dataTypeOf :: ConditionalOperator -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConditionalOperator) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConditionalOperator) #

gmapT :: (forall b. Data b => b -> b) -> ConditionalOperator -> ConditionalOperator #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConditionalOperator -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConditionalOperator -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConditionalOperator -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConditionalOperator -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConditionalOperator -> m ConditionalOperator #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConditionalOperator -> m ConditionalOperator #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConditionalOperator -> m ConditionalOperator #

Ord ConditionalOperator # 
Read ConditionalOperator # 
Show ConditionalOperator # 
Generic ConditionalOperator # 
Hashable ConditionalOperator # 
ToJSON ConditionalOperator # 
NFData ConditionalOperator # 

Methods

rnf :: ConditionalOperator -> () #

ToQuery ConditionalOperator # 
ToHeader ConditionalOperator # 
ToByteString ConditionalOperator # 
FromText ConditionalOperator # 
ToText ConditionalOperator # 
type Rep ConditionalOperator # 
type Rep ConditionalOperator = D1 (MetaData "ConditionalOperator" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "And" PrefixI False) U1) (C1 (MetaCons "OR" PrefixI False) U1))

IndexStatus

data IndexStatus #

Instances

Bounded IndexStatus # 
Enum IndexStatus # 
Eq IndexStatus # 
Data IndexStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IndexStatus -> c IndexStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IndexStatus #

toConstr :: IndexStatus -> Constr #

dataTypeOf :: IndexStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IndexStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IndexStatus) #

gmapT :: (forall b. Data b => b -> b) -> IndexStatus -> IndexStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IndexStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IndexStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> IndexStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IndexStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IndexStatus -> m IndexStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexStatus -> m IndexStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IndexStatus -> m IndexStatus #

Ord IndexStatus # 
Read IndexStatus # 
Show IndexStatus # 
Generic IndexStatus # 

Associated Types

type Rep IndexStatus :: * -> * #

Hashable IndexStatus # 
FromJSON IndexStatus # 
NFData IndexStatus # 

Methods

rnf :: IndexStatus -> () #

ToQuery IndexStatus # 
ToHeader IndexStatus # 
ToByteString IndexStatus # 
FromText IndexStatus # 
ToText IndexStatus # 

Methods

toText :: IndexStatus -> Text #

type Rep IndexStatus # 
type Rep IndexStatus = D1 (MetaData "IndexStatus" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) (C1 (MetaCons "ISActive" PrefixI False) U1) (C1 (MetaCons "ISCreating" PrefixI False) U1)) ((:+:) (C1 (MetaCons "ISDeleting" PrefixI False) U1) (C1 (MetaCons "ISUpdating" PrefixI False) U1)))

KeyType

data KeyType #

Constructors

Hash 
Range 

Instances

Bounded KeyType # 
Enum KeyType # 
Eq KeyType # 

Methods

(==) :: KeyType -> KeyType -> Bool #

(/=) :: KeyType -> KeyType -> Bool #

Data KeyType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeyType -> c KeyType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeyType #

toConstr :: KeyType -> Constr #

dataTypeOf :: KeyType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c KeyType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeyType) #

gmapT :: (forall b. Data b => b -> b) -> KeyType -> KeyType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeyType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeyType -> r #

gmapQ :: (forall d. Data d => d -> u) -> KeyType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> KeyType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeyType -> m KeyType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyType -> m KeyType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyType -> m KeyType #

Ord KeyType # 
Read KeyType # 
Show KeyType # 
Generic KeyType # 

Associated Types

type Rep KeyType :: * -> * #

Methods

from :: KeyType -> Rep KeyType x #

to :: Rep KeyType x -> KeyType #

Hashable KeyType # 

Methods

hashWithSalt :: Int -> KeyType -> Int #

hash :: KeyType -> Int #

ToJSON KeyType # 
FromJSON KeyType # 
NFData KeyType # 

Methods

rnf :: KeyType -> () #

ToQuery KeyType # 
ToHeader KeyType # 

Methods

toHeader :: HeaderName -> KeyType -> [Header] #

ToByteString KeyType # 

Methods

toBS :: KeyType -> ByteString #

FromText KeyType # 
ToText KeyType # 

Methods

toText :: KeyType -> Text #

type Rep KeyType # 
type Rep KeyType = D1 (MetaData "KeyType" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "Hash" PrefixI False) U1) (C1 (MetaCons "Range" PrefixI False) U1))

ProjectionType

data ProjectionType #

Constructors

All 
Include 
KeysOnly 

Instances

Bounded ProjectionType # 
Enum ProjectionType # 
Eq ProjectionType # 
Data ProjectionType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectionType -> c ProjectionType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectionType #

toConstr :: ProjectionType -> Constr #

dataTypeOf :: ProjectionType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProjectionType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectionType) #

gmapT :: (forall b. Data b => b -> b) -> ProjectionType -> ProjectionType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectionType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectionType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectionType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectionType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectionType -> m ProjectionType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectionType -> m ProjectionType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectionType -> m ProjectionType #

Ord ProjectionType # 
Read ProjectionType # 
Show ProjectionType # 
Generic ProjectionType # 

Associated Types

type Rep ProjectionType :: * -> * #

Hashable ProjectionType # 
ToJSON ProjectionType # 
FromJSON ProjectionType # 
NFData ProjectionType # 

Methods

rnf :: ProjectionType -> () #

ToQuery ProjectionType # 
ToHeader ProjectionType # 
ToByteString ProjectionType # 
FromText ProjectionType # 
ToText ProjectionType # 
type Rep ProjectionType # 
type Rep ProjectionType = D1 (MetaData "ProjectionType" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "All" PrefixI False) U1) ((:+:) (C1 (MetaCons "Include" PrefixI False) U1) (C1 (MetaCons "KeysOnly" PrefixI False) U1)))

ReturnConsumedCapacity

data ReturnConsumedCapacity #

Determines the level of detail about provisioned throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem , do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
  • NONE - No ConsumedCapacity details are included in the response.

Constructors

RCCIndexes 
RCCNone 
RCCTotal 

Instances

Bounded ReturnConsumedCapacity # 
Enum ReturnConsumedCapacity # 
Eq ReturnConsumedCapacity # 
Data ReturnConsumedCapacity # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReturnConsumedCapacity -> c ReturnConsumedCapacity #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReturnConsumedCapacity #

toConstr :: ReturnConsumedCapacity -> Constr #

dataTypeOf :: ReturnConsumedCapacity -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReturnConsumedCapacity) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReturnConsumedCapacity) #

gmapT :: (forall b. Data b => b -> b) -> ReturnConsumedCapacity -> ReturnConsumedCapacity #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReturnConsumedCapacity -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReturnConsumedCapacity -> r #

gmapQ :: (forall d. Data d => d -> u) -> ReturnConsumedCapacity -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReturnConsumedCapacity -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReturnConsumedCapacity -> m ReturnConsumedCapacity #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnConsumedCapacity -> m ReturnConsumedCapacity #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnConsumedCapacity -> m ReturnConsumedCapacity #

Ord ReturnConsumedCapacity # 
Read ReturnConsumedCapacity # 
Show ReturnConsumedCapacity # 
Generic ReturnConsumedCapacity # 
Hashable ReturnConsumedCapacity # 
ToJSON ReturnConsumedCapacity # 
NFData ReturnConsumedCapacity # 

Methods

rnf :: ReturnConsumedCapacity -> () #

ToQuery ReturnConsumedCapacity # 
ToHeader ReturnConsumedCapacity # 
ToByteString ReturnConsumedCapacity # 
FromText ReturnConsumedCapacity # 
ToText ReturnConsumedCapacity # 
type Rep ReturnConsumedCapacity # 
type Rep ReturnConsumedCapacity = D1 (MetaData "ReturnConsumedCapacity" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "RCCIndexes" PrefixI False) U1) ((:+:) (C1 (MetaCons "RCCNone" PrefixI False) U1) (C1 (MetaCons "RCCTotal" PrefixI False) U1)))

ReturnItemCollectionMetrics

data ReturnItemCollectionMetrics #

Constructors

RICMNone 
RICMSize 

Instances

Bounded ReturnItemCollectionMetrics # 
Enum ReturnItemCollectionMetrics # 
Eq ReturnItemCollectionMetrics # 
Data ReturnItemCollectionMetrics # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReturnItemCollectionMetrics -> c ReturnItemCollectionMetrics #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReturnItemCollectionMetrics #

toConstr :: ReturnItemCollectionMetrics -> Constr #

dataTypeOf :: ReturnItemCollectionMetrics -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReturnItemCollectionMetrics) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReturnItemCollectionMetrics) #

gmapT :: (forall b. Data b => b -> b) -> ReturnItemCollectionMetrics -> ReturnItemCollectionMetrics #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReturnItemCollectionMetrics -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReturnItemCollectionMetrics -> r #

gmapQ :: (forall d. Data d => d -> u) -> ReturnItemCollectionMetrics -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReturnItemCollectionMetrics -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReturnItemCollectionMetrics -> m ReturnItemCollectionMetrics #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnItemCollectionMetrics -> m ReturnItemCollectionMetrics #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnItemCollectionMetrics -> m ReturnItemCollectionMetrics #

Ord ReturnItemCollectionMetrics # 
Read ReturnItemCollectionMetrics # 
Show ReturnItemCollectionMetrics # 
Generic ReturnItemCollectionMetrics # 
Hashable ReturnItemCollectionMetrics # 
ToJSON ReturnItemCollectionMetrics # 
NFData ReturnItemCollectionMetrics # 
ToQuery ReturnItemCollectionMetrics # 
ToHeader ReturnItemCollectionMetrics # 
ToByteString ReturnItemCollectionMetrics # 
FromText ReturnItemCollectionMetrics # 
ToText ReturnItemCollectionMetrics # 
type Rep ReturnItemCollectionMetrics # 
type Rep ReturnItemCollectionMetrics = D1 (MetaData "ReturnItemCollectionMetrics" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "RICMNone" PrefixI False) U1) (C1 (MetaCons "RICMSize" PrefixI False) U1))

ReturnValue

data ReturnValue #

Instances

Bounded ReturnValue # 
Enum ReturnValue # 
Eq ReturnValue # 
Data ReturnValue # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReturnValue -> c ReturnValue #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReturnValue #

toConstr :: ReturnValue -> Constr #

dataTypeOf :: ReturnValue -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ReturnValue) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReturnValue) #

gmapT :: (forall b. Data b => b -> b) -> ReturnValue -> ReturnValue #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReturnValue -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReturnValue -> r #

gmapQ :: (forall d. Data d => d -> u) -> ReturnValue -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ReturnValue -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReturnValue -> m ReturnValue #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnValue -> m ReturnValue #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReturnValue -> m ReturnValue #

Ord ReturnValue # 
Read ReturnValue # 
Show ReturnValue # 
Generic ReturnValue # 

Associated Types

type Rep ReturnValue :: * -> * #

Hashable ReturnValue # 
ToJSON ReturnValue # 
NFData ReturnValue # 

Methods

rnf :: ReturnValue -> () #

ToQuery ReturnValue # 
ToHeader ReturnValue # 
ToByteString ReturnValue # 
FromText ReturnValue # 
ToText ReturnValue # 

Methods

toText :: ReturnValue -> Text #

type Rep ReturnValue # 
type Rep ReturnValue = D1 (MetaData "ReturnValue" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) (C1 (MetaCons "AllNew" PrefixI False) U1) (C1 (MetaCons "AllOld" PrefixI False) U1)) ((:+:) (C1 (MetaCons "None" PrefixI False) U1) ((:+:) (C1 (MetaCons "UpdatedNew" PrefixI False) U1) (C1 (MetaCons "UpdatedOld" PrefixI False) U1))))

ScalarAttributeType

data ScalarAttributeType #

Constructors

B 
N 
S 

Instances

Bounded ScalarAttributeType # 
Enum ScalarAttributeType # 
Eq ScalarAttributeType # 
Data ScalarAttributeType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScalarAttributeType -> c ScalarAttributeType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScalarAttributeType #

toConstr :: ScalarAttributeType -> Constr #

dataTypeOf :: ScalarAttributeType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScalarAttributeType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScalarAttributeType) #

gmapT :: (forall b. Data b => b -> b) -> ScalarAttributeType -> ScalarAttributeType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScalarAttributeType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScalarAttributeType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScalarAttributeType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScalarAttributeType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScalarAttributeType -> m ScalarAttributeType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScalarAttributeType -> m ScalarAttributeType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScalarAttributeType -> m ScalarAttributeType #

Ord ScalarAttributeType # 
Read ScalarAttributeType # 
Show ScalarAttributeType # 
Generic ScalarAttributeType # 
Hashable ScalarAttributeType # 
ToJSON ScalarAttributeType # 
FromJSON ScalarAttributeType # 
NFData ScalarAttributeType # 

Methods

rnf :: ScalarAttributeType -> () #

ToQuery ScalarAttributeType # 
ToHeader ScalarAttributeType # 
ToByteString ScalarAttributeType # 
FromText ScalarAttributeType # 
ToText ScalarAttributeType # 
type Rep ScalarAttributeType # 
type Rep ScalarAttributeType = D1 (MetaData "ScalarAttributeType" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) (C1 (MetaCons "B" PrefixI False) U1) ((:+:) (C1 (MetaCons "N" PrefixI False) U1) (C1 (MetaCons "S" PrefixI False) U1)))

Select

data Select #

Instances

Bounded Select # 
Enum Select # 
Eq Select # 

Methods

(==) :: Select -> Select -> Bool #

(/=) :: Select -> Select -> Bool #

Data Select # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Select -> c Select #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Select #

toConstr :: Select -> Constr #

dataTypeOf :: Select -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Select) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Select) #

gmapT :: (forall b. Data b => b -> b) -> Select -> Select #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Select -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Select -> r #

gmapQ :: (forall d. Data d => d -> u) -> Select -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Select -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Select -> m Select #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Select -> m Select #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Select -> m Select #

Ord Select # 
Read Select # 
Show Select # 
Generic Select # 

Associated Types

type Rep Select :: * -> * #

Methods

from :: Select -> Rep Select x #

to :: Rep Select x -> Select #

Hashable Select # 

Methods

hashWithSalt :: Int -> Select -> Int #

hash :: Select -> Int #

ToJSON Select # 
NFData Select # 

Methods

rnf :: Select -> () #

ToQuery Select # 
ToHeader Select # 

Methods

toHeader :: HeaderName -> Select -> [Header] #

ToByteString Select # 

Methods

toBS :: Select -> ByteString #

FromText Select # 

Methods

parser :: Parser Select #

ToText Select # 

Methods

toText :: Select -> Text #

type Rep Select # 
type Rep Select = D1 (MetaData "Select" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) (C1 (MetaCons "AllAttributes" PrefixI False) U1) (C1 (MetaCons "AllProjectedAttributes" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Count" PrefixI False) U1) (C1 (MetaCons "SpecificAttributes" PrefixI False) U1)))

StreamViewType

data StreamViewType #

Instances

Bounded StreamViewType # 
Enum StreamViewType # 
Eq StreamViewType # 
Data StreamViewType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StreamViewType -> c StreamViewType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StreamViewType #

toConstr :: StreamViewType -> Constr #

dataTypeOf :: StreamViewType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StreamViewType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StreamViewType) #

gmapT :: (forall b. Data b => b -> b) -> StreamViewType -> StreamViewType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StreamViewType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StreamViewType -> r #

gmapQ :: (forall d. Data d => d -> u) -> StreamViewType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StreamViewType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StreamViewType -> m StreamViewType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamViewType -> m StreamViewType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamViewType -> m StreamViewType #

Ord StreamViewType # 
Read StreamViewType # 
Show StreamViewType # 
Generic StreamViewType # 

Associated Types

type Rep StreamViewType :: * -> * #

Hashable StreamViewType # 
ToJSON StreamViewType # 
FromJSON StreamViewType # 
NFData StreamViewType # 

Methods

rnf :: StreamViewType -> () #

ToQuery StreamViewType # 
ToHeader StreamViewType # 
ToByteString StreamViewType # 
FromText StreamViewType # 
ToText StreamViewType # 
type Rep StreamViewType # 
type Rep StreamViewType = D1 (MetaData "StreamViewType" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) (C1 (MetaCons "SVTKeysOnly" PrefixI False) U1) (C1 (MetaCons "SVTNewAndOldImages" PrefixI False) U1)) ((:+:) (C1 (MetaCons "SVTNewImage" PrefixI False) U1) (C1 (MetaCons "SVTOldImage" PrefixI False) U1)))

TableStatus

data TableStatus #

Constructors

Active 
Creating 
Deleting 
Updating 

Instances

Bounded TableStatus # 
Enum TableStatus # 
Eq TableStatus # 
Data TableStatus # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TableStatus -> c TableStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TableStatus #

toConstr :: TableStatus -> Constr #

dataTypeOf :: TableStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TableStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TableStatus) #

gmapT :: (forall b. Data b => b -> b) -> TableStatus -> TableStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TableStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TableStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> TableStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TableStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TableStatus -> m TableStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TableStatus -> m TableStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TableStatus -> m TableStatus #

Ord TableStatus # 
Read TableStatus # 
Show TableStatus # 
Generic TableStatus # 

Associated Types

type Rep TableStatus :: * -> * #

Hashable TableStatus # 
FromJSON TableStatus # 
NFData TableStatus # 

Methods

rnf :: TableStatus -> () #

ToQuery TableStatus # 
ToHeader TableStatus # 
ToByteString TableStatus # 
FromText TableStatus # 
ToText TableStatus # 

Methods

toText :: TableStatus -> Text #

type Rep TableStatus # 
type Rep TableStatus = D1 (MetaData "TableStatus" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) ((:+:) ((:+:) (C1 (MetaCons "Active" PrefixI False) U1) (C1 (MetaCons "Creating" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Deleting" PrefixI False) U1) (C1 (MetaCons "Updating" PrefixI False) U1)))

AttributeDefinition

data AttributeDefinition #

Represents an attribute for describing the key schema for the table and indexes.

See: attributeDefinition smart constructor.

Instances

Eq AttributeDefinition # 
Data AttributeDefinition # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeDefinition -> c AttributeDefinition #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeDefinition #

toConstr :: AttributeDefinition -> Constr #

dataTypeOf :: AttributeDefinition -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeDefinition) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeDefinition) #

gmapT :: (forall b. Data b => b -> b) -> AttributeDefinition -> AttributeDefinition #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeDefinition -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeDefinition -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeDefinition -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeDefinition -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeDefinition -> m AttributeDefinition #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeDefinition -> m AttributeDefinition #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeDefinition -> m AttributeDefinition #

Read AttributeDefinition # 
Show AttributeDefinition # 
Generic AttributeDefinition # 
Hashable AttributeDefinition # 
ToJSON AttributeDefinition # 
FromJSON AttributeDefinition # 
NFData AttributeDefinition # 

Methods

rnf :: AttributeDefinition -> () #

type Rep AttributeDefinition # 
type Rep AttributeDefinition = D1 (MetaData "AttributeDefinition" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "AttributeDefinition'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_adAttributeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_adAttributeType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ScalarAttributeType))))

attributeDefinition #

Creates a value of AttributeDefinition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • adAttributeName - A name for the attribute.
  • adAttributeType - The data type for the attribute, where: * S - the attribute is of type String * N - the attribute is of type Number * B - the attribute is of type Binary

adAttributeName :: Lens' AttributeDefinition Text #

A name for the attribute.

adAttributeType :: Lens' AttributeDefinition ScalarAttributeType #

The data type for the attribute, where: * S - the attribute is of type String * N - the attribute is of type Number * B - the attribute is of type Binary

AttributeValue

data AttributeValue #

Represents the data for an attribute. You can set one, and only one, of the elements.

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

See: attributeValue smart constructor.

Instances

Eq AttributeValue # 
Data AttributeValue # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeValue -> c AttributeValue #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeValue #

toConstr :: AttributeValue -> Constr #

dataTypeOf :: AttributeValue -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeValue) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeValue) #

gmapT :: (forall b. Data b => b -> b) -> AttributeValue -> AttributeValue #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeValue -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeValue -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeValue -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeValue -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeValue -> m AttributeValue #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeValue -> m AttributeValue #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeValue -> m AttributeValue #

Read AttributeValue # 
Show AttributeValue # 
Generic AttributeValue # 

Associated Types

type Rep AttributeValue :: * -> * #

Hashable AttributeValue # 
ToJSON AttributeValue # 
FromJSON AttributeValue # 
NFData AttributeValue # 

Methods

rnf :: AttributeValue -> () #

type Rep AttributeValue # 

attributeValue :: AttributeValue #

Creates a value of AttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • avL - A List of attribute values.
  • avNS - A Number Set data type.
  • avM - A Map of attribute values.
  • avNULL - A Null data type.
  • avN - A Number data type.
  • avBS - A Binary Set data type.
  • avB - A Binary data type.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.
  • avSS - A String Set data type.
  • avS - A String data type.
  • avBOOL - A Boolean data type.

avL :: Lens' AttributeValue [AttributeValue] #

A List of attribute values.

avNS :: Lens' AttributeValue [Text] #

A Number Set data type.

avM :: Lens' AttributeValue (HashMap Text AttributeValue) #

A Map of attribute values.

avNULL :: Lens' AttributeValue (Maybe Bool) #

A Null data type.

avN :: Lens' AttributeValue (Maybe Text) #

A Number data type.

avBS :: Lens' AttributeValue [ByteString] #

A Binary Set data type.

avB :: Lens' AttributeValue (Maybe ByteString) #

A Binary data type.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

avSS :: Lens' AttributeValue [Text] #

A String Set data type.

avS :: Lens' AttributeValue (Maybe Text) #

A String data type.

avBOOL :: Lens' AttributeValue (Maybe Bool) #

A Boolean data type.

AttributeValueUpdate

data AttributeValueUpdate #

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

See: attributeValueUpdate smart constructor.

Instances

Eq AttributeValueUpdate # 
Data AttributeValueUpdate # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AttributeValueUpdate -> c AttributeValueUpdate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AttributeValueUpdate #

toConstr :: AttributeValueUpdate -> Constr #

dataTypeOf :: AttributeValueUpdate -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AttributeValueUpdate) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AttributeValueUpdate) #

gmapT :: (forall b. Data b => b -> b) -> AttributeValueUpdate -> AttributeValueUpdate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AttributeValueUpdate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AttributeValueUpdate -> r #

gmapQ :: (forall d. Data d => d -> u) -> AttributeValueUpdate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AttributeValueUpdate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AttributeValueUpdate -> m AttributeValueUpdate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeValueUpdate -> m AttributeValueUpdate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AttributeValueUpdate -> m AttributeValueUpdate #

Read AttributeValueUpdate # 
Show AttributeValueUpdate # 
Generic AttributeValueUpdate # 
Hashable AttributeValueUpdate # 
ToJSON AttributeValueUpdate # 
NFData AttributeValueUpdate # 

Methods

rnf :: AttributeValueUpdate -> () #

type Rep AttributeValueUpdate # 
type Rep AttributeValueUpdate = D1 (MetaData "AttributeValueUpdate" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "AttributeValueUpdate'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_avuValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AttributeValue))) (S1 (MetaSel (Just Symbol "_avuAction") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AttributeAction)))))

attributeValueUpdate :: AttributeValueUpdate #

Creates a value of AttributeValueUpdate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • avuValue - Undocumented member.
  • avuAction - Specifies how to perform the update. Valid values are PUT (default), DELETE , and ADD . The behavior depends on whether the specified primary key already exists in the table. If an item with the specified Key is found in the table: * PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c] , then the final attribute value would be [b] . Specifying an empty set is an error. * ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: * If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2] , and the ADD action specified [3] , then the final attribute value would be [1,2,3] . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types. If no item with the specified Key is found: * PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * DELETE - Nothing happens; there is no attribute to delete. * ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction) #

Specifies how to perform the update. Valid values are PUT (default), DELETE , and ADD . The behavior depends on whether the specified primary key already exists in the table. If an item with the specified Key is found in the table: * PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value. * DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c] , then the final attribute value would be [b] . Specifying an empty set is an error. * ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute: * If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2] , and the ADD action specified [3] , then the final attribute value would be [1,2,3] . An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type. Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets. This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types. If no item with the specified Key is found: * PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute. * DELETE - Nothing happens; there is no attribute to delete. * ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

Capacity

data Capacity #

Represents the amount of provisioned throughput capacity consumed on a table or an index.

See: capacity smart constructor.

Instances

Eq Capacity # 
Data Capacity # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Capacity -> c Capacity #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Capacity #

toConstr :: Capacity -> Constr #

dataTypeOf :: Capacity -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Capacity) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Capacity) #

gmapT :: (forall b. Data b => b -> b) -> Capacity -> Capacity #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Capacity -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Capacity -> r #

gmapQ :: (forall d. Data d => d -> u) -> Capacity -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Capacity -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Capacity -> m Capacity #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Capacity -> m Capacity #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Capacity -> m Capacity #

Read Capacity # 
Show Capacity # 
Generic Capacity # 

Associated Types

type Rep Capacity :: * -> * #

Methods

from :: Capacity -> Rep Capacity x #

to :: Rep Capacity x -> Capacity #

Hashable Capacity # 

Methods

hashWithSalt :: Int -> Capacity -> Int #

hash :: Capacity -> Int #

FromJSON Capacity # 
NFData Capacity # 

Methods

rnf :: Capacity -> () #

type Rep Capacity # 
type Rep Capacity = D1 (MetaData "Capacity" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" True) (C1 (MetaCons "Capacity'" PrefixI True) (S1 (MetaSel (Just Symbol "_cCapacityUnits") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double))))

capacity :: Capacity #

Creates a value of Capacity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cCapacityUnits - The total number of capacity units consumed on a table or an index.

cCapacityUnits :: Lens' Capacity (Maybe Double) #

The total number of capacity units consumed on a table or an index.

Condition

data Condition #

Represents the selection criteria for a Query or Scan operation:

  • For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions , only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

Condition is also used in a QueryFilter , which evaluates the query results and returns only the desired values.

  • For a Scan operation, Condition is used in a ScanFilter , which evaluates the scan results and returns only the desired values.

See: condition smart constructor.

Instances

Eq Condition # 
Data Condition # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Condition -> c Condition #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Condition #

toConstr :: Condition -> Constr #

dataTypeOf :: Condition -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Condition) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Condition) #

gmapT :: (forall b. Data b => b -> b) -> Condition -> Condition #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Condition -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Condition -> r #

gmapQ :: (forall d. Data d => d -> u) -> Condition -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Condition -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Condition -> m Condition #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition -> m Condition #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Condition -> m Condition #

Read Condition # 
Show Condition # 
Generic Condition # 

Associated Types

type Rep Condition :: * -> * #

Hashable Condition # 
ToJSON Condition # 
NFData Condition # 

Methods

rnf :: Condition -> () #

type Rep Condition # 
type Rep Condition = D1 (MetaData "Condition" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "Condition'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cAttributeValueList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeValue]))) (S1 (MetaSel (Just Symbol "_cComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ComparisonOperator))))

condition #

Creates a value of Condition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cAttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A , and a is greater than B . For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
  • cComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. * EQ : Equal. EQ is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * NE : Not equal. NE is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps. * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * IN : Checks for matching elements within two sets. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not compare to {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} For usage examples of AttributeValueList and ComparisonOperator , see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide .

cAttributeValueList :: Lens' Condition [AttributeValue] #

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A , and a is greater than B . For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

cComparisonOperator :: Lens' Condition ComparisonOperator #

A comparator for evaluating attributes. For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. * EQ : Equal. EQ is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * NE : Not equal. NE is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps. * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * IN : Checks for matching elements within two sets. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not compare to {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} For usage examples of AttributeValueList and ComparisonOperator , see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide .

ConsumedCapacity

data ConsumedCapacity #

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide .

See: consumedCapacity smart constructor.

Instances

Eq ConsumedCapacity # 
Data ConsumedCapacity # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ConsumedCapacity -> c ConsumedCapacity #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ConsumedCapacity #

toConstr :: ConsumedCapacity -> Constr #

dataTypeOf :: ConsumedCapacity -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ConsumedCapacity) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ConsumedCapacity) #

gmapT :: (forall b. Data b => b -> b) -> ConsumedCapacity -> ConsumedCapacity #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ConsumedCapacity -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ConsumedCapacity -> r #

gmapQ :: (forall d. Data d => d -> u) -> ConsumedCapacity -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ConsumedCapacity -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ConsumedCapacity -> m ConsumedCapacity #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ConsumedCapacity -> m ConsumedCapacity #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ConsumedCapacity -> m ConsumedCapacity #

Read ConsumedCapacity # 
Show ConsumedCapacity # 
Generic ConsumedCapacity # 
Hashable ConsumedCapacity # 
FromJSON ConsumedCapacity # 
NFData ConsumedCapacity # 

Methods

rnf :: ConsumedCapacity -> () #

type Rep ConsumedCapacity # 
type Rep ConsumedCapacity = D1 (MetaData "ConsumedCapacity" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "ConsumedCapacity'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccGlobalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Capacity)))) (S1 (MetaSel (Just Symbol "_ccCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccLocalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Capacity)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccTable") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Capacity))) (S1 (MetaSel (Just Symbol "_ccTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

consumedCapacity :: ConsumedCapacity #

Creates a value of ConsumedCapacity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ccGlobalSecondaryIndexes - The amount of throughput consumed on each global index affected by the operation.
  • ccCapacityUnits - The total number of capacity units consumed by the operation.
  • ccLocalSecondaryIndexes - The amount of throughput consumed on each local index affected by the operation.
  • ccTable - The amount of throughput consumed on the table affected by the operation.
  • ccTableName - The name of the table that was affected by the operation.

ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) #

The amount of throughput consumed on each global index affected by the operation.

ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) #

The total number of capacity units consumed by the operation.

ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) #

The amount of throughput consumed on each local index affected by the operation.

ccTable :: Lens' ConsumedCapacity (Maybe Capacity) #

The amount of throughput consumed on the table affected by the operation.

ccTableName :: Lens' ConsumedCapacity (Maybe Text) #

The name of the table that was affected by the operation.

CreateGlobalSecondaryIndexAction

data CreateGlobalSecondaryIndexAction #

Represents a new global secondary index to be added to an existing table.

See: createGlobalSecondaryIndexAction smart constructor.

Instances

Eq CreateGlobalSecondaryIndexAction # 
Data CreateGlobalSecondaryIndexAction # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateGlobalSecondaryIndexAction -> c CreateGlobalSecondaryIndexAction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateGlobalSecondaryIndexAction #

toConstr :: CreateGlobalSecondaryIndexAction -> Constr #

dataTypeOf :: CreateGlobalSecondaryIndexAction -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateGlobalSecondaryIndexAction) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateGlobalSecondaryIndexAction) #

gmapT :: (forall b. Data b => b -> b) -> CreateGlobalSecondaryIndexAction -> CreateGlobalSecondaryIndexAction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateGlobalSecondaryIndexAction -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateGlobalSecondaryIndexAction -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateGlobalSecondaryIndexAction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateGlobalSecondaryIndexAction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateGlobalSecondaryIndexAction -> m CreateGlobalSecondaryIndexAction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGlobalSecondaryIndexAction -> m CreateGlobalSecondaryIndexAction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGlobalSecondaryIndexAction -> m CreateGlobalSecondaryIndexAction #

Read CreateGlobalSecondaryIndexAction # 
Show CreateGlobalSecondaryIndexAction # 
Generic CreateGlobalSecondaryIndexAction # 
Hashable CreateGlobalSecondaryIndexAction # 
ToJSON CreateGlobalSecondaryIndexAction # 
NFData CreateGlobalSecondaryIndexAction # 
type Rep CreateGlobalSecondaryIndexAction # 
type Rep CreateGlobalSecondaryIndexAction = D1 (MetaData "CreateGlobalSecondaryIndexAction" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "CreateGlobalSecondaryIndexAction'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgsiaIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cgsiaKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 KeySchemaElement)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgsiaProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Projection)) (S1 (MetaSel (Just Symbol "_cgsiaProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProvisionedThroughput)))))

createGlobalSecondaryIndexAction #

Creates a value of CreateGlobalSecondaryIndexAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cgsiaIndexName :: Lens' CreateGlobalSecondaryIndexAction Text #

The name of the global secondary index to be created.

cgsiaKeySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement) #

The key schema for the global secondary index.

DeleteGlobalSecondaryIndexAction

data DeleteGlobalSecondaryIndexAction #

Represents a global secondary index to be deleted from an existing table.

See: deleteGlobalSecondaryIndexAction smart constructor.

Instances

Eq DeleteGlobalSecondaryIndexAction # 
Data DeleteGlobalSecondaryIndexAction # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteGlobalSecondaryIndexAction -> c DeleteGlobalSecondaryIndexAction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteGlobalSecondaryIndexAction #

toConstr :: DeleteGlobalSecondaryIndexAction -> Constr #

dataTypeOf :: DeleteGlobalSecondaryIndexAction -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteGlobalSecondaryIndexAction) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteGlobalSecondaryIndexAction) #

gmapT :: (forall b. Data b => b -> b) -> DeleteGlobalSecondaryIndexAction -> DeleteGlobalSecondaryIndexAction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteGlobalSecondaryIndexAction -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteGlobalSecondaryIndexAction -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteGlobalSecondaryIndexAction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteGlobalSecondaryIndexAction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteGlobalSecondaryIndexAction -> m DeleteGlobalSecondaryIndexAction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteGlobalSecondaryIndexAction -> m DeleteGlobalSecondaryIndexAction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteGlobalSecondaryIndexAction -> m DeleteGlobalSecondaryIndexAction #

Read DeleteGlobalSecondaryIndexAction # 
Show DeleteGlobalSecondaryIndexAction # 
Generic DeleteGlobalSecondaryIndexAction # 
Hashable DeleteGlobalSecondaryIndexAction # 
ToJSON DeleteGlobalSecondaryIndexAction # 
NFData DeleteGlobalSecondaryIndexAction # 
type Rep DeleteGlobalSecondaryIndexAction # 
type Rep DeleteGlobalSecondaryIndexAction = D1 (MetaData "DeleteGlobalSecondaryIndexAction" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" True) (C1 (MetaCons "DeleteGlobalSecondaryIndexAction'" PrefixI True) (S1 (MetaSel (Just Symbol "_dgsiaIndexName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

deleteGlobalSecondaryIndexAction #

Creates a value of DeleteGlobalSecondaryIndexAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dgsiaIndexName - The name of the global secondary index to be deleted.

dgsiaIndexName :: Lens' DeleteGlobalSecondaryIndexAction Text #

The name of the global secondary index to be deleted.

DeleteRequest

data DeleteRequest #

Represents a request to perform a DeleteItem operation on an item.

See: deleteRequest smart constructor.

Instances

Eq DeleteRequest # 
Data DeleteRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteRequest -> c DeleteRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteRequest #

toConstr :: DeleteRequest -> Constr #

dataTypeOf :: DeleteRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteRequest) #

gmapT :: (forall b. Data b => b -> b) -> DeleteRequest -> DeleteRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteRequest -> m DeleteRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteRequest -> m DeleteRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteRequest -> m DeleteRequest #

Read DeleteRequest # 
Show DeleteRequest # 
Generic DeleteRequest # 

Associated Types

type Rep DeleteRequest :: * -> * #

Hashable DeleteRequest # 
ToJSON DeleteRequest # 
FromJSON DeleteRequest # 
NFData DeleteRequest # 

Methods

rnf :: DeleteRequest -> () #

type Rep DeleteRequest # 
type Rep DeleteRequest = D1 (MetaData "DeleteRequest" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" True) (C1 (MetaCons "DeleteRequest'" PrefixI True) (S1 (MetaSel (Just Symbol "_drKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text AttributeValue))))

deleteRequest :: DeleteRequest #

Creates a value of DeleteRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • drKey - A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

drKey :: Lens' DeleteRequest (HashMap Text AttributeValue) #

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

ExpectedAttributeValue

data ExpectedAttributeValue #

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem , PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

  • Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.
  • Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator . Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

See: expectedAttributeValue smart constructor.

Instances

Eq ExpectedAttributeValue # 
Data ExpectedAttributeValue # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExpectedAttributeValue -> c ExpectedAttributeValue #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExpectedAttributeValue #

toConstr :: ExpectedAttributeValue -> Constr #

dataTypeOf :: ExpectedAttributeValue -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExpectedAttributeValue) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExpectedAttributeValue) #

gmapT :: (forall b. Data b => b -> b) -> ExpectedAttributeValue -> ExpectedAttributeValue #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExpectedAttributeValue -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExpectedAttributeValue -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExpectedAttributeValue -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExpectedAttributeValue -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExpectedAttributeValue -> m ExpectedAttributeValue #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExpectedAttributeValue -> m ExpectedAttributeValue #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExpectedAttributeValue -> m ExpectedAttributeValue #

Read ExpectedAttributeValue # 
Show ExpectedAttributeValue # 
Generic ExpectedAttributeValue # 
Hashable ExpectedAttributeValue # 
ToJSON ExpectedAttributeValue # 
NFData ExpectedAttributeValue # 

Methods

rnf :: ExpectedAttributeValue -> () #

type Rep ExpectedAttributeValue # 
type Rep ExpectedAttributeValue = D1 (MetaData "ExpectedAttributeValue" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "ExpectedAttributeValue'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eavAttributeValueList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeValue]))) (S1 (MetaSel (Just Symbol "_eavExists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_eavValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AttributeValue))) (S1 (MetaSel (Just Symbol "_eavComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ComparisonOperator))))))

expectedAttributeValue :: ExpectedAttributeValue #

Creates a value of ExpectedAttributeValue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • eavAttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A , and a is greater than B . For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide .
  • eavExists - Causes DynamoDB to evaluate the value before attempting a conditional operation: * If Exists is true , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException . * If Exists is false , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException . The default setting for Exists is true . If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true , because it is implied. DynamoDB returns a ValidationException if: * Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.) * Exists is false but you also provide a Value . (You cannot expect an attribute to have a value, while also expecting it not to exist.)
  • eavValue - Undocumented member.
  • eavComparisonOperator - A comparator for evaluating attributes in the AttributeValueList . For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. * EQ : Equal. EQ is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * NE : Not equal. NE is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps. * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * IN : Checks for matching elements within two sets. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not compare to {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]}

eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue] #

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used. For type Number, value comparisons are numeric. String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A , and a is greater than B . For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters . For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values. For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide .

eavExists :: Lens' ExpectedAttributeValue (Maybe Bool) #

Causes DynamoDB to evaluate the value before attempting a conditional operation: * If Exists is true , DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException . * If Exists is false , DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException . The default setting for Exists is true . If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true , because it is implied. DynamoDB returns a ValidationException if: * Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.) * Exists is false but you also provide a Value . (You cannot expect an attribute to have a value, while also expecting it not to exist.)

eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator) #

A comparator for evaluating attributes in the AttributeValueList . For example, equals, greater than, less than, etc. The following comparison operators are available: EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN The following are descriptions of each comparison operator. * EQ : Equal. EQ is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * NE : Not equal. NE is supported for all datatypes, including lists and maps. AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not equal {NS:["6", "2", "1"]} . * LE : Less than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * LT : Less than. AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GE : Greater than or equal. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * GT : Greater than. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not equal {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]} . * NOT_NULL : The attribute exists. NOT_NULL is supported for all datatypes, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all datatypes, including lists and maps. * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it finds an exact match with any member of the set. CONTAINS is supported for lists: When evaluating "a CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set. AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS ", "NS ", or "BS "), then the operator evaluates to true if it does not find an exact match with any member of the set. NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b ", "a " can be a list; however, "b " cannot be a set, a map, or a list. * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type). * IN : Checks for matching elements within two sets. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true. * BETWEEN : Greater than or equal to the first value, and less than or equal to the second value. AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {S:"6"} does not compare to {N:"6"} . Also, {N:"6"} does not compare to {NS:["6", "2", "1"]}

GlobalSecondaryIndex

data GlobalSecondaryIndex #

Represents the properties of a global secondary index.

See: globalSecondaryIndex smart constructor.

Instances

Eq GlobalSecondaryIndex # 
Data GlobalSecondaryIndex # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GlobalSecondaryIndex -> c GlobalSecondaryIndex #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GlobalSecondaryIndex #

toConstr :: GlobalSecondaryIndex -> Constr #

dataTypeOf :: GlobalSecondaryIndex -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GlobalSecondaryIndex) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GlobalSecondaryIndex) #

gmapT :: (forall b. Data b => b -> b) -> GlobalSecondaryIndex -> GlobalSecondaryIndex #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndex -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndex -> r #

gmapQ :: (forall d. Data d => d -> u) -> GlobalSecondaryIndex -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GlobalSecondaryIndex -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndex -> m GlobalSecondaryIndex #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndex -> m GlobalSecondaryIndex #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndex -> m GlobalSecondaryIndex #

Read GlobalSecondaryIndex # 
Show GlobalSecondaryIndex # 
Generic GlobalSecondaryIndex # 
Hashable GlobalSecondaryIndex # 
ToJSON GlobalSecondaryIndex # 
NFData GlobalSecondaryIndex # 

Methods

rnf :: GlobalSecondaryIndex -> () #

type Rep GlobalSecondaryIndex # 
type Rep GlobalSecondaryIndex = D1 (MetaData "GlobalSecondaryIndex" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "GlobalSecondaryIndex'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gsiIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gsiKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 KeySchemaElement)))) ((:*:) (S1 (MetaSel (Just Symbol "_gsiProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Projection)) (S1 (MetaSel (Just Symbol "_gsiProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProvisionedThroughput)))))

globalSecondaryIndex #

Creates a value of GlobalSecondaryIndex with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gsiIndexName - The name of the global secondary index. The name must be unique among all other indexes on this table.
  • gsiKeySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * HASH - partition key * RANGE - sort key
  • gsiProjection - Undocumented member.
  • gsiProvisionedThroughput - Undocumented member.

gsiIndexName :: Lens' GlobalSecondaryIndex Text #

The name of the global secondary index. The name must be unique among all other indexes on this table.

gsiKeySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement) #

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * HASH - partition key * RANGE - sort key

GlobalSecondaryIndexDescription

data GlobalSecondaryIndexDescription #

Represents the properties of a global secondary index.

See: globalSecondaryIndexDescription smart constructor.

Instances

Eq GlobalSecondaryIndexDescription # 
Data GlobalSecondaryIndexDescription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GlobalSecondaryIndexDescription -> c GlobalSecondaryIndexDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GlobalSecondaryIndexDescription #

toConstr :: GlobalSecondaryIndexDescription -> Constr #

dataTypeOf :: GlobalSecondaryIndexDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GlobalSecondaryIndexDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GlobalSecondaryIndexDescription) #

gmapT :: (forall b. Data b => b -> b) -> GlobalSecondaryIndexDescription -> GlobalSecondaryIndexDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndexDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndexDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> GlobalSecondaryIndexDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GlobalSecondaryIndexDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexDescription -> m GlobalSecondaryIndexDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexDescription -> m GlobalSecondaryIndexDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexDescription -> m GlobalSecondaryIndexDescription #

Read GlobalSecondaryIndexDescription # 
Show GlobalSecondaryIndexDescription # 
Generic GlobalSecondaryIndexDescription # 
Hashable GlobalSecondaryIndexDescription # 
FromJSON GlobalSecondaryIndexDescription # 
NFData GlobalSecondaryIndexDescription # 
type Rep GlobalSecondaryIndexDescription # 

globalSecondaryIndexDescription :: GlobalSecondaryIndexDescription #

Creates a value of GlobalSecondaryIndexDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gsidBackfilling - Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
  • gsidIndexSizeBytes - 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.
  • gsidIndexStatus - The current state of the global secondary index: * CREATING - The index is being created. * UPDATING - The index is being updated. * DELETING - The index is being deleted. * ACTIVE - The index is ready for use.
  • gsidProvisionedThroughput - Undocumented member.
  • gsidIndexARN - The Amazon Resource Name (ARN) that uniquely identifies the index.
  • gsidKeySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * HASH - partition key * RANGE - sort key
  • gsidProjection - Undocumented member.
  • gsidItemCount - 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.
  • gsidIndexName - The name of the global secondary index.

gsidBackfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool) #

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (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.

gsidIndexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus) #

The current state of the global secondary index: * CREATING - The index is being created. * UPDATING - The index is being updated. * DELETING - The index is being deleted. * ACTIVE - The index is ready for use.

gsidIndexARN :: Lens' GlobalSecondaryIndexDescription (Maybe Text) #

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

gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) #

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: * HASH - partition key * RANGE - sort key

gsidItemCount :: Lens' GlobalSecondaryIndexDescription (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.

gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text) #

The name of the global secondary index.

GlobalSecondaryIndexUpdate

data GlobalSecondaryIndexUpdate #

Represents one of the following:

  • A new global secondary index to be added to an existing table.
  • New provisioned throughput parameters for an existing global secondary index.
  • An existing global secondary index to be removed from an existing table.

See: globalSecondaryIndexUpdate smart constructor.

Instances

Eq GlobalSecondaryIndexUpdate # 
Data GlobalSecondaryIndexUpdate # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GlobalSecondaryIndexUpdate -> c GlobalSecondaryIndexUpdate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GlobalSecondaryIndexUpdate #

toConstr :: GlobalSecondaryIndexUpdate -> Constr #

dataTypeOf :: GlobalSecondaryIndexUpdate -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GlobalSecondaryIndexUpdate) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GlobalSecondaryIndexUpdate) #

gmapT :: (forall b. Data b => b -> b) -> GlobalSecondaryIndexUpdate -> GlobalSecondaryIndexUpdate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndexUpdate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GlobalSecondaryIndexUpdate -> r #

gmapQ :: (forall d. Data d => d -> u) -> GlobalSecondaryIndexUpdate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GlobalSecondaryIndexUpdate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexUpdate -> m GlobalSecondaryIndexUpdate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexUpdate -> m GlobalSecondaryIndexUpdate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GlobalSecondaryIndexUpdate -> m GlobalSecondaryIndexUpdate #

Read GlobalSecondaryIndexUpdate # 
Show GlobalSecondaryIndexUpdate # 
Generic GlobalSecondaryIndexUpdate # 
Hashable GlobalSecondaryIndexUpdate # 
ToJSON GlobalSecondaryIndexUpdate # 
NFData GlobalSecondaryIndexUpdate # 
type Rep GlobalSecondaryIndexUpdate # 
type Rep GlobalSecondaryIndexUpdate = D1 (MetaData "GlobalSecondaryIndexUpdate" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "GlobalSecondaryIndexUpdate'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gsiuCreate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CreateGlobalSecondaryIndexAction))) ((:*:) (S1 (MetaSel (Just Symbol "_gsiuDelete") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeleteGlobalSecondaryIndexAction))) (S1 (MetaSel (Just Symbol "_gsiuUpdate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UpdateGlobalSecondaryIndexAction))))))

globalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate #

Creates a value of GlobalSecondaryIndexUpdate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gsiuCreate - The parameters required for creating a global secondary index on an existing table: * IndexName * KeySchema * AttributeDefinitions * Projection * ProvisionedThroughput
  • gsiuDelete - The name of an existing global secondary index to be removed.
  • gsiuUpdate - The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

gsiuCreate :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction) #

The parameters required for creating a global secondary index on an existing table: * IndexName * KeySchema * AttributeDefinitions * Projection * ProvisionedThroughput

gsiuDelete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction) #

The name of an existing global secondary index to be removed.

gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction) #

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

ItemCollectionMetrics

data ItemCollectionMetrics #

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

See: itemCollectionMetrics smart constructor.

Instances

Eq ItemCollectionMetrics # 
Data ItemCollectionMetrics # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ItemCollectionMetrics -> c ItemCollectionMetrics #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ItemCollectionMetrics #

toConstr :: ItemCollectionMetrics -> Constr #

dataTypeOf :: ItemCollectionMetrics -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ItemCollectionMetrics) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ItemCollectionMetrics) #

gmapT :: (forall b. Data b => b -> b) -> ItemCollectionMetrics -> ItemCollectionMetrics #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ItemCollectionMetrics -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ItemCollectionMetrics -> r #

gmapQ :: (forall d. Data d => d -> u) -> ItemCollectionMetrics -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ItemCollectionMetrics -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ItemCollectionMetrics -> m ItemCollectionMetrics #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ItemCollectionMetrics -> m ItemCollectionMetrics #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ItemCollectionMetrics -> m ItemCollectionMetrics #

Read ItemCollectionMetrics # 
Show ItemCollectionMetrics # 
Generic ItemCollectionMetrics # 
Hashable ItemCollectionMetrics # 
FromJSON ItemCollectionMetrics # 
NFData ItemCollectionMetrics # 

Methods

rnf :: ItemCollectionMetrics -> () #

type Rep ItemCollectionMetrics # 
type Rep ItemCollectionMetrics = D1 (MetaData "ItemCollectionMetrics" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "ItemCollectionMetrics'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_icmItemCollectionKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text AttributeValue)))) (S1 (MetaSel (Just Symbol "_icmSizeEstimateRangeGB") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Double])))))

itemCollectionMetrics :: ItemCollectionMetrics #

Creates a value of ItemCollectionMetrics with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • icmItemCollectionKey - The partition key value of the item collection. This value is the same as the partition key value of the item.
  • icmSizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue) #

The partition key value of the item collection. This value is the same as the partition key value of the item.

icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double] #

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

KeySchemaElement

data KeySchemaElement #

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.

See: keySchemaElement smart constructor.

Instances

Eq KeySchemaElement # 
Data KeySchemaElement # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeySchemaElement -> c KeySchemaElement #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeySchemaElement #

toConstr :: KeySchemaElement -> Constr #

dataTypeOf :: KeySchemaElement -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c KeySchemaElement) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeySchemaElement) #

gmapT :: (forall b. Data b => b -> b) -> KeySchemaElement -> KeySchemaElement #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeySchemaElement -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeySchemaElement -> r #

gmapQ :: (forall d. Data d => d -> u) -> KeySchemaElement -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> KeySchemaElement -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeySchemaElement -> m KeySchemaElement #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeySchemaElement -> m KeySchemaElement #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeySchemaElement -> m KeySchemaElement #

Read KeySchemaElement # 
Show KeySchemaElement # 
Generic KeySchemaElement # 
Hashable KeySchemaElement # 
ToJSON KeySchemaElement # 
FromJSON KeySchemaElement # 
NFData KeySchemaElement # 

Methods

rnf :: KeySchemaElement -> () #

type Rep KeySchemaElement # 
type Rep KeySchemaElement = D1 (MetaData "KeySchemaElement" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "KeySchemaElement'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_kseAttributeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_kseKeyType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 KeyType))))

keySchemaElement #

Creates a value of KeySchemaElement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • kseAttributeName - The name of a key attribute.
  • kseKeyType - The role that this key attribute will assume: * HASH - partition key * RANGE - sort key

kseAttributeName :: Lens' KeySchemaElement Text #

The name of a key attribute.

kseKeyType :: Lens' KeySchemaElement KeyType #

The role that this key attribute will assume: * HASH - partition key * RANGE - sort key

KeysAndAttributes

data KeysAndAttributes #

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

See: keysAndAttributes smart constructor.

Instances

Eq KeysAndAttributes # 
Data KeysAndAttributes # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeysAndAttributes -> c KeysAndAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeysAndAttributes #

toConstr :: KeysAndAttributes -> Constr #

dataTypeOf :: KeysAndAttributes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c KeysAndAttributes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeysAndAttributes) #

gmapT :: (forall b. Data b => b -> b) -> KeysAndAttributes -> KeysAndAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeysAndAttributes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeysAndAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> KeysAndAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> KeysAndAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeysAndAttributes -> m KeysAndAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeysAndAttributes -> m KeysAndAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeysAndAttributes -> m KeysAndAttributes #

Read KeysAndAttributes # 
Show KeysAndAttributes # 
Generic KeysAndAttributes # 
Hashable KeysAndAttributes # 
ToJSON KeysAndAttributes # 
FromJSON KeysAndAttributes # 
NFData KeysAndAttributes # 

Methods

rnf :: KeysAndAttributes -> () #

type Rep KeysAndAttributes # 
type Rep KeysAndAttributes = D1 (MetaData "KeysAndAttributes" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "KeysAndAttributes'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_kaaProjectionExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_kaaAttributesToGet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_kaaExpressionAttributeNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_kaaConsistentRead") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_kaaKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 (Map Text AttributeValue))))))))

keysAndAttributes #

Creates a value of KeysAndAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • kaaProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .
  • kaaAttributesToGet - One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.
  • kaaExpressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: * Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide ). To work around this, you could specify the following for ExpressionAttributeNames : * {"#P":Percentile} You could then use this substitution in an expression, as in this example: * #P = :val For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .
  • kaaConsistentRead - The consistency of a read operation. If set to true , then a strongly consistent read is used; otherwise, an eventually consistent read is used.
  • kaaKeys - The primary key attribute values that define the items and the attributes associated with the items.

kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text) #

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .

kaaAttributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text)) #

One or more attributes to retrieve from the table or index. If no attribute names are specified then all attributes will be returned. If any of the specified attributes are not found, they will not appear in the result.

kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text) #

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames : * To access an attribute whose name conflicts with a DynamoDB reserved word. * To create a placeholder for repeating occurrences of an attribute name in an expression. * To prevent special characters in an attribute name from being misinterpreted in an expression. Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name: * Percentile The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide ). To work around this, you could specify the following for ExpressionAttributeNames : * {"#P":Percentile} You could then use this substitution in an expression, as in this example: * #P = :val For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide .

kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool) #

The consistency of a read operation. If set to true , then a strongly consistent read is used; otherwise, an eventually consistent read is used.

kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue)) #

The primary key attribute values that define the items and the attributes associated with the items.

LocalSecondaryIndex

data LocalSecondaryIndex #

Represents the properties of a local secondary index.

See: localSecondaryIndex smart constructor.

Instances

Eq LocalSecondaryIndex # 
Data LocalSecondaryIndex # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LocalSecondaryIndex -> c LocalSecondaryIndex #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LocalSecondaryIndex #

toConstr :: LocalSecondaryIndex -> Constr #

dataTypeOf :: LocalSecondaryIndex -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LocalSecondaryIndex) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LocalSecondaryIndex) #

gmapT :: (forall b. Data b => b -> b) -> LocalSecondaryIndex -> LocalSecondaryIndex #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LocalSecondaryIndex -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LocalSecondaryIndex -> r #

gmapQ :: (forall d. Data d => d -> u) -> LocalSecondaryIndex -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LocalSecondaryIndex -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LocalSecondaryIndex -> m LocalSecondaryIndex #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalSecondaryIndex -> m LocalSecondaryIndex #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalSecondaryIndex -> m LocalSecondaryIndex #

Read LocalSecondaryIndex # 
Show LocalSecondaryIndex # 
Generic LocalSecondaryIndex # 
Hashable LocalSecondaryIndex # 
ToJSON LocalSecondaryIndex # 
NFData LocalSecondaryIndex # 

Methods

rnf :: LocalSecondaryIndex -> () #

type Rep LocalSecondaryIndex # 
type Rep LocalSecondaryIndex = D1 (MetaData "LocalSecondaryIndex" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "LocalSecondaryIndex'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lsiIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_lsiKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 KeySchemaElement))) (S1 (MetaSel (Just Symbol "_lsiProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Projection)))))

localSecondaryIndex #

Creates a value of LocalSecondaryIndex with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lsiIndexName - The name of the local secondary index. The name must be unique among all other indexes on this table.
  • lsiKeySchema - 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
  • lsiProjection - Undocumented member.

lsiIndexName :: Lens' LocalSecondaryIndex Text #

The name of the local secondary index. The name must be unique among all other indexes on this table.

lsiKeySchema :: Lens' LocalSecondaryIndex (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

LocalSecondaryIndexDescription

data LocalSecondaryIndexDescription #

Represents the properties of a local secondary index.

See: localSecondaryIndexDescription smart constructor.

Instances

Eq LocalSecondaryIndexDescription # 
Data LocalSecondaryIndexDescription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LocalSecondaryIndexDescription -> c LocalSecondaryIndexDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LocalSecondaryIndexDescription #

toConstr :: LocalSecondaryIndexDescription -> Constr #

dataTypeOf :: LocalSecondaryIndexDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LocalSecondaryIndexDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LocalSecondaryIndexDescription) #

gmapT :: (forall b. Data b => b -> b) -> LocalSecondaryIndexDescription -> LocalSecondaryIndexDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LocalSecondaryIndexDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LocalSecondaryIndexDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> LocalSecondaryIndexDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> LocalSecondaryIndexDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LocalSecondaryIndexDescription -> m LocalSecondaryIndexDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalSecondaryIndexDescription -> m LocalSecondaryIndexDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LocalSecondaryIndexDescription -> m LocalSecondaryIndexDescription #

Read LocalSecondaryIndexDescription # 
Show LocalSecondaryIndexDescription # 
Generic LocalSecondaryIndexDescription # 
Hashable LocalSecondaryIndexDescription # 
FromJSON LocalSecondaryIndexDescription # 
NFData LocalSecondaryIndexDescription # 
type Rep LocalSecondaryIndexDescription # 
type Rep LocalSecondaryIndexDescription = D1 (MetaData "LocalSecondaryIndexDescription" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "LocalSecondaryIndexDescription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lsidIndexSizeBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) ((:*:) (S1 (MetaSel (Just Symbol "_lsidIndexARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lsidKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 KeySchemaElement)))))) ((:*:) (S1 (MetaSel (Just Symbol "_lsidProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Projection))) ((:*:) (S1 (MetaSel (Just Symbol "_lsidItemCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) (S1 (MetaSel (Just Symbol "_lsidIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

localSecondaryIndexDescription :: LocalSecondaryIndexDescription #

Creates a value of LocalSecondaryIndexDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lsidIndexSizeBytes - 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.
  • lsidIndexARN - The Amazon Resource Name (ARN) that uniquely identifies the index.
  • lsidKeySchema - 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
  • lsidProjection - Undocumented member.
  • lsidItemCount - 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.
  • lsidIndexName - Represents the name of the local secondary index.

lsidIndexSizeBytes :: 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.

lsidIndexARN :: Lens' LocalSecondaryIndexDescription (Maybe Text) #

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

lsidKeySchema :: 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

lsidItemCount :: 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.

lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text) #

Represents the name of the local secondary index.

Projection

data Projection #

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

See: projection smart constructor.

Instances

Eq Projection # 
Data Projection # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Projection -> c Projection #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Projection #

toConstr :: Projection -> Constr #

dataTypeOf :: Projection -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Projection) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Projection) #

gmapT :: (forall b. Data b => b -> b) -> Projection -> Projection #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Projection -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Projection -> r #

gmapQ :: (forall d. Data d => d -> u) -> Projection -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Projection -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Projection -> m Projection #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Projection -> m Projection #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Projection -> m Projection #

Read Projection # 
Show Projection # 
Generic Projection # 

Associated Types

type Rep Projection :: * -> * #

Hashable Projection # 
ToJSON Projection # 
FromJSON Projection # 
NFData Projection # 

Methods

rnf :: Projection -> () #

type Rep Projection # 
type Rep Projection = D1 (MetaData "Projection" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "Projection'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_pProjectionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProjectionType))) (S1 (MetaSel (Just Symbol "_pNonKeyAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text))))))

projection :: Projection #

Creates a value of Projection with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • pProjectionType - The set of attributes that are projected into the index: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index.
  • pNonKeyAttributes - Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

pProjectionType :: Lens' Projection (Maybe ProjectionType) #

The set of attributes that are projected into the index: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index.

pNonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text)) #

Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

ProvisionedThroughput

data ProvisionedThroughput #

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .

See: provisionedThroughput smart constructor.

Instances

Eq ProvisionedThroughput # 
Data ProvisionedThroughput # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProvisionedThroughput -> c ProvisionedThroughput #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProvisionedThroughput #

toConstr :: ProvisionedThroughput -> Constr #

dataTypeOf :: ProvisionedThroughput -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProvisionedThroughput) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProvisionedThroughput) #

gmapT :: (forall b. Data b => b -> b) -> ProvisionedThroughput -> ProvisionedThroughput #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionedThroughput -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionedThroughput -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProvisionedThroughput -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProvisionedThroughput -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProvisionedThroughput -> m ProvisionedThroughput #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionedThroughput -> m ProvisionedThroughput #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionedThroughput -> m ProvisionedThroughput #

Read ProvisionedThroughput # 
Show ProvisionedThroughput # 
Generic ProvisionedThroughput # 
Hashable ProvisionedThroughput # 
ToJSON ProvisionedThroughput # 
NFData ProvisionedThroughput # 

Methods

rnf :: ProvisionedThroughput -> () #

type Rep ProvisionedThroughput # 
type Rep ProvisionedThroughput = D1 (MetaData "ProvisionedThroughput" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "ProvisionedThroughput'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ptReadCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) (S1 (MetaSel (Just Symbol "_ptWriteCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

provisionedThroughput #

Creates a value of ProvisionedThroughput with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural #

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException . For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .

ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural #

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException . For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .

ProvisionedThroughputDescription

data ProvisionedThroughputDescription #

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

See: provisionedThroughputDescription smart constructor.

Instances

Eq ProvisionedThroughputDescription # 
Data ProvisionedThroughputDescription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProvisionedThroughputDescription -> c ProvisionedThroughputDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProvisionedThroughputDescription #

toConstr :: ProvisionedThroughputDescription -> Constr #

dataTypeOf :: ProvisionedThroughputDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ProvisionedThroughputDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProvisionedThroughputDescription) #

gmapT :: (forall b. Data b => b -> b) -> ProvisionedThroughputDescription -> ProvisionedThroughputDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionedThroughputDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProvisionedThroughputDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProvisionedThroughputDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProvisionedThroughputDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProvisionedThroughputDescription -> m ProvisionedThroughputDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionedThroughputDescription -> m ProvisionedThroughputDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProvisionedThroughputDescription -> m ProvisionedThroughputDescription #

Read ProvisionedThroughputDescription # 
Show ProvisionedThroughputDescription # 
Generic ProvisionedThroughputDescription # 
Hashable ProvisionedThroughputDescription # 
FromJSON ProvisionedThroughputDescription # 
NFData ProvisionedThroughputDescription # 
type Rep ProvisionedThroughputDescription # 
type Rep ProvisionedThroughputDescription = D1 (MetaData "ProvisionedThroughputDescription" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "ProvisionedThroughputDescription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptdReadCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ptdLastDecreaseDateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_ptdWriteCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_ptdNumberOfDecreasesToday") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ptdLastIncreaseDateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))))))

provisionedThroughputDescription :: ProvisionedThroughputDescription #

Creates a value of ProvisionedThroughputDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ptdReadCapacityUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
  • ptdLastDecreaseDateTime - The date and time of the last provisioned throughput decrease for this table.
  • ptdWriteCapacityUnits - The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException .
  • ptdNumberOfDecreasesToday - The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide .
  • ptdLastIncreaseDateTime - The date and time of the last provisioned throughput increase for this table.

ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) #

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException . Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) #

The date and time of the last provisioned throughput decrease for this table.

ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) #

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException .

ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural) #

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide .

ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) #

The date and time of the last provisioned throughput increase for this table.

PutRequest

data PutRequest #

Represents a request to perform a PutItem operation on an item.

See: putRequest smart constructor.

Instances

Eq PutRequest # 
Data PutRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutRequest -> c PutRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutRequest #

toConstr :: PutRequest -> Constr #

dataTypeOf :: PutRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutRequest) #

gmapT :: (forall b. Data b => b -> b) -> PutRequest -> PutRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutRequest -> m PutRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRequest -> m PutRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutRequest -> m PutRequest #

Read PutRequest # 
Show PutRequest # 
Generic PutRequest # 

Associated Types

type Rep PutRequest :: * -> * #

Hashable PutRequest # 
ToJSON PutRequest # 
FromJSON PutRequest # 
NFData PutRequest # 

Methods

rnf :: PutRequest -> () #

type Rep PutRequest # 
type Rep PutRequest = D1 (MetaData "PutRequest" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" True) (C1 (MetaCons "PutRequest'" PrefixI True) (S1 (MetaSel (Just Symbol "_prItem") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text AttributeValue))))

putRequest :: PutRequest #

Creates a value of PutRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • prItem - A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

prItem :: Lens' PutRequest (HashMap Text AttributeValue) #

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem . All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

StreamSpecification

data StreamSpecification #

Represents the DynamoDB Streams configuration for a table in DynamoDB.

See: streamSpecification smart constructor.

Instances

Eq StreamSpecification # 
Data StreamSpecification # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StreamSpecification -> c StreamSpecification #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StreamSpecification #

toConstr :: StreamSpecification -> Constr #

dataTypeOf :: StreamSpecification -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StreamSpecification) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StreamSpecification) #

gmapT :: (forall b. Data b => b -> b) -> StreamSpecification -> StreamSpecification #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StreamSpecification -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StreamSpecification -> r #

gmapQ :: (forall d. Data d => d -> u) -> StreamSpecification -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StreamSpecification -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StreamSpecification -> m StreamSpecification #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamSpecification -> m StreamSpecification #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StreamSpecification -> m StreamSpecification #

Read StreamSpecification # 
Show StreamSpecification # 
Generic StreamSpecification # 
Hashable StreamSpecification # 
ToJSON StreamSpecification # 
FromJSON StreamSpecification # 
NFData StreamSpecification # 

Methods

rnf :: StreamSpecification -> () #

type Rep StreamSpecification # 
type Rep StreamSpecification = D1 (MetaData "StreamSpecification" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "StreamSpecification'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ssStreamViewType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamViewType))) (S1 (MetaSel (Just Symbol "_ssStreamEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))

streamSpecification :: StreamSpecification #

Creates a value of StreamSpecification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ssStreamViewType - The DynamoDB Streams settings for the table. These settings consist of: * StreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. * StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: * KEYS_ONLY - Only the key attributes of the modified item are written to the stream. * NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. * OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. * NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
  • ssStreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

ssStreamViewType :: Lens' StreamSpecification (Maybe StreamViewType) #

The DynamoDB Streams settings for the table. These settings consist of: * StreamEnabled - Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table. * StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: * KEYS_ONLY - Only the key attributes of the modified item are written to the stream. * NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. * OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. * NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

ssStreamEnabled :: Lens' StreamSpecification (Maybe Bool) #

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

TableDescription

data TableDescription #

Represents the properties of a table.

See: tableDescription smart constructor.

Instances

Eq TableDescription # 
Data TableDescription # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TableDescription -> c TableDescription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TableDescription #

toConstr :: TableDescription -> Constr #

dataTypeOf :: TableDescription -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TableDescription) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TableDescription) #

gmapT :: (forall b. Data b => b -> b) -> TableDescription -> TableDescription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TableDescription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TableDescription -> r #

gmapQ :: (forall d. Data d => d -> u) -> TableDescription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TableDescription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TableDescription -> m TableDescription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TableDescription -> m TableDescription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TableDescription -> m TableDescription #

Read TableDescription # 
Show TableDescription # 
Generic TableDescription # 
Hashable TableDescription # 
FromJSON TableDescription # 
NFData TableDescription # 

Methods

rnf :: TableDescription -> () #

type Rep TableDescription # 
type Rep TableDescription = D1 (MetaData "TableDescription" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "TableDescription'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdTableSizeBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer))) ((:*:) (S1 (MetaSel (Just Symbol "_tdAttributeDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeDefinition]))) (S1 (MetaSel (Just Symbol "_tdLatestStreamARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProvisionedThroughputDescription))) (S1 (MetaSel (Just Symbol "_tdTableStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TableStatus)))) ((:*:) (S1 (MetaSel (Just Symbol "_tdTableARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tdKeySchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 KeySchemaElement))))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdGlobalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GlobalSecondaryIndexDescription]))) ((:*:) (S1 (MetaSel (Just Symbol "_tdLatestStreamLabel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tdLocalSecondaryIndexes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LocalSecondaryIndexDescription]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdCreationDateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_tdItemCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)))) ((:*:) (S1 (MetaSel (Just Symbol "_tdTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tdStreamSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StreamSpecification))))))))

tableDescription :: TableDescription #

Creates a value of TableDescription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • tdTableSizeBytes - The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • tdAttributeDefinitions - An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: * AttributeName - The name of the attribute. * AttributeType - The data type for the attribute.
  • tdLatestStreamARN - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
  • tdProvisionedThroughput - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
  • tdTableStatus - The current state of the table: * CREATING - The table is being created. * UPDATING - The table is being updated. * DELETING - The table is being deleted. * ACTIVE - The table is ready for use.
  • tdTableARN - The Amazon Resource Name (ARN) that uniquely identifies the table.
  • tdKeySchema - The primary key structure for the table. Each KeySchemaElement consists of: * AttributeName - The name of the attribute. * KeyType - The role of the attribute: * HASH - partition key * RANGE - sort key For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide .
  • tdGlobalSecondaryIndexes - The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.) * IndexName - The name of the global secondary index. * IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * IndexStatus - The current status of the global secondary index: * CREATING - The index is being created. * UPDATING - The index is being updated. * DELETING - The index is being deleted. * ACTIVE - The index is ready for use. * ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * ProjectionType - One of the following: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index. * NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the DELETING state, no information about indexes will be returned.
  • tdLatestStreamLabel - A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the StreamLabel .
  • tdLocalSecondaryIndexes - Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * IndexName - The name of the local secondary index. * KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * ProjectionType - One of the following: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index. * NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the DELETING state, no information about indexes will be returned.
  • tdCreationDateTime - The date and time when the table was created, in UNIX epoch time format.
  • tdItemCount - The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  • tdTableName - The name of the table.
  • tdStreamSpecification - The current DynamoDB Streams configuration for the table.

tdTableSizeBytes :: Lens' TableDescription (Maybe Integer) #

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

tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition] #

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: * AttributeName - The name of the attribute. * AttributeType - The data type for the attribute.

tdLatestStreamARN :: Lens' TableDescription (Maybe Text) #

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription) #

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

tdTableStatus :: Lens' TableDescription (Maybe TableStatus) #

The current state of the table: * CREATING - The table is being created. * UPDATING - The table is being updated. * DELETING - The table is being deleted. * ACTIVE - The table is ready for use.

tdTableARN :: Lens' TableDescription (Maybe Text) #

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

tdKeySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement)) #

The primary key structure for the table. Each KeySchemaElement consists of: * AttributeName - The name of the attribute. * KeyType - The role of the attribute: * HASH - partition key * RANGE - sort key For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide .

tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription] #

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: * Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.) * IndexName - The name of the global secondary index. * IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * IndexStatus - The current status of the global secondary index: * CREATING - The index is being created. * UPDATING - The index is being updated. * DELETING - The index is being deleted. * ACTIVE - The index is ready for use. * ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * ProjectionType - One of the following: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index. * NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the DELETING state, no information about indexes will be returned.

tdLatestStreamLabel :: Lens' TableDescription (Maybe Text) #

A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: * the AWS customer ID. * the table name. * the StreamLabel .

tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription] #

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: * IndexName - The name of the local secondary index. * KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. * Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: * ProjectionType - One of the following: * KEYS_ONLY - Only the index and primary keys are projected into the index. * INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes . * ALL - All of the table attributes are projected into the index. * NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes , summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. * IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. * ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the DELETING state, no information about indexes will be returned.

tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime) #

The date and time when the table was created, in UNIX epoch time format.

tdItemCount :: Lens' TableDescription (Maybe Integer) #

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

tdTableName :: Lens' TableDescription (Maybe Text) #

The name of the table.

tdStreamSpecification :: Lens' TableDescription (Maybe StreamSpecification) #

The current DynamoDB Streams configuration for the table.

UpdateGlobalSecondaryIndexAction

data UpdateGlobalSecondaryIndexAction #

Represents the new provisioned throughput settings to be applied to a global secondary index.

See: updateGlobalSecondaryIndexAction smart constructor.

Instances

Eq UpdateGlobalSecondaryIndexAction # 
Data UpdateGlobalSecondaryIndexAction # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateGlobalSecondaryIndexAction -> c UpdateGlobalSecondaryIndexAction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateGlobalSecondaryIndexAction #

toConstr :: UpdateGlobalSecondaryIndexAction -> Constr #

dataTypeOf :: UpdateGlobalSecondaryIndexAction -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateGlobalSecondaryIndexAction) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateGlobalSecondaryIndexAction) #

gmapT :: (forall b. Data b => b -> b) -> UpdateGlobalSecondaryIndexAction -> UpdateGlobalSecondaryIndexAction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGlobalSecondaryIndexAction -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateGlobalSecondaryIndexAction -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateGlobalSecondaryIndexAction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateGlobalSecondaryIndexAction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateGlobalSecondaryIndexAction -> m UpdateGlobalSecondaryIndexAction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGlobalSecondaryIndexAction -> m UpdateGlobalSecondaryIndexAction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateGlobalSecondaryIndexAction -> m UpdateGlobalSecondaryIndexAction #

Read UpdateGlobalSecondaryIndexAction # 
Show UpdateGlobalSecondaryIndexAction # 
Generic UpdateGlobalSecondaryIndexAction # 
Hashable UpdateGlobalSecondaryIndexAction # 
ToJSON UpdateGlobalSecondaryIndexAction # 
NFData UpdateGlobalSecondaryIndexAction # 
type Rep UpdateGlobalSecondaryIndexAction # 
type Rep UpdateGlobalSecondaryIndexAction = D1 (MetaData "UpdateGlobalSecondaryIndexAction" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "UpdateGlobalSecondaryIndexAction'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ugsiaIndexName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ugsiaProvisionedThroughput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ProvisionedThroughput))))

updateGlobalSecondaryIndexAction #

Creates a value of UpdateGlobalSecondaryIndexAction with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text #

The name of the global secondary index to be updated.

WriteRequest

data WriteRequest #

Represents an operation to perform - either DeleteItem or PutItem . You can only request one of these operations, not both, in a single WriteRequest . If you do need to perform both of these operations, you will need to provide two separate WriteRequest objects.

See: writeRequest smart constructor.

Instances

Eq WriteRequest # 
Data WriteRequest # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WriteRequest -> c WriteRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WriteRequest #

toConstr :: WriteRequest -> Constr #

dataTypeOf :: WriteRequest -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WriteRequest) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WriteRequest) #

gmapT :: (forall b. Data b => b -> b) -> WriteRequest -> WriteRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WriteRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WriteRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> WriteRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WriteRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WriteRequest -> m WriteRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteRequest -> m WriteRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WriteRequest -> m WriteRequest #

Read WriteRequest # 
Show WriteRequest # 
Generic WriteRequest # 

Associated Types

type Rep WriteRequest :: * -> * #

Hashable WriteRequest # 
ToJSON WriteRequest # 
FromJSON WriteRequest # 
NFData WriteRequest # 

Methods

rnf :: WriteRequest -> () #

type Rep WriteRequest # 
type Rep WriteRequest = D1 (MetaData "WriteRequest" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.4.5-EyODm0wLuRNGy43qDOZJHX" False) (C1 (MetaCons "WriteRequest'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_wrDeleteRequest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeleteRequest))) (S1 (MetaSel (Just Symbol "_wrPutRequest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PutRequest)))))

writeRequest :: WriteRequest #

Creates a value of WriteRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

wrDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest) #

A request to perform a DeleteItem operation.

wrPutRequest :: Lens' WriteRequest (Maybe PutRequest) #

A request to perform a PutItem operation.