Safe Haskell | None |
---|---|
Language | Haskell2010 |
- Service
- WriteRequest
- ProvisionedThroughputDescription
- KeyType
- AttributeValue
- IndexStatus
- ProvisionedThroughput
- TableStatus
- ProjectionType
- TableDescription
- KeysAndAttributes
- ReturnConsumedCapacity
- ReturnItemCollectionMetrics
- AttributeValueUpdate
- ExpectedAttributeValue
- AttributeDefinition
- ComparisonOperator
- ReturnValue
- LocalSecondaryIndex
- GlobalSecondaryIndexDescription
- ItemCollectionMetrics
- Capacity
- ConsumedCapacity
- GlobalSecondaryIndex
- LocalSecondaryIndexDescription
- AttributeAction
- ScalarAttributeType
- Projection
- Select
- KeySchemaElement
- DeleteRequest
- UpdateGlobalSecondaryIndexAction
- PutRequest
- Condition
- ConditionalOperator
- GlobalSecondaryIndexUpdate
- data DynamoDB
- data JSONError :: *
- data WriteRequest
- writeRequest :: WriteRequest
- wDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest)
- wPutRequest :: Lens' WriteRequest (Maybe PutRequest)
- data ProvisionedThroughputDescription
- provisionedThroughputDescription :: ProvisionedThroughputDescription
- ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- data KeyType
- data AttributeValue
- attributeValue :: AttributeValue
- avB :: Lens' AttributeValue (Maybe Base64)
- avBOOL :: Lens' AttributeValue (Maybe Bool)
- avBS :: Lens' AttributeValue [Base64]
- avL :: Lens' AttributeValue [AttributeValue]
- avM :: Lens' AttributeValue (HashMap Text AttributeValue)
- avN :: Lens' AttributeValue (Maybe Text)
- avNS :: Lens' AttributeValue [Text]
- avNULL :: Lens' AttributeValue (Maybe Bool)
- avS :: Lens' AttributeValue (Maybe Text)
- avSS :: Lens' AttributeValue [Text]
- data IndexStatus
- data ProvisionedThroughput
- provisionedThroughput :: Natural -> Natural -> ProvisionedThroughput
- ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural
- ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural
- data TableStatus
- data ProjectionType
- data TableDescription
- tableDescription :: NonEmpty KeySchemaElement -> TableDescription
- tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition]
- tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime)
- tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription]
- tdItemCount :: Lens' TableDescription (Maybe Integer)
- tdKeySchema :: Lens' TableDescription (NonEmpty KeySchemaElement)
- tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription]
- tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription)
- tdTableName :: Lens' TableDescription (Maybe Text)
- tdTableSizeBytes :: Lens' TableDescription (Maybe Integer)
- tdTableStatus :: Lens' TableDescription (Maybe TableStatus)
- data KeysAndAttributes
- keysAndAttributes :: NonEmpty (HashMap Text AttributeValue) -> NonEmpty Text -> KeysAndAttributes
- kaaAttributesToGet :: Lens' KeysAndAttributes (NonEmpty Text)
- kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool)
- kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text)
- kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue))
- kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text)
- data ReturnConsumedCapacity
- data ReturnItemCollectionMetrics
- data AttributeValueUpdate
- attributeValueUpdate :: AttributeValueUpdate
- avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction)
- avuValue :: Lens' AttributeValueUpdate (Maybe AttributeValue)
- data ExpectedAttributeValue
- expectedAttributeValue :: ExpectedAttributeValue
- eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue]
- eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator)
- eavExists :: Lens' ExpectedAttributeValue (Maybe Bool)
- eavValue :: Lens' ExpectedAttributeValue (Maybe AttributeValue)
- data AttributeDefinition
- attributeDefinition :: Text -> ScalarAttributeType -> AttributeDefinition
- adAttributeName :: Lens' AttributeDefinition Text
- adAttributeType :: Lens' AttributeDefinition ScalarAttributeType
- data ComparisonOperator
- data ReturnValue
- data LocalSecondaryIndex
- localSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> LocalSecondaryIndex
- lsiIndexName :: Lens' LocalSecondaryIndex Text
- lsiKeySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement)
- lsiProjection :: Lens' LocalSecondaryIndex Projection
- data GlobalSecondaryIndexDescription
- globalSecondaryIndexDescription :: NonEmpty KeySchemaElement -> GlobalSecondaryIndexDescription
- gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text)
- gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- gsidIndexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus)
- gsidItemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (NonEmpty KeySchemaElement)
- gsidProjection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection)
- gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription)
- data ItemCollectionMetrics
- itemCollectionMetrics :: ItemCollectionMetrics
- icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue)
- icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double]
- data Capacity
- capacity :: Capacity
- cCapacityUnits :: Lens' Capacity (Maybe Double)
- data ConsumedCapacity
- consumedCapacity :: ConsumedCapacity
- ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double)
- ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity)
- ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity)
- ccTable :: Lens' ConsumedCapacity (Maybe Capacity)
- ccTableName :: Lens' ConsumedCapacity (Maybe Text)
- data GlobalSecondaryIndex
- globalSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> ProvisionedThroughput -> GlobalSecondaryIndex
- gsiIndexName :: Lens' GlobalSecondaryIndex Text
- gsiKeySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement)
- gsiProjection :: Lens' GlobalSecondaryIndex Projection
- gsiProvisionedThroughput :: Lens' GlobalSecondaryIndex ProvisionedThroughput
- data LocalSecondaryIndexDescription
- localSecondaryIndexDescription :: NonEmpty KeySchemaElement -> LocalSecondaryIndexDescription
- lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text)
- lsidIndexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- lsidItemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- lsidKeySchema :: Lens' LocalSecondaryIndexDescription (NonEmpty KeySchemaElement)
- lsidProjection :: Lens' LocalSecondaryIndexDescription (Maybe Projection)
- data AttributeAction
- data ScalarAttributeType
- data Projection
- projection :: NonEmpty Text -> Projection
- pNonKeyAttributes :: Lens' Projection (NonEmpty Text)
- pProjectionType :: Lens' Projection (Maybe ProjectionType)
- data Select
- data KeySchemaElement
- keySchemaElement :: Text -> KeyType -> KeySchemaElement
- kseAttributeName :: Lens' KeySchemaElement Text
- kseKeyType :: Lens' KeySchemaElement KeyType
- data DeleteRequest
- deleteRequest :: DeleteRequest
- dKey :: Lens' DeleteRequest (HashMap Text AttributeValue)
- data UpdateGlobalSecondaryIndexAction
- updateGlobalSecondaryIndexAction :: Text -> ProvisionedThroughput -> UpdateGlobalSecondaryIndexAction
- ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text
- ugsiaProvisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput
- data PutRequest
- putRequest :: PutRequest
- pItem :: Lens' PutRequest (HashMap Text AttributeValue)
- data Condition
- condition :: ComparisonOperator -> Condition
- cAttributeValueList :: Lens' Condition [AttributeValue]
- cComparisonOperator :: Lens' Condition ComparisonOperator
- data ConditionalOperator
- data GlobalSecondaryIndexUpdate
- globalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate
- gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction)
Service
Version 2012-08-10
of the Amazon DynamoDB service.
Error
data JSONError :: *
WriteRequest
writeRequest :: WriteRequest Source
WriteRequest
constructor.
The fields accessible through corresponding lenses are:
wDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest) Source
A request to perform a DeleteItem operation.
wPutRequest :: Lens' WriteRequest (Maybe PutRequest) Source
A request to perform a PutItem operation.
ProvisionedThroughputDescription
provisionedThroughputDescription :: ProvisionedThroughputDescription Source
ProvisionedThroughputDescription
constructor.
The fields accessible through corresponding lenses are:
ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) Source
The date and time of the last provisioned throughput decrease for this table.
ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) Source
The date and time of the last provisioned throughput increase for this table.
ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source
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.
ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source
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.
ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
KeyType
AttributeValue
data AttributeValue Source
avBS :: Lens' AttributeValue [Base64] Source
A Binary Set data type.
avL :: Lens' AttributeValue [AttributeValue] Source
A List of attribute values.
avM :: Lens' AttributeValue (HashMap Text AttributeValue) Source
A Map of attribute values.
avNS :: Lens' AttributeValue [Text] Source
A Number Set data type.
avSS :: Lens' AttributeValue [Text] Source
A String Set data type.
IndexStatus
data IndexStatus Source
ProvisionedThroughput
ProvisionedThroughput
constructor.
The fields accessible through corresponding lenses are:
ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural Source
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see SpecifyingRead and Write Requirements in the Amazon DynamoDB Developer Guide.
ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural Source
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.
TableStatus
data TableStatus Source
TSActive | ACTIVE |
TSCreating | CREATING |
TSDeleting | DELETING |
TSUpdating | UPDATING |
ProjectionType
data ProjectionType Source
TableDescription
data TableDescription Source
TableDescription
constructor.
The fields accessible through corresponding lenses are:
tdAttributeDefinitions
::
[AttributeDefinition
]tdCreationDateTime
::
Maybe
UTCTime
tdGlobalSecondaryIndexes
::
[GlobalSecondaryIndexDescription
]tdItemCount
::
Maybe
Integer
tdKeySchema
::
NonEmpty
KeySchemaElement
tdLocalSecondaryIndexes
::
[LocalSecondaryIndexDescription
]tdProvisionedThroughput
::
Maybe
ProvisionedThroughputDescription
tdTableName
::
Maybe
Text
tdTableSizeBytes
::
Maybe
Integer
tdTableStatus
::
Maybe
TableStatus
tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition] Source
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.
tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime) Source
The date and time when the table was created, in UNIX epoch time format.
tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription] Source
The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:
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 hash key attribute 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 specified 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.
tdItemCount :: Lens' TableDescription (Maybe Integer) Source
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.
tdKeySchema :: Lens' TableDescription (NonEmpty KeySchemaElement) Source
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The key type for the attribute. Can be either HASH
or RANGE
.
For more information about primary keys, see Primary Key in the AmazonDynamoDB Developer Guide.
tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription] Source
Represents one or more local secondary indexes on the table. Each index is scoped to a given hash 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 hash key attribute 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 specified 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.
tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription) Source
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
tdTableName :: Lens' TableDescription (Maybe Text) Source
The name of the table.
tdTableSizeBytes :: Lens' TableDescription (Maybe Integer) Source
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.
tdTableStatus :: Lens' TableDescription (Maybe TableStatus) Source
The current state of the table:
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
KeysAndAttributes
data KeysAndAttributes Source
KeysAndAttributes
constructor.
The fields accessible through corresponding lenses are:
kaaAttributesToGet :: Lens' KeysAndAttributes (NonEmpty Text) Source
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.
kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool) Source
The consistency of a read operation. If set to true
, then a strongly
consistent read is used; otherwise, an eventually consistent read is used.
kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text) Source
One or more substitution tokens for simplifying complex expressions. The following are some use cases for an ExpressionAttributeNames value:
To shorten an attribute name that is very long or unwieldy in an expression.
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 expression:
'order.customerInfo.LastName = Smith OR order.customerInfo.LastName =Jones'
Now suppose that you specified the following for ExpressionAttributeNames:
'{"n":"order.customerInfo.LastName"}'
The expression can now be simplified as follows:
'n = Jones'
kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue)) Source
The primary key attribute values that define the items and the attributes associated with the items.
kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text) Source
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 expression 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.
ReturnConsumedCapacity
data ReturnConsumedCapacity Source
ReturnItemCollectionMetrics
data ReturnItemCollectionMetrics Source
AttributeValueUpdate
attributeValueUpdate :: AttributeValueUpdate Source
AttributeValueUpdate
constructor.
The fields accessible through corresponding lenses are:
avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction) Source
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.
ExpectedAttributeValue
expectedAttributeValue :: ExpectedAttributeValue Source
ExpectedAttributeValue
constructor.
The fields accessible through corresponding lenses are:
eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue] Source
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 aa
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 example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator) Source
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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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"]}'
eavExists :: Lens' ExpectedAttributeValue (Maybe Bool) Source
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 specify a Value. (You cannot expect an
attribute to have a value, while also expecting it not to exist.)
AttributeDefinition
AttributeDefinition
constructor.
The fields accessible through corresponding lenses are:
adAttributeName :: Lens' AttributeDefinition Text Source
A name for the attribute.
adAttributeType :: Lens' AttributeDefinition ScalarAttributeType Source
The data type for the attribute.
ComparisonOperator
data ComparisonOperator Source
BeginsWith | BEGINS_WITH |
Between | BETWEEN |
Contains | CONTAINS |
Eq | EQ |
Ge | GE |
Gt | GT |
In' | IN |
Le | LE |
Lt | LT |
Ne | NE |
NotContains | NOT_CONTAINS |
NotNull | NOT_NULL |
Null | NULL |
ReturnValue
data ReturnValue Source
RVAllNew | ALL_NEW |
RVAllOld | ALL_OLD |
RVNone | NONE |
RVUpdatedNew | UPDATED_NEW |
RVUpdatedOld | UPDATED_OLD |
LocalSecondaryIndex
LocalSecondaryIndex
constructor.
The fields accessible through corresponding lenses are:
lsiIndexName :: Lens' LocalSecondaryIndex Text Source
The name of the local secondary index. The name must be unique among all other indexes on this table.
lsiKeySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement) Source
The complete key schema for the local secondary index, consisting of one or
more pairs of attribute names and key types (HASH
or RANGE
).
GlobalSecondaryIndexDescription
globalSecondaryIndexDescription Source
GlobalSecondaryIndexDescription
constructor.
The fields accessible through corresponding lenses are:
gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text) Source
The name of the global secondary index.
gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) Source
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) Source
The current state of the global secondary index:
CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.
UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.
DELETING - The index is being deleted, as the result of a DeleteTable operation.
ACTIVE - The index is ready for use.
gsidItemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) Source
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.
gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (NonEmpty KeySchemaElement) Source
The complete key schema for the global secondary index, consisting of one or
more pairs of attribute names and key types (HASH
or RANGE
).
gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription) Source
ItemCollectionMetrics
itemCollectionMetrics :: ItemCollectionMetrics Source
ItemCollectionMetrics
constructor.
The fields accessible through corresponding lenses are:
icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue) Source
The hash key value of the item collection. This value is the same as the hash key of the item.
icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double] Source
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.
Capacity
Capacity
constructor.
The fields accessible through corresponding lenses are:
cCapacityUnits :: Lens' Capacity (Maybe Double) Source
The total number of capacity units consumed on a table or an index.
ConsumedCapacity
data ConsumedCapacity Source
consumedCapacity :: ConsumedCapacity Source
ConsumedCapacity
constructor.
The fields accessible through corresponding lenses are:
ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) Source
The total number of capacity units consumed by the operation.
ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) Source
The amount of throughput consumed on each global index affected by the operation.
ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity) Source
The amount of throughput consumed on each local index affected by the operation.
ccTable :: Lens' ConsumedCapacity (Maybe Capacity) Source
The amount of throughput consumed on the table affected by the operation.
ccTableName :: Lens' ConsumedCapacity (Maybe Text) Source
The name of the table that was affected by the operation.
GlobalSecondaryIndex
GlobalSecondaryIndex
constructor.
The fields accessible through corresponding lenses are:
gsiIndexName :: Lens' GlobalSecondaryIndex Text Source
The name of the global secondary index. The name must be unique among all other indexes on this table.
gsiKeySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement) Source
The complete key schema for a global secondary index, which consists of one
or more pairs of attribute names and key types (HASH
or RANGE
).
LocalSecondaryIndexDescription
localSecondaryIndexDescription Source
LocalSecondaryIndexDescription
constructor.
The fields accessible through corresponding lenses are:
lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text) Source
Represents the name of the local secondary index.
lsidIndexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer) Source
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.
lsidItemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer) Source
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.
lsidKeySchema :: Lens' LocalSecondaryIndexDescription (NonEmpty KeySchemaElement) Source
The complete index key schema, which consists of one or more pairs of
attribute names and key types (HASH
or RANGE
).
AttributeAction
data AttributeAction Source
ScalarAttributeType
data ScalarAttributeType Source
Projection
Projection
constructor.
The fields accessible through corresponding lenses are:
pNonKeyAttributes :: Lens' Projection (NonEmpty Text) Source
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) Source
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.
Select
AllAttributes | ALL_ATTRIBUTES |
AllProjectedAttributes | ALL_PROJECTED_ATTRIBUTES |
Count | COUNT |
SpecificAttributes | SPECIFIC_ATTRIBUTES |
KeySchemaElement
data KeySchemaElement Source
KeySchemaElement
constructor.
The fields accessible through corresponding lenses are:
kseAttributeName :: Lens' KeySchemaElement Text Source
The name of a key attribute.
kseKeyType :: Lens' KeySchemaElement KeyType Source
The attribute data, consisting of the data type and the attribute value itself.
DeleteRequest
data DeleteRequest Source
deleteRequest :: DeleteRequest Source
DeleteRequest
constructor.
The fields accessible through corresponding lenses are:
dKey :: Lens' DeleteRequest (HashMap Text AttributeValue) Source
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.
UpdateGlobalSecondaryIndexAction
updateGlobalSecondaryIndexAction Source
UpdateGlobalSecondaryIndexAction
constructor.
The fields accessible through corresponding lenses are:
ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text Source
The name of the global secondary index to be updated.
PutRequest
data PutRequest Source
putRequest :: PutRequest Source
PutRequest
constructor.
The fields accessible through corresponding lenses are:
pItem :: Lens' PutRequest (HashMap Text AttributeValue) Source
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.
Condition
Condition
constructor.
The fields accessible through corresponding lenses are:
cAttributeValueList :: Lens' Condition [AttributeValue] Source
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 aa
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 example when evaluating query expressions.
cComparisonOperator :: Lens' Condition ComparisonOperator Source
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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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 specified 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.
ConditionalOperator
data ConditionalOperator Source
GlobalSecondaryIndexUpdate
globalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate Source
GlobalSecondaryIndexUpdate
constructor.
The fields accessible through corresponding lenses are:
gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction) Source
The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.