| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.DynamoDB
Contents
- Service Configuration
- Errors
- BackupNotFoundException
- TableInUseException
- ContinuousBackupsUnavailableException
- ProvisionedThroughputExceededException
- GlobalTableNotFoundException
- ConditionalCheckFailedException
- GlobalTableAlreadyExistsException
- ReplicaNotFoundException
- TableAlreadyExistsException
- ItemCollectionSizeLimitExceededException
- InternalServerError
- TableNotFoundException
- IndexNotFoundException
- BackupInUseException
- PointInTimeRecoveryUnavailableException
- InvalidRestoreTimeException
- ResourceNotFoundException
- ReplicaAlreadyExistsException
- LimitExceededException
- ResourceInUseException
- Waiters
- Operations
- PutItem
- DeleteItem
- UpdateItem
- ListGlobalTables
- UpdateGlobalTable
- DeleteTable
- UpdateTable
- BatchGetItem
- ListBackups (Paginated)
- DeleteBackup
- CreateBackup
- DescribeGlobalTableSettings
- ListTagsOfResource
- DescribeGlobalTable
- DescribeTable
- DescribeLimits
- GetItem
- DescribeBackup
- UpdateGlobalTableSettings
- BatchWriteItem
- ListTables (Paginated)
- Scan (Paginated)
- Query (Paginated)
- CreateTable
- DescribeTimeToLive
- DescribeContinuousBackups
- TagResource
- UntagResource
- RestoreTableToPointInTime
- RestoreTableFromBackup
- UpdateTimeToLive
- CreateGlobalTable
- UpdateContinuousBackups
- Types
- AttributeAction
- BackupStatus
- ComparisonOperator
- ConditionalOperator
- ContinuousBackupsStatus
- GlobalTableStatus
- IndexStatus
- KeyType
- PointInTimeRecoveryStatus
- ProjectionType
- ReplicaStatus
- ReturnConsumedCapacity
- ReturnItemCollectionMetrics
- ReturnValue
- SSEStatus
- ScalarAttributeType
- Select
- StreamViewType
- TableStatus
- TimeToLiveStatus
- AttributeDefinition
- AttributeValue
- AttributeValueUpdate
- BackupDescription
- BackupDetails
- BackupSummary
- Capacity
- Condition
- ConsumedCapacity
- ContinuousBackupsDescription
- CreateGlobalSecondaryIndexAction
- CreateReplicaAction
- DeleteGlobalSecondaryIndexAction
- DeleteReplicaAction
- DeleteRequest
- ExpectedAttributeValue
- GlobalSecondaryIndex
- GlobalSecondaryIndexDescription
- GlobalSecondaryIndexInfo
- GlobalSecondaryIndexUpdate
- GlobalTable
- GlobalTableDescription
- GlobalTableGlobalSecondaryIndexSettingsUpdate
- ItemCollectionMetrics
- KeySchemaElement
- KeysAndAttributes
- LocalSecondaryIndex
- LocalSecondaryIndexDescription
- LocalSecondaryIndexInfo
- PointInTimeRecoveryDescription
- PointInTimeRecoverySpecification
- Projection
- ProvisionedThroughput
- ProvisionedThroughputDescription
- PutRequest
- Replica
- ReplicaDescription
- ReplicaGlobalSecondaryIndexSettingsDescription
- ReplicaGlobalSecondaryIndexSettingsUpdate
- ReplicaSettingsDescription
- ReplicaSettingsUpdate
- ReplicaUpdate
- RestoreSummary
- SSEDescription
- SSESpecification
- SourceTableDetails
- SourceTableFeatureDetails
- StreamSpecification
- TableDescription
- Tag
- TimeToLiveDescription
- TimeToLiveSpecification
- UpdateGlobalSecondaryIndexAction
- WriteRequest
Description
Amazon DynamoDB
Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.
DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.
Synopsis
- dynamoDB :: Service
- _BackupNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TableInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _ContinuousBackupsUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalTableNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConditionalCheckFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalTableAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicaNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TableAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ItemCollectionSizeLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _TableNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _IndexNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _BackupInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PointInTimeRecoveryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidRestoreTimeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicaAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- tableNotExists :: Wait DescribeTable
- tableExists :: Wait DescribeTable
- module Network.AWS.DynamoDB.PutItem
- module Network.AWS.DynamoDB.DeleteItem
- module Network.AWS.DynamoDB.UpdateItem
- module Network.AWS.DynamoDB.ListGlobalTables
- module Network.AWS.DynamoDB.UpdateGlobalTable
- module Network.AWS.DynamoDB.DeleteTable
- module Network.AWS.DynamoDB.UpdateTable
- module Network.AWS.DynamoDB.BatchGetItem
- module Network.AWS.DynamoDB.ListBackups
- module Network.AWS.DynamoDB.DeleteBackup
- module Network.AWS.DynamoDB.CreateBackup
- module Network.AWS.DynamoDB.DescribeGlobalTableSettings
- module Network.AWS.DynamoDB.ListTagsOfResource
- module Network.AWS.DynamoDB.DescribeGlobalTable
- module Network.AWS.DynamoDB.DescribeTable
- module Network.AWS.DynamoDB.DescribeLimits
- module Network.AWS.DynamoDB.GetItem
- module Network.AWS.DynamoDB.DescribeBackup
- module Network.AWS.DynamoDB.UpdateGlobalTableSettings
- module Network.AWS.DynamoDB.BatchWriteItem
- module Network.AWS.DynamoDB.ListTables
- module Network.AWS.DynamoDB.Scan
- module Network.AWS.DynamoDB.Query
- module Network.AWS.DynamoDB.CreateTable
- module Network.AWS.DynamoDB.DescribeTimeToLive
- module Network.AWS.DynamoDB.DescribeContinuousBackups
- module Network.AWS.DynamoDB.TagResource
- module Network.AWS.DynamoDB.UntagResource
- module Network.AWS.DynamoDB.RestoreTableToPointInTime
- module Network.AWS.DynamoDB.RestoreTableFromBackup
- module Network.AWS.DynamoDB.UpdateTimeToLive
- module Network.AWS.DynamoDB.CreateGlobalTable
- module Network.AWS.DynamoDB.UpdateContinuousBackups
- data AttributeAction
- data BackupStatus
- data ComparisonOperator
- data ConditionalOperator
- data ContinuousBackupsStatus
- data GlobalTableStatus
- data IndexStatus
- data KeyType
- data PointInTimeRecoveryStatus
- data ProjectionType
- = PTAll
- | PTInclude
- | PTKeysOnly
- data ReplicaStatus
- data ReturnConsumedCapacity
- data ReturnItemCollectionMetrics
- data ReturnValue
- = AllNew
- | AllOld
- | None
- | UpdatedNew
- | UpdatedOld
- data SSEStatus
- data ScalarAttributeType
- data Select
- data StreamViewType
- data TableStatus
- data TimeToLiveStatus
- data AttributeDefinition
- attributeDefinition :: Text -> ScalarAttributeType -> AttributeDefinition
- adAttributeName :: Lens' AttributeDefinition Text
- adAttributeType :: Lens' AttributeDefinition ScalarAttributeType
- data AttributeValue
- attributeValue :: AttributeValue
- avL :: Lens' AttributeValue [AttributeValue]
- avNS :: Lens' AttributeValue [Text]
- avM :: Lens' AttributeValue (HashMap Text AttributeValue)
- avNULL :: Lens' AttributeValue (Maybe Bool)
- avN :: Lens' AttributeValue (Maybe Text)
- avBS :: Lens' AttributeValue [ByteString]
- avB :: Lens' AttributeValue (Maybe ByteString)
- avSS :: Lens' AttributeValue [Text]
- avS :: Lens' AttributeValue (Maybe Text)
- avBOOL :: Lens' AttributeValue (Maybe Bool)
- data AttributeValueUpdate
- attributeValueUpdate :: AttributeValueUpdate
- avuValue :: Lens' AttributeValueUpdate (Maybe AttributeValue)
- avuAction :: Lens' AttributeValueUpdate (Maybe AttributeAction)
- data BackupDescription
- backupDescription :: BackupDescription
- bdBackupDetails :: Lens' BackupDescription (Maybe BackupDetails)
- bdSourceTableDetails :: Lens' BackupDescription (Maybe SourceTableDetails)
- bdSourceTableFeatureDetails :: Lens' BackupDescription (Maybe SourceTableFeatureDetails)
- data BackupDetails
- backupDetails :: Text -> Text -> BackupStatus -> UTCTime -> BackupDetails
- bdBackupSizeBytes :: Lens' BackupDetails (Maybe Natural)
- bdBackupARN :: Lens' BackupDetails Text
- bdBackupName :: Lens' BackupDetails Text
- bdBackupStatus :: Lens' BackupDetails BackupStatus
- bdBackupCreationDateTime :: Lens' BackupDetails UTCTime
- data BackupSummary
- backupSummary :: BackupSummary
- bsTableARN :: Lens' BackupSummary (Maybe Text)
- bsBackupName :: Lens' BackupSummary (Maybe Text)
- bsBackupStatus :: Lens' BackupSummary (Maybe BackupStatus)
- bsBackupSizeBytes :: Lens' BackupSummary (Maybe Natural)
- bsBackupARN :: Lens' BackupSummary (Maybe Text)
- bsTableId :: Lens' BackupSummary (Maybe Text)
- bsBackupCreationDateTime :: Lens' BackupSummary (Maybe UTCTime)
- bsTableName :: Lens' BackupSummary (Maybe Text)
- data Capacity
- capacity :: Capacity
- cCapacityUnits :: Lens' Capacity (Maybe Double)
- data Condition
- condition :: ComparisonOperator -> Condition
- cAttributeValueList :: Lens' Condition [AttributeValue]
- cComparisonOperator :: Lens' Condition ComparisonOperator
- data ConsumedCapacity
- consumedCapacity :: ConsumedCapacity
- ccGlobalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity)
- ccCapacityUnits :: Lens' ConsumedCapacity (Maybe Double)
- ccLocalSecondaryIndexes :: Lens' ConsumedCapacity (HashMap Text Capacity)
- ccTable :: Lens' ConsumedCapacity (Maybe Capacity)
- ccTableName :: Lens' ConsumedCapacity (Maybe Text)
- data ContinuousBackupsDescription
- continuousBackupsDescription :: ContinuousBackupsStatus -> ContinuousBackupsDescription
- cbdPointInTimeRecoveryDescription :: Lens' ContinuousBackupsDescription (Maybe PointInTimeRecoveryDescription)
- cbdContinuousBackupsStatus :: Lens' ContinuousBackupsDescription ContinuousBackupsStatus
- data CreateGlobalSecondaryIndexAction
- createGlobalSecondaryIndexAction :: Text -> NonEmpty KeySchemaElement -> Projection -> ProvisionedThroughput -> CreateGlobalSecondaryIndexAction
- cgsiaIndexName :: Lens' CreateGlobalSecondaryIndexAction Text
- cgsiaKeySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement)
- cgsiaProjection :: Lens' CreateGlobalSecondaryIndexAction Projection
- cgsiaProvisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction ProvisionedThroughput
- data CreateReplicaAction
- createReplicaAction :: Text -> CreateReplicaAction
- craRegionName :: Lens' CreateReplicaAction Text
- data DeleteGlobalSecondaryIndexAction
- deleteGlobalSecondaryIndexAction :: Text -> DeleteGlobalSecondaryIndexAction
- dgsiaIndexName :: Lens' DeleteGlobalSecondaryIndexAction Text
- data DeleteReplicaAction
- deleteReplicaAction :: Text -> DeleteReplicaAction
- draRegionName :: Lens' DeleteReplicaAction Text
- data DeleteRequest
- deleteRequest :: DeleteRequest
- drKey :: Lens' DeleteRequest (HashMap Text AttributeValue)
- data ExpectedAttributeValue
- expectedAttributeValue :: ExpectedAttributeValue
- eavAttributeValueList :: Lens' ExpectedAttributeValue [AttributeValue]
- eavExists :: Lens' ExpectedAttributeValue (Maybe Bool)
- eavValue :: Lens' ExpectedAttributeValue (Maybe AttributeValue)
- eavComparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator)
- 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 GlobalSecondaryIndexDescription
- globalSecondaryIndexDescription :: GlobalSecondaryIndexDescription
- gsidBackfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool)
- gsidIndexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- gsidIndexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus)
- gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription)
- gsidIndexARN :: Lens' GlobalSecondaryIndexDescription (Maybe Text)
- gsidKeySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement))
- gsidProjection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection)
- gsidItemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- gsidIndexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text)
- data GlobalSecondaryIndexInfo
- globalSecondaryIndexInfo :: GlobalSecondaryIndexInfo
- gsiiProvisionedThroughput :: Lens' GlobalSecondaryIndexInfo (Maybe ProvisionedThroughput)
- gsiiKeySchema :: Lens' GlobalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement))
- gsiiProjection :: Lens' GlobalSecondaryIndexInfo (Maybe Projection)
- gsiiIndexName :: Lens' GlobalSecondaryIndexInfo (Maybe Text)
- data GlobalSecondaryIndexUpdate
- globalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate
- gsiuCreate :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction)
- gsiuDelete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction)
- gsiuUpdate :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction)
- data GlobalTable
- globalTable :: GlobalTable
- gtGlobalTableName :: Lens' GlobalTable (Maybe Text)
- gtReplicationGroup :: Lens' GlobalTable [Replica]
- data GlobalTableDescription
- globalTableDescription :: GlobalTableDescription
- gtdGlobalTableStatus :: Lens' GlobalTableDescription (Maybe GlobalTableStatus)
- gtdGlobalTableName :: Lens' GlobalTableDescription (Maybe Text)
- gtdGlobalTableARN :: Lens' GlobalTableDescription (Maybe Text)
- gtdCreationDateTime :: Lens' GlobalTableDescription (Maybe UTCTime)
- gtdReplicationGroup :: Lens' GlobalTableDescription [ReplicaDescription]
- data GlobalTableGlobalSecondaryIndexSettingsUpdate
- globalTableGlobalSecondaryIndexSettingsUpdate :: Text -> GlobalTableGlobalSecondaryIndexSettingsUpdate
- gtgsisuProvisionedWriteCapacityUnits :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe Natural)
- gtgsisuIndexName :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate Text
- data ItemCollectionMetrics
- itemCollectionMetrics :: ItemCollectionMetrics
- icmItemCollectionKey :: Lens' ItemCollectionMetrics (HashMap Text AttributeValue)
- icmSizeEstimateRangeGB :: Lens' ItemCollectionMetrics [Double]
- data KeySchemaElement
- keySchemaElement :: Text -> KeyType -> KeySchemaElement
- kseAttributeName :: Lens' KeySchemaElement Text
- kseKeyType :: Lens' KeySchemaElement KeyType
- data KeysAndAttributes
- keysAndAttributes :: NonEmpty (HashMap Text AttributeValue) -> KeysAndAttributes
- kaaProjectionExpression :: Lens' KeysAndAttributes (Maybe Text)
- kaaAttributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text))
- kaaExpressionAttributeNames :: Lens' KeysAndAttributes (HashMap Text Text)
- kaaConsistentRead :: Lens' KeysAndAttributes (Maybe Bool)
- kaaKeys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue))
- data LocalSecondaryIndex
- localSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> LocalSecondaryIndex
- lsiIndexName :: Lens' LocalSecondaryIndex Text
- lsiKeySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement)
- lsiProjection :: Lens' LocalSecondaryIndex Projection
- data LocalSecondaryIndexDescription
- localSecondaryIndexDescription :: LocalSecondaryIndexDescription
- lsidIndexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- lsidIndexARN :: Lens' LocalSecondaryIndexDescription (Maybe Text)
- lsidKeySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement))
- lsidProjection :: Lens' LocalSecondaryIndexDescription (Maybe Projection)
- lsidItemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- lsidIndexName :: Lens' LocalSecondaryIndexDescription (Maybe Text)
- data LocalSecondaryIndexInfo
- localSecondaryIndexInfo :: LocalSecondaryIndexInfo
- lsiiKeySchema :: Lens' LocalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement))
- lsiiProjection :: Lens' LocalSecondaryIndexInfo (Maybe Projection)
- lsiiIndexName :: Lens' LocalSecondaryIndexInfo (Maybe Text)
- data PointInTimeRecoveryDescription
- pointInTimeRecoveryDescription :: PointInTimeRecoveryDescription
- pitrdPointInTimeRecoveryStatus :: Lens' PointInTimeRecoveryDescription (Maybe PointInTimeRecoveryStatus)
- pitrdEarliestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime)
- pitrdLatestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime)
- data PointInTimeRecoverySpecification
- pointInTimeRecoverySpecification :: Bool -> PointInTimeRecoverySpecification
- pitrsPointInTimeRecoveryEnabled :: Lens' PointInTimeRecoverySpecification Bool
- data Projection
- projection :: Projection
- pProjectionType :: Lens' Projection (Maybe ProjectionType)
- pNonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text))
- data ProvisionedThroughput
- provisionedThroughput :: Natural -> Natural -> ProvisionedThroughput
- ptReadCapacityUnits :: Lens' ProvisionedThroughput Natural
- ptWriteCapacityUnits :: Lens' ProvisionedThroughput Natural
- data ProvisionedThroughputDescription
- provisionedThroughputDescription :: ProvisionedThroughputDescription
- ptdReadCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- ptdLastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- ptdWriteCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- ptdNumberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- ptdLastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- data PutRequest
- putRequest :: PutRequest
- prItem :: Lens' PutRequest (HashMap Text AttributeValue)
- data Replica
- replica :: Replica
- rRegionName :: Lens' Replica (Maybe Text)
- data ReplicaDescription
- replicaDescription :: ReplicaDescription
- rdRegionName :: Lens' ReplicaDescription (Maybe Text)
- data ReplicaGlobalSecondaryIndexSettingsDescription
- replicaGlobalSecondaryIndexSettingsDescription :: Text -> ReplicaGlobalSecondaryIndexSettingsDescription
- rgsisdIndexStatus :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe IndexStatus)
- rgsisdProvisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural)
- rgsisdProvisionedWriteCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural)
- rgsisdIndexName :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription Text
- data ReplicaGlobalSecondaryIndexSettingsUpdate
- replicaGlobalSecondaryIndexSettingsUpdate :: Text -> ReplicaGlobalSecondaryIndexSettingsUpdate
- rgsisuProvisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe Natural)
- rgsisuIndexName :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate Text
- data ReplicaSettingsDescription
- replicaSettingsDescription :: Text -> ReplicaSettingsDescription
- rsdReplicaStatus :: Lens' ReplicaSettingsDescription (Maybe ReplicaStatus)
- rsdReplicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural)
- rsdReplicaProvisionedWriteCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural)
- rsdReplicaGlobalSecondaryIndexSettings :: Lens' ReplicaSettingsDescription [ReplicaGlobalSecondaryIndexSettingsDescription]
- rsdRegionName :: Lens' ReplicaSettingsDescription Text
- data ReplicaSettingsUpdate
- replicaSettingsUpdate :: Text -> ReplicaSettingsUpdate
- rsuReplicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsUpdate (Maybe Natural)
- rsuReplicaGlobalSecondaryIndexSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate))
- rsuRegionName :: Lens' ReplicaSettingsUpdate Text
- data ReplicaUpdate
- replicaUpdate :: ReplicaUpdate
- ruCreate :: Lens' ReplicaUpdate (Maybe CreateReplicaAction)
- ruDelete :: Lens' ReplicaUpdate (Maybe DeleteReplicaAction)
- data RestoreSummary
- restoreSummary :: UTCTime -> Bool -> RestoreSummary
- rsSourceTableARN :: Lens' RestoreSummary (Maybe Text)
- rsSourceBackupARN :: Lens' RestoreSummary (Maybe Text)
- rsRestoreDateTime :: Lens' RestoreSummary UTCTime
- rsRestoreInProgress :: Lens' RestoreSummary Bool
- data SSEDescription
- sSEDescription :: SSEDescription
- ssedStatus :: Lens' SSEDescription (Maybe SSEStatus)
- data SSESpecification
- sSESpecification :: Bool -> SSESpecification
- ssesEnabled :: Lens' SSESpecification Bool
- data SourceTableDetails
- sourceTableDetails :: Text -> Text -> NonEmpty KeySchemaElement -> UTCTime -> ProvisionedThroughput -> SourceTableDetails
- stdTableSizeBytes :: Lens' SourceTableDetails (Maybe Integer)
- stdTableARN :: Lens' SourceTableDetails (Maybe Text)
- stdItemCount :: Lens' SourceTableDetails (Maybe Natural)
- stdTableName :: Lens' SourceTableDetails Text
- stdTableId :: Lens' SourceTableDetails Text
- stdKeySchema :: Lens' SourceTableDetails (NonEmpty KeySchemaElement)
- stdTableCreationDateTime :: Lens' SourceTableDetails UTCTime
- stdProvisionedThroughput :: Lens' SourceTableDetails ProvisionedThroughput
- data SourceTableFeatureDetails
- sourceTableFeatureDetails :: SourceTableFeatureDetails
- stfdStreamDescription :: Lens' SourceTableFeatureDetails (Maybe StreamSpecification)
- stfdGlobalSecondaryIndexes :: Lens' SourceTableFeatureDetails [GlobalSecondaryIndexInfo]
- stfdLocalSecondaryIndexes :: Lens' SourceTableFeatureDetails [LocalSecondaryIndexInfo]
- stfdSSEDescription :: Lens' SourceTableFeatureDetails (Maybe SSEDescription)
- stfdTimeToLiveDescription :: Lens' SourceTableFeatureDetails (Maybe TimeToLiveDescription)
- data StreamSpecification
- streamSpecification :: StreamSpecification
- ssStreamViewType :: Lens' StreamSpecification (Maybe StreamViewType)
- ssStreamEnabled :: Lens' StreamSpecification (Maybe Bool)
- data TableDescription
- tableDescription :: TableDescription
- tdRestoreSummary :: Lens' TableDescription (Maybe RestoreSummary)
- tdTableSizeBytes :: Lens' TableDescription (Maybe Integer)
- tdAttributeDefinitions :: Lens' TableDescription [AttributeDefinition]
- tdLatestStreamARN :: Lens' TableDescription (Maybe Text)
- tdProvisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription)
- tdTableStatus :: Lens' TableDescription (Maybe TableStatus)
- tdTableARN :: Lens' TableDescription (Maybe Text)
- tdKeySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement))
- tdGlobalSecondaryIndexes :: Lens' TableDescription [GlobalSecondaryIndexDescription]
- tdLatestStreamLabel :: Lens' TableDescription (Maybe Text)
- tdLocalSecondaryIndexes :: Lens' TableDescription [LocalSecondaryIndexDescription]
- tdCreationDateTime :: Lens' TableDescription (Maybe UTCTime)
- tdSSEDescription :: Lens' TableDescription (Maybe SSEDescription)
- tdTableId :: Lens' TableDescription (Maybe Text)
- tdItemCount :: Lens' TableDescription (Maybe Integer)
- tdTableName :: Lens' TableDescription (Maybe Text)
- tdStreamSpecification :: Lens' TableDescription (Maybe StreamSpecification)
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data TimeToLiveDescription
- timeToLiveDescription :: TimeToLiveDescription
- ttldTimeToLiveStatus :: Lens' TimeToLiveDescription (Maybe TimeToLiveStatus)
- ttldAttributeName :: Lens' TimeToLiveDescription (Maybe Text)
- data TimeToLiveSpecification
- timeToLiveSpecification :: Bool -> Text -> TimeToLiveSpecification
- ttlsEnabled :: Lens' TimeToLiveSpecification Bool
- ttlsAttributeName :: Lens' TimeToLiveSpecification Text
- data UpdateGlobalSecondaryIndexAction
- updateGlobalSecondaryIndexAction :: Text -> ProvisionedThroughput -> UpdateGlobalSecondaryIndexAction
- ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text
- ugsiaProvisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput
- data WriteRequest
- writeRequest :: WriteRequest
- wrDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest)
- wrPutRequest :: Lens' WriteRequest (Maybe PutRequest)
Service 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.
BackupNotFoundException
_BackupNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
Backup not found for the given BackupARN.
TableInUseException
_TableInUseException :: AsError a => Getting (First ServiceError) a ServiceError #
A target table with the specified name is either being created or deleted.
ContinuousBackupsUnavailableException
_ContinuousBackupsUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError #
Backups have not yet been enabled for this table.
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 .
GlobalTableNotFoundException
_GlobalTableNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified global table does not exist.
ConditionalCheckFailedException
_ConditionalCheckFailedException :: AsError a => Getting (First ServiceError) a ServiceError #
A condition specified in the operation could not be evaluated.
GlobalTableAlreadyExistsException
_GlobalTableAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified global table already exists.
ReplicaNotFoundException
_ReplicaNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified replica is no longer part of the global table.
TableAlreadyExistsException
_TableAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
A target table with the specified name already exists.
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.
TableNotFoundException
_TableNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
A source table with the name TableName does not currently exist within the subscriber's account.
IndexNotFoundException
_IndexNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The operation tried to access a nonexistent index.
BackupInUseException
_BackupInUseException :: AsError a => Getting (First ServiceError) a ServiceError #
There is another ongoing conflicting backup control plane operation on the table. The backups is either being created, deleted or restored to a table.
PointInTimeRecoveryUnavailableException
_PointInTimeRecoveryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError #
Point in time recovery has not yet been enabled for this source table.
InvalidRestoreTimeException
_InvalidRestoreTimeException :: AsError a => Getting (First ServiceError) a ServiceError #
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
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 .
ReplicaAlreadyExistsException
_ReplicaAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError #
The specified replica is already part of the global table.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
Up to 50 CreateBackup operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken.
Up to 10 simultaneous table operations are allowed per account. These operations include CreateTable , UpdateTable , DeleteTable ,UpdateTimeToLive , RestoreTableFromBackup , and RestoreTableToPointInTime .
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
module Network.AWS.DynamoDB.PutItem
DeleteItem
UpdateItem
ListGlobalTables
UpdateGlobalTable
DeleteTable
UpdateTable
BatchGetItem
ListBackups (Paginated)
DeleteBackup
CreateBackup
DescribeGlobalTableSettings
ListTagsOfResource
DescribeGlobalTable
DescribeTable
DescribeLimits
GetItem
module Network.AWS.DynamoDB.GetItem
DescribeBackup
UpdateGlobalTableSettings
BatchWriteItem
ListTables (Paginated)
Scan (Paginated)
module Network.AWS.DynamoDB.Scan
Query (Paginated)
module Network.AWS.DynamoDB.Query
CreateTable
DescribeTimeToLive
DescribeContinuousBackups
TagResource
UntagResource
RestoreTableToPointInTime
RestoreTableFromBackup
UpdateTimeToLive
CreateGlobalTable
UpdateContinuousBackups
Types
AttributeAction
data AttributeAction #
Instances
BackupStatus
data BackupStatus #
Instances
ComparisonOperator
data ComparisonOperator #
Instances
ConditionalOperator
data ConditionalOperator #
Instances
ContinuousBackupsStatus
data ContinuousBackupsStatus #
Constructors
| CBSDisabled | |
| CBSEnabled |
Instances
GlobalTableStatus
data GlobalTableStatus #
Constructors
| GTSActive | |
| GTSCreating | |
| GTSDeleting | |
| GTSUpdating |
Instances
IndexStatus
data IndexStatus #
Constructors
| ISActive | |
| ISCreating | |
| ISDeleting | |
| ISUpdating |
Instances
KeyType
Instances
PointInTimeRecoveryStatus
data PointInTimeRecoveryStatus #
Constructors
| PITRSDisabled | |
| PITRSEnabled |
Instances
ProjectionType
data ProjectionType #
Constructors
| PTAll | |
| PTInclude | |
| PTKeysOnly |
Instances
ReplicaStatus
data ReplicaStatus #
Constructors
| RSActive | |
| RSCreating | |
| RSDeleting | |
| RSUpdating |
Instances
ReturnConsumedCapacity
data ReturnConsumedCapacity #
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES- The response includes the aggregateConsumedCapacityfor the operation, together withConsumedCapacityfor 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 aggregateConsumedCapacityfor the operation.NONE- NoConsumedCapacitydetails are included in the response.
Constructors
| RCCIndexes | |
| RCCNone | |
| RCCTotal |
Instances
ReturnItemCollectionMetrics
data ReturnItemCollectionMetrics #
Instances
ReturnValue
data ReturnValue #
Constructors
| AllNew | |
| AllOld | |
| None | |
| UpdatedNew | |
| UpdatedOld |
Instances
SSEStatus
Constructors
| SSESDisabled | |
| SSESDisabling | |
| SSESEnabled | |
| SSESEnabling |
Instances
ScalarAttributeType
data ScalarAttributeType #
Instances
Select
Constructors
| AllAttributes | |
| AllProjectedAttributes | |
| Count | |
| SpecificAttributes |
Instances
| Bounded Select # | |
| Enum Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| Eq Select # | |
| Data Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum 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 # | |
| Hashable Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| ToJSON Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| ToHeader Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum Methods toHeader :: HeaderName -> Select -> [Header] # | |
| ToQuery Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum Methods toQuery :: Select -> QueryString # | |
| ToByteString Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum Methods toBS :: Select -> ByteString # | |
| FromText Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| ToText Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| NFData Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum | |
| type Rep Select # | |
Defined in Network.AWS.DynamoDB.Types.Sum type Rep Select = D1 (MetaData "Select" "Network.AWS.DynamoDB.Types.Sum" "amazonka-dynamodb-1.6.0-COMX9FqvIeW1LBbyPqhpUT" 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 #
Constructors
| KeysOnly | |
| NewAndOldImages | |
| NewImage | |
| OldImage |
Instances
TableStatus
data TableStatus #
Constructors
| TSActive | |
| TSCreating | |
| TSDeleting | |
| TSUpdating |
Instances
TimeToLiveStatus
data TimeToLiveStatus #
Instances
AttributeDefinition
data AttributeDefinition #
Represents an attribute for describing the key schema for the table and indexes.
See: attributeDefinition smart constructor.
Instances
Arguments
| :: Text | |
| -> 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.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide .
See: attributeValue smart constructor.
Instances
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- An attribute of type List. For example:L: [Cookies, Coffee, 3.14159]avNS- An attribute of type Number Set. For example:NS: ["42.2", "-19", "7.5", "3.14"]Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.avM- An attribute of type Map. For example:M: {Name: {S: Joe}, Age: {N: "35"}}avNULL- An attribute of type Null. For example:NULL: trueavN- An attribute of type Number. For example:N: "123.45"Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.avBS- An attribute of type Binary Set. For example:BS: ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]avB- An attribute of type Binary. For example:B: "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.avSS- An attribute of type String Set. For example:SS: [Giraffe, Hippo ,Zebra]avS- An attribute of type String. For example:S: HelloavBOOL- An attribute of type Boolean. For example:BOOL: true
avNS :: Lens' AttributeValue [Text] #
An attribute of type Number Set. For example: NS: ["42.2", "-19", "7.5", "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
avN :: Lens' AttributeValue (Maybe Text) #
An attribute of type Number. For example: N: "123.45" Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
avBS :: Lens' AttributeValue [ByteString] #
An attribute of type Binary Set. For example: BS: ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
avB :: Lens' AttributeValue (Maybe ByteString) #
An attribute of type Binary. For example: B: "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk" -- 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] #
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
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- Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide .avuAction- Specifies how to perform the update. Valid values arePUT(default),DELETE, andADD. 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 theDELETEaction 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 ofADDdepends on the data type of the attribute: * If the existing attribute is a number, and ifValueis also a number, then theValueis mathematically added to the existing attribute. IfValueis a negative number, then it is subtracted from the existing attribute. * If the existing data type is a set, and if theValueis also a set, then theValueis 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 theADDaction 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, theValuemust 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 useADDfor 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.
avuValue :: Lens' AttributeValueUpdate (Maybe AttributeValue) #
Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide .
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.
BackupDescription
data BackupDescription #
Contains the description of the backup created for the table.
See: backupDescription smart constructor.
Instances
backupDescription :: BackupDescription #
Creates a value of BackupDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdBackupDetails- Contains the details of the backup created for the table.bdSourceTableDetails- Contains the details of the table when the backup was created.bdSourceTableFeatureDetails- Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
bdBackupDetails :: Lens' BackupDescription (Maybe BackupDetails) #
Contains the details of the backup created for the table.
bdSourceTableDetails :: Lens' BackupDescription (Maybe SourceTableDetails) #
Contains the details of the table when the backup was created.
bdSourceTableFeatureDetails :: Lens' BackupDescription (Maybe SourceTableFeatureDetails) #
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
BackupDetails
data BackupDetails #
Contains the details of the backup created for the table.
See: backupDetails smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> BackupStatus | |
| -> UTCTime | |
| -> BackupDetails |
Creates a value of BackupDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdBackupSizeBytes- Size of the backup in bytes.bdBackupARN- ARN associated with the backup.bdBackupName- Name of the requested backup.bdBackupStatus- Backup can be in one of the following states: CREATING, ACTIVE, DELETED.bdBackupCreationDateTime- Time at which the backup was created. This is the request time of the backup.
bdBackupSizeBytes :: Lens' BackupDetails (Maybe Natural) #
Size of the backup in bytes.
bdBackupARN :: Lens' BackupDetails Text #
ARN associated with the backup.
bdBackupName :: Lens' BackupDetails Text #
Name of the requested backup.
bdBackupStatus :: Lens' BackupDetails BackupStatus #
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
bdBackupCreationDateTime :: Lens' BackupDetails UTCTime #
Time at which the backup was created. This is the request time of the backup.
BackupSummary
data BackupSummary #
Contains details for the backup.
See: backupSummary smart constructor.
Instances
backupSummary :: BackupSummary #
Creates a value of BackupSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bsTableARN- ARN associated with the table.bsBackupName- Name of the specified backup.bsBackupStatus- Backup can be in one of the following states: CREATING, ACTIVE, DELETED.bsBackupSizeBytes- Size of the backup in bytes.bsBackupARN- ARN associated with the backup.bsTableId- Unique identifier for the table.bsBackupCreationDateTime- Time at which the backup was created.bsTableName- Name of the table.
bsTableARN :: Lens' BackupSummary (Maybe Text) #
ARN associated with the table.
bsBackupName :: Lens' BackupSummary (Maybe Text) #
Name of the specified backup.
bsBackupStatus :: Lens' BackupSummary (Maybe BackupStatus) #
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
bsBackupSizeBytes :: Lens' BackupSummary (Maybe Natural) #
Size of the backup in bytes.
bsBackupARN :: Lens' BackupSummary (Maybe Text) #
ARN associated with the backup.
bsBackupCreationDateTime :: Lens' BackupSummary (Maybe UTCTime) #
Time at which the backup was created.
bsTableName :: Lens' BackupSummary (Maybe Text) #
Name of the table.
Capacity
Represents the amount of provisioned throughput capacity consumed on a table or an index.
See: capacity smart constructor.
Instances
| Eq Capacity # | |
| Data Capacity # | |
Defined in Network.AWS.DynamoDB.Types.Product 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 # | |
| Hashable Capacity # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| FromJSON Capacity # | |
| NFData Capacity # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| type Rep Capacity # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
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
Represents the selection criteria for a Query or Scan operation:
- For a
Queryoperation,Conditionis used for specifying theKeyConditionsto use when querying a table or an index. ForKeyConditions, 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
Scanoperation,Conditionis used in aScanFilter, which evaluates the scan results and returns only the desired values.
See: condition smart constructor.
Instances
| Eq Condition # | |
| Data Condition # | |
Defined in Network.AWS.DynamoDB.Types.Product 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 # | |
| Hashable Condition # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| ToJSON Condition # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| NFData Condition # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| type Rep Condition # | |
Defined in Network.AWS.DynamoDB.Types.Product type Rep Condition = D1 (MetaData "Condition" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.6.0-COMX9FqvIeW1LBbyPqhpUT" False) (C1 (MetaCons "Condition'" PrefixI True) (S1 (MetaSel (Just "_cAttributeValueList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [AttributeValue])) :*: S1 (MetaSel (Just "_cComparisonOperator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ComparisonOperator))) | |
Arguments
| :: 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 theComparisonOperatorbeing 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,ais greater thanA, andais greater thanB. 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 | BETWEENThe following are descriptions of each comparison operator. *EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement 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.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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_NULLis supported for all data types, including lists and maps. *NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps. *CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement 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 ofAttributeValueListandComparisonOperator, 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 data types, 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 data types, 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 data types, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all data types, 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 in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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
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.
ContinuousBackupsDescription
data ContinuousBackupsDescription #
Represents the continuous backups and point in time recovery settings on the table.
See: continuousBackupsDescription smart constructor.
Instances
continuousBackupsDescription #
Creates a value of ContinuousBackupsDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cbdPointInTimeRecoveryDescription- The description of the point in time recovery settings applied to the table.cbdContinuousBackupsStatus-ContinuousBackupsStatuscan be one of the following states : ENABLED, DISABLED
cbdPointInTimeRecoveryDescription :: Lens' ContinuousBackupsDescription (Maybe PointInTimeRecoveryDescription) #
The description of the point in time recovery settings applied to the table.
cbdContinuousBackupsStatus :: Lens' ContinuousBackupsDescription ContinuousBackupsStatus #
ContinuousBackupsStatus can be one of the following states : ENABLED, DISABLED
CreateGlobalSecondaryIndexAction
data CreateGlobalSecondaryIndexAction #
Represents a new global secondary index to be added to an existing table.
See: createGlobalSecondaryIndexAction smart constructor.
Instances
createGlobalSecondaryIndexAction #
Arguments
| :: Text | |
| -> NonEmpty KeySchemaElement | |
| -> Projection | |
| -> 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- The name of the global secondary index to be created.cgsiaKeySchema- The key schema for the global secondary index.cgsiaProjection- 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.cgsiaProvisionedThroughput- Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
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.
cgsiaProjection :: Lens' CreateGlobalSecondaryIndexAction 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.
cgsiaProvisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction ProvisionedThroughput #
Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
CreateReplicaAction
data CreateReplicaAction #
Represents a replica to be added.
See: createReplicaAction smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateReplicaAction |
Creates a value of CreateReplicaAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
craRegionName- The region of the replica to be added.
craRegionName :: Lens' CreateReplicaAction Text #
The region of the replica to be added.
DeleteGlobalSecondaryIndexAction
data DeleteGlobalSecondaryIndexAction #
Represents a global secondary index to be deleted from an existing table.
See: deleteGlobalSecondaryIndexAction smart constructor.
Instances
deleteGlobalSecondaryIndexAction #
Arguments
| :: 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.
DeleteReplicaAction
data DeleteReplicaAction #
Represents a replica to be removed.
See: deleteReplicaAction smart constructor.
Instances
Arguments
| :: Text | |
| -> DeleteReplicaAction |
Creates a value of DeleteReplicaAction with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
draRegionName- The region of the replica to be removed.
draRegionName :: Lens' DeleteReplicaAction Text #
The region of the replica to be removed.
DeleteRequest
data DeleteRequest #
Represents a request to perform a DeleteItem operation on an item.
See: deleteRequest smart constructor.
Instances
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
AttributeValueListto specify one or more values to compare against an attribute. UseComparisonOperatorto specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. - Use
Valueto specify a value that DynamoDB will compare against an attribute. If the values match, thenExpectedAttributeValueevaluates to true and the conditional operation succeeds. Optionally, you can also setExiststo 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
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 theComparisonOperatorbeing 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,ais greater thanA, andais greater thanB. 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: * IfExistsistrue, 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 aConditionalCheckFailedException. * IfExistsisfalse, 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 aConditionalCheckFailedException. The default setting forExistsistrue. If you supply aValueall by itself, DynamoDB assumes the attribute exists: You don't have to setExiststotrue, because it is implied. DynamoDB returns aValidationExceptionif: *Existsistruebut there is noValueto check. (You expect a value to exist, but don't specify what that value is.) *Existsisfalsebut you also provide aValue. (You cannot expect an attribute to have a value, while also expecting it not to exist.)eavValue- Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide .eavComparisonOperator- A comparator for evaluating attributes in theAttributeValueList. 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 | BETWEENThe following are descriptions of each comparison operator. *EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement 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.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement 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_NULLis supported for all data types, including lists and maps. *NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps. *CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement 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.)
eavValue :: Lens' ExpectedAttributeValue (Maybe AttributeValue) #
Represents the data for the expected attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types in the Amazon DynamoDB Developer Guide .
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 data types, 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 data types, 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 data types, including lists and maps. * NULL : The attribute does not exist. NULL is supported for all data types, 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 in a list. AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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
Arguments
| :: Text | |
| -> NonEmpty KeySchemaElement | |
| -> Projection | |
| -> 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 keygsiProjection- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.gsiProvisionedThroughput- Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
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
gsiProjection :: Lens' GlobalSecondaryIndex Projection #
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
gsiProvisionedThroughput :: Lens' GlobalSecondaryIndex ProvisionedThroughput #
Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
GlobalSecondaryIndexDescription
data GlobalSecondaryIndexDescription #
Represents the properties of a global secondary index.
See: globalSecondaryIndexDescription smart constructor.
Instances
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 andBackfillingis 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- Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .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 keygsidProjection- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.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.
gsidProvisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription) #
Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
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
gsidProjection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection) #
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
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.
GlobalSecondaryIndexInfo
data GlobalSecondaryIndexInfo #
Represents the properties of a global secondary index for the table when the backup was created.
See: globalSecondaryIndexInfo smart constructor.
Instances
globalSecondaryIndexInfo :: GlobalSecondaryIndexInfo #
Creates a value of GlobalSecondaryIndexInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsiiProvisionedThroughput- Represents the provisioned throughput settings for the specified global secondary index.gsiiKeySchema- 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 keygsiiProjection- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.gsiiIndexName- The name of the global secondary index.
gsiiProvisionedThroughput :: Lens' GlobalSecondaryIndexInfo (Maybe ProvisionedThroughput) #
Represents the provisioned throughput settings for the specified global secondary index.
gsiiKeySchema :: Lens' GlobalSecondaryIndexInfo (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
gsiiProjection :: Lens' GlobalSecondaryIndexInfo (Maybe Projection) #
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
gsiiIndexName :: Lens' GlobalSecondaryIndexInfo (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
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*ProvisionedThroughputgsiuDelete- 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.
GlobalTable
data GlobalTable #
Represents the properties of a global table.
See: globalTable smart constructor.
Instances
Creates a value of GlobalTable with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtGlobalTableName- The global table name.gtReplicationGroup- The regions where the global table has replicas.
gtGlobalTableName :: Lens' GlobalTable (Maybe Text) #
The global table name.
gtReplicationGroup :: Lens' GlobalTable [Replica] #
The regions where the global table has replicas.
GlobalTableDescription
data GlobalTableDescription #
Contains details about the global table.
See: globalTableDescription smart constructor.
Instances
globalTableDescription :: GlobalTableDescription #
Creates a value of GlobalTableDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtdGlobalTableStatus- The current state of the global table: *CREATING- The global table is being created. *UPDATING- The global table is being updated. *DELETING- The global table is being deleted. *ACTIVE- The global table is ready for use.gtdGlobalTableName- The global table name.gtdGlobalTableARN- The unique identifier of the global table.gtdCreationDateTime- The creation time of the global table.gtdReplicationGroup- The regions where the global table has replicas.
gtdGlobalTableStatus :: Lens' GlobalTableDescription (Maybe GlobalTableStatus) #
The current state of the global table: * CREATING - The global table is being created. * UPDATING - The global table is being updated. * DELETING - The global table is being deleted. * ACTIVE - The global table is ready for use.
gtdGlobalTableName :: Lens' GlobalTableDescription (Maybe Text) #
The global table name.
gtdGlobalTableARN :: Lens' GlobalTableDescription (Maybe Text) #
The unique identifier of the global table.
gtdCreationDateTime :: Lens' GlobalTableDescription (Maybe UTCTime) #
The creation time of the global table.
gtdReplicationGroup :: Lens' GlobalTableDescription [ReplicaDescription] #
The regions where the global table has replicas.
GlobalTableGlobalSecondaryIndexSettingsUpdate
data GlobalTableGlobalSecondaryIndexSettingsUpdate #
Represents the settings of a global secondary index for a global table that will be modified.
See: globalTableGlobalSecondaryIndexSettingsUpdate smart constructor.
Instances
globalTableGlobalSecondaryIndexSettingsUpdate #
Creates a value of GlobalTableGlobalSecondaryIndexSettingsUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtgsisuProvisionedWriteCapacityUnits- The maximum number of writes consumed per second before DynamoDB returns aThrottlingException.gtgsisuIndexName- The name of the global secondary index. The name must be unique among all other indexes on this table.
gtgsisuProvisionedWriteCapacityUnits :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe Natural) #
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
gtgsisuIndexName :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate Text #
The name of the global secondary index. The name must be unique among all other indexes on this table.
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
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
Arguments
| :: Text | |
| -> 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
Arguments
| :: NonEmpty (HashMap 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 theProjectionExpressionmust 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- This is a legacy parameter. UseProjectionExpressioninstead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide .kaaExpressionAttributeNames- One or more substitution tokens for attribute names in an expression. The following are some use cases for usingExpressionAttributeNames: * 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: *PercentileThe 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 forExpressionAttributeNames: *{"#P":Percentile}You could then use this substitution in an expression, as in this example: *#P = :valFor 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 totrue, 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)) #
This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide .
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
Arguments
| :: Text | |
| -> NonEmpty KeySchemaElement | |
| -> 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 keylsiProjection- Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
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
lsiProjection :: Lens' LocalSecondaryIndex Projection #
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
LocalSecondaryIndexDescription
data LocalSecondaryIndexDescription #
Represents the properties of a local secondary index.
See: localSecondaryIndexDescription smart constructor.
Instances
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 keylsidProjection- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.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
lsidProjection :: Lens' LocalSecondaryIndexDescription (Maybe Projection) #
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
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.
LocalSecondaryIndexInfo
data LocalSecondaryIndexInfo #
Represents the properties of a local secondary index for the table when the backup was created.
See: localSecondaryIndexInfo smart constructor.
Instances
localSecondaryIndexInfo :: LocalSecondaryIndexInfo #
Creates a value of LocalSecondaryIndexInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsiiKeySchema- The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types: *HASH- partition key *RANGE- sort keylsiiProjection- Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.lsiiIndexName- Represents the name of the local secondary index.
lsiiKeySchema :: Lens' LocalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement)) #
The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types: * HASH - partition key * RANGE - sort key
lsiiProjection :: Lens' LocalSecondaryIndexInfo (Maybe Projection) #
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
lsiiIndexName :: Lens' LocalSecondaryIndexInfo (Maybe Text) #
Represents the name of the local secondary index.
PointInTimeRecoveryDescription
data PointInTimeRecoveryDescription #
The description of the point in time settings applied to the table.
See: pointInTimeRecoveryDescription smart constructor.
Instances
pointInTimeRecoveryDescription :: PointInTimeRecoveryDescription #
Creates a value of PointInTimeRecoveryDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pitrdPointInTimeRecoveryStatus- The current state of point in time recovery: *ENABLING- Point in time recovery is being enabled. *ENABLED- Point in time recovery is enabled. *DISABLED- Point in time recovery is disabled.pitrdEarliestRestorableDateTime- Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.pitrdLatestRestorableDateTime-LatestRestorableDateTimeis typically 5 minutes before the current time.
pitrdPointInTimeRecoveryStatus :: Lens' PointInTimeRecoveryDescription (Maybe PointInTimeRecoveryStatus) #
The current state of point in time recovery: * ENABLING - Point in time recovery is being enabled. * ENABLED - Point in time recovery is enabled. * DISABLED - Point in time recovery is disabled.
pitrdEarliestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime) #
Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.
pitrdLatestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime) #
LatestRestorableDateTime is typically 5 minutes before the current time.
PointInTimeRecoverySpecification
data PointInTimeRecoverySpecification #
Represents the settings used to enable point in time recovery.
See: pointInTimeRecoverySpecification smart constructor.
Instances
pointInTimeRecoverySpecification #
Creates a value of PointInTimeRecoverySpecification with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pitrsPointInTimeRecoveryEnabled- Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
pitrsPointInTimeRecoveryEnabled :: Lens' PointInTimeRecoverySpecification Bool #
Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
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
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 inNonKeyAttributes. *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 ofNonKeyAttributessummed 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
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- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .ptWriteCapacityUnits- The maximum number of writes consumed per second before DynamoDB returns aThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .
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
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 aThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50ReadCapacityUnitsper second provides 100 eventually consistentReadCapacityUnitsper 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 aThrottlingException.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
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 byPutItem. 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.
Replica
Represents the properties of a replica.
See: replica smart constructor.
Instances
| Eq Replica # | |
| Data Replica # | |
Defined in Network.AWS.DynamoDB.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Replica -> c Replica # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Replica # toConstr :: Replica -> Constr # dataTypeOf :: Replica -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Replica) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Replica) # gmapT :: (forall b. Data b => b -> b) -> Replica -> Replica # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Replica -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Replica -> r # gmapQ :: (forall d. Data d => d -> u) -> Replica -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Replica -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Replica -> m Replica # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Replica -> m Replica # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Replica -> m Replica # | |
| Read Replica # | |
| Show Replica # | |
| Generic Replica # | |
| Hashable Replica # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| ToJSON Replica # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| FromJSON Replica # | |
| NFData Replica # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| type Rep Replica # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
Creates a value of Replica with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rRegionName- The region where the replica needs to be created.
ReplicaDescription
data ReplicaDescription #
Contains the details of the replica.
See: replicaDescription smart constructor.
Instances
replicaDescription :: ReplicaDescription #
Creates a value of ReplicaDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdRegionName- The name of the region.
rdRegionName :: Lens' ReplicaDescription (Maybe Text) #
The name of the region.
ReplicaGlobalSecondaryIndexSettingsDescription
data ReplicaGlobalSecondaryIndexSettingsDescription #
Represents the properties of a global secondary index.
See: replicaGlobalSecondaryIndexSettingsDescription smart constructor.
Instances
replicaGlobalSecondaryIndexSettingsDescription #
Creates a value of ReplicaGlobalSecondaryIndexSettingsDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rgsisdIndexStatus- The current status of the global secondary index: *CREATING- The global secondary index is being created. *UPDATING- The global secondary index is being updated. *DELETING- The global secondary index is being deleted. *ACTIVE- The global secondary index is ready for use.rgsisdProvisionedReadCapacityUnits- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException.rgsisdProvisionedWriteCapacityUnits- The maximum number of writes consumed per second before DynamoDB returns aThrottlingException.rgsisdIndexName- The name of the global secondary index. The name must be unique among all other indexes on this table.
rgsisdIndexStatus :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe IndexStatus) #
The current status of the global secondary index: * CREATING - The global secondary index is being created. * UPDATING - The global secondary index is being updated. * DELETING - The global secondary index is being deleted. * ACTIVE - The global secondary index is ready for use.
rgsisdProvisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural) #
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .
rgsisdProvisionedWriteCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural) #
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException .
rgsisdIndexName :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription Text #
The name of the global secondary index. The name must be unique among all other indexes on this table.
ReplicaGlobalSecondaryIndexSettingsUpdate
data ReplicaGlobalSecondaryIndexSettingsUpdate #
Represents the settings of a global secondary index for a global table that will be modified.
See: replicaGlobalSecondaryIndexSettingsUpdate smart constructor.
Instances
replicaGlobalSecondaryIndexSettingsUpdate #
Arguments
| :: Text | |
| -> ReplicaGlobalSecondaryIndexSettingsUpdate |
Creates a value of ReplicaGlobalSecondaryIndexSettingsUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rgsisuProvisionedReadCapacityUnits- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException.rgsisuIndexName- The name of the global secondary index. The name must be unique among all other indexes on this table.
rgsisuProvisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe Natural) #
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .
rgsisuIndexName :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate Text #
The name of the global secondary index. The name must be unique among all other indexes on this table.
ReplicaSettingsDescription
data ReplicaSettingsDescription #
Represents the properties of a replica.
See: replicaSettingsDescription smart constructor.
Instances
Arguments
| :: Text | |
| -> ReplicaSettingsDescription |
Creates a value of ReplicaSettingsDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsdReplicaStatus- The current state of the region: *CREATING- The region is being created. *UPDATING- The region is being updated. *DELETING- The region is being deleted. *ACTIVE- The region is ready for use.rsdReplicaProvisionedReadCapacityUnits- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .rsdReplicaProvisionedWriteCapacityUnits- The maximum number of writes consumed per second before DynamoDB returns aThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .rsdReplicaGlobalSecondaryIndexSettings- Replica global secondary index settings for the global table.rsdRegionName- The region name of the replica.
rsdReplicaStatus :: Lens' ReplicaSettingsDescription (Maybe ReplicaStatus) #
The current state of the region: * CREATING - The region is being created. * UPDATING - The region is being updated. * DELETING - The region is being deleted. * ACTIVE - The region is ready for use.
rsdReplicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe 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 .
rsdReplicaProvisionedWriteCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe 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 .
rsdReplicaGlobalSecondaryIndexSettings :: Lens' ReplicaSettingsDescription [ReplicaGlobalSecondaryIndexSettingsDescription] #
Replica global secondary index settings for the global table.
rsdRegionName :: Lens' ReplicaSettingsDescription Text #
The region name of the replica.
ReplicaSettingsUpdate
data ReplicaSettingsUpdate #
Represents the settings for a global table in a region that will be modified.
See: replicaSettingsUpdate smart constructor.
Instances
Arguments
| :: Text | |
| -> ReplicaSettingsUpdate |
Creates a value of ReplicaSettingsUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsuReplicaProvisionedReadCapacityUnits- The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide .rsuReplicaGlobalSecondaryIndexSettingsUpdate- Represents the settings of a global secondary index for a global table that will be modified.rsuRegionName- The region of the replica to be added.
rsuReplicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsUpdate (Maybe 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 .
rsuReplicaGlobalSecondaryIndexSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate)) #
Represents the settings of a global secondary index for a global table that will be modified.
rsuRegionName :: Lens' ReplicaSettingsUpdate Text #
The region of the replica to be added.
ReplicaUpdate
data ReplicaUpdate #
Represents one of the following:
- A new replica to be added to an existing global table.
- New parameters for an existing replica.
- An existing replica to be removed from an existing global table.
See: replicaUpdate smart constructor.
Instances
replicaUpdate :: ReplicaUpdate #
Creates a value of ReplicaUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ruCreate :: Lens' ReplicaUpdate (Maybe CreateReplicaAction) #
The parameters required for creating a replica on an existing global table.
ruDelete :: Lens' ReplicaUpdate (Maybe DeleteReplicaAction) #
The name of the existing replica to be removed.
RestoreSummary
data RestoreSummary #
Contains details for the restore.
See: restoreSummary smart constructor.
Instances
Arguments
| :: UTCTime | |
| -> Bool | |
| -> RestoreSummary |
Creates a value of RestoreSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsSourceTableARN- ARN of the source table of the backup that is being restored.rsSourceBackupARN- ARN of the backup from which the table was restored.rsRestoreDateTime- Point in time or source backup time.rsRestoreInProgress- Indicates if a restore is in progress or not.
rsSourceTableARN :: Lens' RestoreSummary (Maybe Text) #
ARN of the source table of the backup that is being restored.
rsSourceBackupARN :: Lens' RestoreSummary (Maybe Text) #
ARN of the backup from which the table was restored.
rsRestoreDateTime :: Lens' RestoreSummary UTCTime #
Point in time or source backup time.
rsRestoreInProgress :: Lens' RestoreSummary Bool #
Indicates if a restore is in progress or not.
SSEDescription
data SSEDescription #
The description of the server-side encryption status on the specified table.
See: sSEDescription smart constructor.
Instances
sSEDescription :: SSEDescription #
Creates a value of SSEDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssedStatus- The current state of server-side encryption: *ENABLING- Server-side encryption is being enabled. *ENABLED- Server-side encryption is enabled. *DISABLING- Server-side encryption is being disabled. *DISABLED- Server-side encryption is disabled.
ssedStatus :: Lens' SSEDescription (Maybe SSEStatus) #
The current state of server-side encryption: * ENABLING - Server-side encryption is being enabled. * ENABLED - Server-side encryption is enabled. * DISABLING - Server-side encryption is being disabled. * DISABLED - Server-side encryption is disabled.
SSESpecification
data SSESpecification #
Represents the settings used to enable server-side encryption.
See: sSESpecification smart constructor.
Instances
Arguments
| :: Bool | |
| -> SSESpecification |
Creates a value of SSESpecification with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssesEnabled- Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.
ssesEnabled :: Lens' SSESpecification Bool #
Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.
SourceTableDetails
data SourceTableDetails #
Contains the details of the table when the backup was created.
See: sourceTableDetails smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty KeySchemaElement | |
| -> UTCTime | |
| -> ProvisionedThroughput | |
| -> SourceTableDetails |
Creates a value of SourceTableDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stdTableSizeBytes- Size of the table in bytes. Please note this is an approximate value.stdTableARN- ARN of the table for which backup was created.stdItemCount- Number of items in the table. Please note this is an approximate value.stdTableName- The name of the table for which the backup was created.stdTableId- Unique identifier for the table for which the backup was created.stdKeySchema- Schema of the table.stdTableCreationDateTime- Time when the source table was created.stdProvisionedThroughput- Read IOPs and Write IOPS on the table when the backup was created.
stdTableSizeBytes :: Lens' SourceTableDetails (Maybe Integer) #
Size of the table in bytes. Please note this is an approximate value.
stdTableARN :: Lens' SourceTableDetails (Maybe Text) #
ARN of the table for which backup was created.
stdItemCount :: Lens' SourceTableDetails (Maybe Natural) #
Number of items in the table. Please note this is an approximate value.
stdTableName :: Lens' SourceTableDetails Text #
The name of the table for which the backup was created.
stdTableId :: Lens' SourceTableDetails Text #
Unique identifier for the table for which the backup was created.
stdKeySchema :: Lens' SourceTableDetails (NonEmpty KeySchemaElement) #
Schema of the table.
stdTableCreationDateTime :: Lens' SourceTableDetails UTCTime #
Time when the source table was created.
stdProvisionedThroughput :: Lens' SourceTableDetails ProvisionedThroughput #
Read IOPs and Write IOPS on the table when the backup was created.
SourceTableFeatureDetails
data SourceTableFeatureDetails #
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
See: sourceTableFeatureDetails smart constructor.
Instances
sourceTableFeatureDetails :: SourceTableFeatureDetails #
Creates a value of SourceTableFeatureDetails with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stfdStreamDescription- Stream settings on the table when the backup was created.stfdGlobalSecondaryIndexes- Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.stfdLocalSecondaryIndexes- Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.stfdSSEDescription- The description of the server-side encryption status on the table when the backup was created.stfdTimeToLiveDescription- Time to Live settings on the table when the backup was created.
stfdStreamDescription :: Lens' SourceTableFeatureDetails (Maybe StreamSpecification) #
Stream settings on the table when the backup was created.
stfdGlobalSecondaryIndexes :: Lens' SourceTableFeatureDetails [GlobalSecondaryIndexInfo] #
Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.
stfdLocalSecondaryIndexes :: Lens' SourceTableFeatureDetails [LocalSecondaryIndexInfo] #
Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
stfdSSEDescription :: Lens' SourceTableFeatureDetails (Maybe SSEDescription) #
The description of the server-side encryption status on the table when the backup was created.
stfdTimeToLiveDescription :: Lens' SourceTableFeatureDetails (Maybe TimeToLiveDescription) #
Time to Live settings on the table when the backup was created.
StreamSpecification
data StreamSpecification #
Represents the DynamoDB Streams configuration for a table in DynamoDB.
See: streamSpecification smart constructor.
Instances
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- When an item in the table is modified,StreamViewTypedetermines what information is written to the stream for this table. Valid values forStreamViewTypeare: *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) #
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
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:
tdRestoreSummary- Contains details for the restore.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 ofAttributeDefinitionobjects. Each of these objects describes one attribute in the table and index key schema. EachAttributeDefinitionobject 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. EachKeySchemaElementconsists 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 aCreateTableoperation.) *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 inNonKeyAttributes. *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 inNonKeyAttributes, 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 theDELETINGstate, no information about indexes will be returned.tdLatestStreamLabel- A timestamp, in ISO 8601 format, for this stream. Note thatLatestStreamLabelis 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. * theStreamLabel.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 inNonKeyAttributes. *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 inNonKeyAttributes, 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 theDELETINGstate, no information about indexes will be returned.tdCreationDateTime- The date and time when the table was created, in UNIX epoch time format.tdSSEDescription- The description of the server-side encryption status on the specified table.tdTableId- Unique identifier for the table for which the backup was created.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.
tdRestoreSummary :: Lens' TableDescription (Maybe RestoreSummary) #
Contains details for the restore.
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.
tdSSEDescription :: Lens' TableDescription (Maybe SSEDescription) #
The description of the server-side encryption status on the specified table.
tdTableId :: Lens' TableDescription (Maybe Text) #
Unique identifier for the table for which the backup was created.
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.
Tag
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide .
See: tag smart constructor.
Instances
| Eq Tag # | |
| Data Tag # | |
Defined in Network.AWS.DynamoDB.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Tag -> c Tag # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Tag # dataTypeOf :: Tag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Tag) # gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Tag -> r # gmapQ :: (forall d. Data d => d -> u) -> Tag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Tag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Tag -> m Tag # | |
| Read Tag # | |
| Show Tag # | |
| Generic Tag # | |
| Hashable Tag # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| ToJSON Tag # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| FromJSON Tag # | |
| NFData Tag # | |
Defined in Network.AWS.DynamoDB.Types.Product | |
| type Rep Tag # | |
Defined in Network.AWS.DynamoDB.Types.Product type Rep Tag = D1 (MetaData "Tag" "Network.AWS.DynamoDB.Types.Product" "amazonka-dynamodb-1.6.0-COMX9FqvIeW1LBbyPqhpUT" False) (C1 (MetaCons "Tag'" PrefixI True) (S1 (MetaSel (Just "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) | |
Creates a value of Tag with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagKey- The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.tagValue- The value of the tag. Tag values are case-sensitive and can be null.
The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
TimeToLiveDescription
data TimeToLiveDescription #
The description of the Time to Live (TTL) status on the specified table.
See: timeToLiveDescription smart constructor.
Instances
timeToLiveDescription :: TimeToLiveDescription #
Creates a value of TimeToLiveDescription with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ttldTimeToLiveStatus- The Time to Live status for the table.ttldAttributeName- The name of the Time to Live attribute for items in the table.
ttldTimeToLiveStatus :: Lens' TimeToLiveDescription (Maybe TimeToLiveStatus) #
The Time to Live status for the table.
ttldAttributeName :: Lens' TimeToLiveDescription (Maybe Text) #
The name of the Time to Live attribute for items in the table.
TimeToLiveSpecification
data TimeToLiveSpecification #
Represents the settings used to enable or disable Time to Live for the specified table.
See: timeToLiveSpecification smart constructor.
Instances
Arguments
| :: Bool | |
| -> Text | |
| -> TimeToLiveSpecification |
Creates a value of TimeToLiveSpecification with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ttlsEnabled- Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.ttlsAttributeName- The name of the Time to Live attribute used to store the expiration time for items in the table.
ttlsEnabled :: Lens' TimeToLiveSpecification Bool #
Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.
ttlsAttributeName :: Lens' TimeToLiveSpecification Text #
The name of the Time to Live attribute used to store the expiration time for items in the table.
UpdateGlobalSecondaryIndexAction
data UpdateGlobalSecondaryIndexAction #
Represents the new provisioned throughput settings to be applied to a global secondary index.
See: updateGlobalSecondaryIndexAction smart constructor.
Instances
updateGlobalSecondaryIndexAction #
Arguments
| :: Text | |
| -> 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- The name of the global secondary index to be updated.ugsiaProvisionedThroughput- Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
ugsiaIndexName :: Lens' UpdateGlobalSecondaryIndexAction Text #
The name of the global secondary index to be updated.
ugsiaProvisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput #
Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide .
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
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- A request to perform aDeleteItemoperation.wrPutRequest- A request to perform aPutItemoperation.
wrDeleteRequest :: Lens' WriteRequest (Maybe DeleteRequest) #
A request to perform a DeleteItem operation.
wrPutRequest :: Lens' WriteRequest (Maybe PutRequest) #
A request to perform a PutItem operation.