Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.DynamoDB
Contents
- Service Configuration
- Errors
- BackupInUseException
- BackupNotFoundException
- ConditionalCheckFailedException
- ContinuousBackupsUnavailableException
- DuplicateItemException
- ExportConflictException
- ExportNotFoundException
- GlobalTableAlreadyExistsException
- GlobalTableNotFoundException
- IdempotentParameterMismatchException
- ImportConflictException
- ImportNotFoundException
- IndexNotFoundException
- InternalServerError
- InvalidExportTimeException
- InvalidRestoreTimeException
- ItemCollectionSizeLimitExceededException
- LimitExceededException
- PointInTimeRecoveryUnavailableException
- ProvisionedThroughputExceededException
- ReplicaAlreadyExistsException
- ReplicaNotFoundException
- RequestLimitExceeded
- ResourceInUseException
- ResourceNotFoundException
- TableAlreadyExistsException
- TableInUseException
- TableNotFoundException
- TransactionCanceledException
- TransactionConflictException
- TransactionInProgressException
- Waiters
- Operations
- BatchExecuteStatement
- BatchGetItem
- BatchWriteItem
- CreateBackup
- CreateGlobalTable
- CreateTable
- DeleteBackup
- DeleteItem
- DeleteTable
- DescribeBackup
- DescribeContinuousBackups
- DescribeContributorInsights
- DescribeEndpoints
- DescribeExport
- DescribeGlobalTable
- DescribeGlobalTableSettings
- DescribeImport
- DescribeKinesisStreamingDestination
- DescribeLimits
- DescribeTable
- DescribeTableReplicaAutoScaling
- DescribeTimeToLive
- DisableKinesisStreamingDestination
- EnableKinesisStreamingDestination
- ExecuteStatement
- ExecuteTransaction
- ExportTableToPointInTime
- GetItem
- ImportTable
- ListBackups (Paginated)
- ListContributorInsights
- ListExports
- ListGlobalTables
- ListImports
- ListTables (Paginated)
- ListTagsOfResource (Paginated)
- PutItem
- Query (Paginated)
- RestoreTableFromBackup
- RestoreTableToPointInTime
- Scan (Paginated)
- TagResource
- TransactGetItems
- TransactWriteItems
- UntagResource
- UpdateContinuousBackups
- UpdateContributorInsights
- UpdateGlobalTable
- UpdateGlobalTableSettings
- UpdateItem
- UpdateTable
- UpdateTableReplicaAutoScaling
- UpdateTimeToLive
- Types
- Common
- AttributeAction
- BackupStatus
- BackupType
- BackupTypeFilter
- BatchStatementErrorCodeEnum
- BillingMode
- ComparisonOperator
- ConditionalOperator
- ContinuousBackupsStatus
- ContributorInsightsAction
- ContributorInsightsStatus
- DestinationStatus
- ExportFormat
- ExportStatus
- GlobalTableStatus
- ImportStatus
- IndexStatus
- InputCompressionType
- InputFormat
- KeyType
- PointInTimeRecoveryStatus
- ProjectionType
- ReplicaStatus
- ReturnConsumedCapacity
- ReturnItemCollectionMetrics
- ReturnValue
- ReturnValuesOnConditionCheckFailure
- S3SseAlgorithm
- SSEStatus
- SSEType
- ScalarAttributeType
- Select
- StreamViewType
- TableClass
- TableStatus
- TimeToLiveStatus
- ArchivalSummary
- AttributeDefinition
- AttributeValueUpdate
- AutoScalingPolicyDescription
- AutoScalingPolicyUpdate
- AutoScalingSettingsDescription
- AutoScalingSettingsUpdate
- AutoScalingTargetTrackingScalingPolicyConfigurationDescription
- AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
- BackupDescription
- BackupDetails
- BackupSummary
- BatchStatementError
- BatchStatementRequest
- BatchStatementResponse
- BillingModeSummary
- Capacity
- Condition
- ConditionCheck
- ConsumedCapacity
- ContinuousBackupsDescription
- ContributorInsightsSummary
- CreateGlobalSecondaryIndexAction
- CreateReplicaAction
- CreateReplicationGroupMemberAction
- CsvOptions
- Delete
- DeleteGlobalSecondaryIndexAction
- DeleteReplicaAction
- DeleteReplicationGroupMemberAction
- Endpoint
- ExpectedAttributeValue
- ExportDescription
- ExportSummary
- FailureException
- Get
- GlobalSecondaryIndex
- GlobalSecondaryIndexAutoScalingUpdate
- GlobalSecondaryIndexDescription
- GlobalSecondaryIndexInfo
- GlobalSecondaryIndexUpdate
- GlobalTable
- GlobalTableDescription
- GlobalTableGlobalSecondaryIndexSettingsUpdate
- ImportSummary
- ImportTableDescription
- InputFormatOptions
- ItemCollectionMetrics
- ItemResponse
- KeySchemaElement
- KeysAndAttributes
- KinesisDataStreamDestination
- KinesisStreamingDestinationInput
- KinesisStreamingDestinationOutput
- LocalSecondaryIndex
- LocalSecondaryIndexDescription
- LocalSecondaryIndexInfo
- ParameterizedStatement
- PointInTimeRecoveryDescription
- PointInTimeRecoverySpecification
- Projection
- ProvisionedThroughput
- ProvisionedThroughputDescription
- ProvisionedThroughputOverride
- Put
- Replica
- ReplicaAutoScalingDescription
- ReplicaAutoScalingUpdate
- ReplicaDescription
- ReplicaGlobalSecondaryIndex
- ReplicaGlobalSecondaryIndexAutoScalingDescription
- ReplicaGlobalSecondaryIndexAutoScalingUpdate
- ReplicaGlobalSecondaryIndexDescription
- ReplicaGlobalSecondaryIndexSettingsDescription
- ReplicaGlobalSecondaryIndexSettingsUpdate
- ReplicaSettingsDescription
- ReplicaSettingsUpdate
- ReplicaUpdate
- ReplicationGroupUpdate
- RestoreSummary
- S3BucketSource
- SSEDescription
- SSESpecification
- SourceTableDetails
- SourceTableFeatureDetails
- StreamSpecification
- TableAutoScalingDescription
- TableClassSummary
- TableCreationParameters
- TableDescription
- Tag
- TimeToLiveDescription
- TimeToLiveSpecification
- TransactGetItem
- TransactWriteItem
- Update
- UpdateGlobalSecondaryIndexAction
- UpdateReplicationGroupMemberAction
Description
Derived from API version 2012-08-10
of the AWS service descriptions, licensed under Apache 2.0.
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 Amazon Web Services 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 Amazon Web Services Region, providing built-in high availability and data durability.
Synopsis
- defaultService :: Service
- _BackupInUseException :: AsError a => Fold a ServiceError
- _BackupNotFoundException :: AsError a => Fold a ServiceError
- _ConditionalCheckFailedException :: AsError a => Fold a ServiceError
- _ContinuousBackupsUnavailableException :: AsError a => Fold a ServiceError
- _DuplicateItemException :: AsError a => Fold a ServiceError
- _ExportConflictException :: AsError a => Fold a ServiceError
- _ExportNotFoundException :: AsError a => Fold a ServiceError
- _GlobalTableAlreadyExistsException :: AsError a => Fold a ServiceError
- _GlobalTableNotFoundException :: AsError a => Fold a ServiceError
- _IdempotentParameterMismatchException :: AsError a => Fold a ServiceError
- _ImportConflictException :: AsError a => Fold a ServiceError
- _ImportNotFoundException :: AsError a => Fold a ServiceError
- _IndexNotFoundException :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- _InvalidExportTimeException :: AsError a => Fold a ServiceError
- _InvalidRestoreTimeException :: AsError a => Fold a ServiceError
- _ItemCollectionSizeLimitExceededException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _PointInTimeRecoveryUnavailableException :: AsError a => Fold a ServiceError
- _ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError
- _ReplicaAlreadyExistsException :: AsError a => Fold a ServiceError
- _ReplicaNotFoundException :: AsError a => Fold a ServiceError
- _RequestLimitExceeded :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TableAlreadyExistsException :: AsError a => Fold a ServiceError
- _TableInUseException :: AsError a => Fold a ServiceError
- _TableNotFoundException :: AsError a => Fold a ServiceError
- _TransactionCanceledException :: AsError a => Fold a ServiceError
- _TransactionConflictException :: AsError a => Fold a ServiceError
- _TransactionInProgressException :: AsError a => Fold a ServiceError
- newTableExists :: Wait DescribeTable
- newTableNotExists :: Wait DescribeTable
- data BatchExecuteStatement = BatchExecuteStatement' (Maybe ReturnConsumedCapacity) (NonEmpty BatchStatementRequest)
- newBatchExecuteStatement :: NonEmpty BatchStatementRequest -> BatchExecuteStatement
- data BatchExecuteStatementResponse = BatchExecuteStatementResponse' (Maybe [ConsumedCapacity]) (Maybe [BatchStatementResponse]) Int
- newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse
- data BatchGetItem = BatchGetItem' (Maybe ReturnConsumedCapacity) (HashMap Text KeysAndAttributes)
- newBatchGetItem :: BatchGetItem
- data BatchGetItemResponse = BatchGetItemResponse' (Maybe [ConsumedCapacity]) Int (HashMap Text [HashMap Text AttributeValue]) (HashMap Text KeysAndAttributes)
- newBatchGetItemResponse :: Int -> BatchGetItemResponse
- data BatchWriteItem = BatchWriteItem' (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (HashMap Text (NonEmpty WriteRequest))
- newBatchWriteItem :: BatchWriteItem
- data BatchWriteItemResponse = BatchWriteItemResponse' (Maybe [ConsumedCapacity]) (Maybe (HashMap Text [ItemCollectionMetrics])) Int (HashMap Text (NonEmpty WriteRequest))
- newBatchWriteItemResponse :: Int -> BatchWriteItemResponse
- data CreateBackup = CreateBackup' Text Text
- newCreateBackup :: Text -> Text -> CreateBackup
- data CreateBackupResponse = CreateBackupResponse' (Maybe BackupDetails) Int
- newCreateBackupResponse :: Int -> CreateBackupResponse
- data CreateGlobalTable = CreateGlobalTable' Text [Replica]
- newCreateGlobalTable :: Text -> CreateGlobalTable
- data CreateGlobalTableResponse = CreateGlobalTableResponse' (Maybe GlobalTableDescription) Int
- newCreateGlobalTableResponse :: Int -> CreateGlobalTableResponse
- data CreateTable = CreateTable' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe [LocalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe SSESpecification) (Maybe StreamSpecification) (Maybe TableClass) (Maybe [Tag]) [AttributeDefinition] Text (NonEmpty KeySchemaElement)
- newCreateTable :: Text -> NonEmpty KeySchemaElement -> CreateTable
- data CreateTableResponse = CreateTableResponse' (Maybe TableDescription) Int
- newCreateTableResponse :: Int -> CreateTableResponse
- data DeleteBackup = DeleteBackup' Text
- newDeleteBackup :: Text -> DeleteBackup
- data DeleteBackupResponse = DeleteBackupResponse' (Maybe BackupDescription) Int
- newDeleteBackupResponse :: Int -> DeleteBackupResponse
- data DeleteItem = DeleteItem' (Maybe Text) (Maybe ConditionalOperator) (Maybe (HashMap Text ExpectedAttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (Maybe ReturnValue) Text (HashMap Text AttributeValue)
- newDeleteItem :: Text -> DeleteItem
- data DeleteItemResponse = DeleteItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int
- newDeleteItemResponse :: Int -> DeleteItemResponse
- data DeleteTable = DeleteTable' Text
- newDeleteTable :: Text -> DeleteTable
- data DeleteTableResponse = DeleteTableResponse' (Maybe TableDescription) Int
- newDeleteTableResponse :: Int -> DeleteTableResponse
- data DescribeBackup = DescribeBackup' Text
- newDescribeBackup :: Text -> DescribeBackup
- data DescribeBackupResponse = DescribeBackupResponse' (Maybe BackupDescription) Int
- newDescribeBackupResponse :: Int -> DescribeBackupResponse
- data DescribeContinuousBackups = DescribeContinuousBackups' Text
- newDescribeContinuousBackups :: Text -> DescribeContinuousBackups
- data DescribeContinuousBackupsResponse = DescribeContinuousBackupsResponse' (Maybe ContinuousBackupsDescription) Int
- newDescribeContinuousBackupsResponse :: Int -> DescribeContinuousBackupsResponse
- data DescribeContributorInsights = DescribeContributorInsights' (Maybe Text) Text
- newDescribeContributorInsights :: Text -> DescribeContributorInsights
- data DescribeContributorInsightsResponse = DescribeContributorInsightsResponse' (Maybe [Text]) (Maybe ContributorInsightsStatus) (Maybe FailureException) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newDescribeContributorInsightsResponse :: Int -> DescribeContributorInsightsResponse
- data DescribeEndpoints = DescribeEndpoints' {
- newDescribeEndpoints :: DescribeEndpoints
- data DescribeEndpointsResponse = DescribeEndpointsResponse' Int [Endpoint]
- newDescribeEndpointsResponse :: Int -> DescribeEndpointsResponse
- data DescribeExport = DescribeExport' Text
- newDescribeExport :: Text -> DescribeExport
- data DescribeExportResponse = DescribeExportResponse' (Maybe ExportDescription) Int
- newDescribeExportResponse :: Int -> DescribeExportResponse
- data DescribeGlobalTable = DescribeGlobalTable' Text
- newDescribeGlobalTable :: Text -> DescribeGlobalTable
- data DescribeGlobalTableResponse = DescribeGlobalTableResponse' (Maybe GlobalTableDescription) Int
- newDescribeGlobalTableResponse :: Int -> DescribeGlobalTableResponse
- data DescribeGlobalTableSettings = DescribeGlobalTableSettings' Text
- newDescribeGlobalTableSettings :: Text -> DescribeGlobalTableSettings
- data DescribeGlobalTableSettingsResponse = DescribeGlobalTableSettingsResponse' (Maybe Text) (Maybe [ReplicaSettingsDescription]) Int
- newDescribeGlobalTableSettingsResponse :: Int -> DescribeGlobalTableSettingsResponse
- data DescribeImport = DescribeImport' Text
- newDescribeImport :: Text -> DescribeImport
- data DescribeImportResponse = DescribeImportResponse' Int ImportTableDescription
- newDescribeImportResponse :: Int -> ImportTableDescription -> DescribeImportResponse
- data DescribeKinesisStreamingDestination = DescribeKinesisStreamingDestination' Text
- newDescribeKinesisStreamingDestination :: Text -> DescribeKinesisStreamingDestination
- data DescribeKinesisStreamingDestinationResponse = DescribeKinesisStreamingDestinationResponse' (Maybe [KinesisDataStreamDestination]) (Maybe Text) Int
- newDescribeKinesisStreamingDestinationResponse :: Int -> DescribeKinesisStreamingDestinationResponse
- data DescribeLimits = DescribeLimits' {
- newDescribeLimits :: DescribeLimits
- data DescribeLimitsResponse = DescribeLimitsResponse' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) Int
- newDescribeLimitsResponse :: Int -> DescribeLimitsResponse
- data DescribeTable = DescribeTable' Text
- newDescribeTable :: Text -> DescribeTable
- data DescribeTableResponse = DescribeTableResponse' (Maybe TableDescription) Int
- newDescribeTableResponse :: Int -> DescribeTableResponse
- data DescribeTableReplicaAutoScaling = DescribeTableReplicaAutoScaling' Text
- newDescribeTableReplicaAutoScaling :: Text -> DescribeTableReplicaAutoScaling
- data DescribeTableReplicaAutoScalingResponse = DescribeTableReplicaAutoScalingResponse' (Maybe TableAutoScalingDescription) Int
- newDescribeTableReplicaAutoScalingResponse :: Int -> DescribeTableReplicaAutoScalingResponse
- data DescribeTimeToLive = DescribeTimeToLive' Text
- newDescribeTimeToLive :: Text -> DescribeTimeToLive
- data DescribeTimeToLiveResponse = DescribeTimeToLiveResponse' (Maybe TimeToLiveDescription) Int
- newDescribeTimeToLiveResponse :: Int -> DescribeTimeToLiveResponse
- data DisableKinesisStreamingDestination = DisableKinesisStreamingDestination' Text Text
- newDisableKinesisStreamingDestination :: Text -> Text -> DisableKinesisStreamingDestination
- data KinesisStreamingDestinationOutput = KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text)
- newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput
- data EnableKinesisStreamingDestination = EnableKinesisStreamingDestination' Text Text
- newEnableKinesisStreamingDestination :: Text -> Text -> EnableKinesisStreamingDestination
- data KinesisStreamingDestinationOutput = KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text)
- newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput
- data ExecuteStatement = ExecuteStatement' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe (NonEmpty AttributeValue)) (Maybe ReturnConsumedCapacity) Text
- newExecuteStatement :: Text -> ExecuteStatement
- data ExecuteStatementResponse = ExecuteStatementResponse' (Maybe ConsumedCapacity) (Maybe [HashMap Text AttributeValue]) (Maybe (HashMap Text AttributeValue)) (Maybe Text) Int
- newExecuteStatementResponse :: Int -> ExecuteStatementResponse
- data ExecuteTransaction = ExecuteTransaction' (Maybe Text) (Maybe ReturnConsumedCapacity) (NonEmpty ParameterizedStatement)
- newExecuteTransaction :: NonEmpty ParameterizedStatement -> ExecuteTransaction
- data ExecuteTransactionResponse = ExecuteTransactionResponse' (Maybe [ConsumedCapacity]) (Maybe (NonEmpty ItemResponse)) Int
- newExecuteTransactionResponse :: Int -> ExecuteTransactionResponse
- data ExportTableToPointInTime = ExportTableToPointInTime' (Maybe Text) (Maybe ExportFormat) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3SseAlgorithm) (Maybe Text) Text Text
- newExportTableToPointInTime :: Text -> Text -> ExportTableToPointInTime
- data ExportTableToPointInTimeResponse = ExportTableToPointInTimeResponse' (Maybe ExportDescription) Int
- newExportTableToPointInTimeResponse :: Int -> ExportTableToPointInTimeResponse
- data GetItem = GetItem' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe ReturnConsumedCapacity) Text (HashMap Text AttributeValue)
- newGetItem :: Text -> GetItem
- data GetItemResponse = GetItemResponse' (Maybe ConsumedCapacity) (Maybe (HashMap Text AttributeValue)) Int
- newGetItemResponse :: Int -> GetItemResponse
- data ImportTable = ImportTable' (Maybe Text) (Maybe InputCompressionType) (Maybe InputFormatOptions) S3BucketSource InputFormat TableCreationParameters
- newImportTable :: S3BucketSource -> InputFormat -> TableCreationParameters -> ImportTable
- data ImportTableResponse = ImportTableResponse' Int ImportTableDescription
- newImportTableResponse :: Int -> ImportTableDescription -> ImportTableResponse
- data ListBackups = ListBackups' (Maybe BackupTypeFilter) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newListBackups :: ListBackups
- data ListBackupsResponse = ListBackupsResponse' (Maybe [BackupSummary]) (Maybe Text) Int
- newListBackupsResponse :: Int -> ListBackupsResponse
- data ListContributorInsights = ListContributorInsights' (Maybe Int) (Maybe Text) (Maybe Text)
- newListContributorInsights :: ListContributorInsights
- data ListContributorInsightsResponse = ListContributorInsightsResponse' (Maybe [ContributorInsightsSummary]) (Maybe Text) Int
- newListContributorInsightsResponse :: Int -> ListContributorInsightsResponse
- data ListExports = ListExports' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListExports :: ListExports
- data ListExportsResponse = ListExportsResponse' (Maybe [ExportSummary]) (Maybe Text) Int
- newListExportsResponse :: Int -> ListExportsResponse
- data ListGlobalTables = ListGlobalTables' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListGlobalTables :: ListGlobalTables
- data ListGlobalTablesResponse = ListGlobalTablesResponse' (Maybe [GlobalTable]) (Maybe Text) Int
- newListGlobalTablesResponse :: Int -> ListGlobalTablesResponse
- data ListImports = ListImports' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListImports :: ListImports
- data ListImportsResponse = ListImportsResponse' (Maybe [ImportSummary]) (Maybe Text) Int
- newListImportsResponse :: Int -> ListImportsResponse
- data ListTables = ListTables' (Maybe Text) (Maybe Natural)
- newListTables :: ListTables
- data ListTablesResponse = ListTablesResponse' (Maybe Text) (Maybe [Text]) Int
- newListTablesResponse :: Int -> ListTablesResponse
- data ListTagsOfResource = ListTagsOfResource' (Maybe Text) Text
- newListTagsOfResource :: Text -> ListTagsOfResource
- data ListTagsOfResourceResponse = ListTagsOfResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsOfResourceResponse :: Int -> ListTagsOfResourceResponse
- data PutItem = PutItem' (Maybe Text) (Maybe ConditionalOperator) (Maybe (HashMap Text ExpectedAttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (Maybe ReturnValue) Text (HashMap Text AttributeValue)
- newPutItem :: Text -> PutItem
- data PutItemResponse = PutItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int
- newPutItemResponse :: Int -> PutItemResponse
- data Query = Query' (Maybe (NonEmpty Text)) (Maybe ConditionalOperator) (Maybe Bool) (Maybe (HashMap Text AttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Condition)) (Maybe Natural) (Maybe Text) (Maybe (HashMap Text Condition)) (Maybe ReturnConsumedCapacity) (Maybe Bool) (Maybe Select) Text
- newQuery :: Text -> Query
- data QueryResponse = QueryResponse' (Maybe ConsumedCapacity) (Maybe Int) (Maybe (HashMap Text AttributeValue)) (Maybe Int) Int [HashMap Text AttributeValue]
- newQueryResponse :: Int -> QueryResponse
- data RestoreTableFromBackup = RestoreTableFromBackup' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe [LocalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe SSESpecification) Text Text
- newRestoreTableFromBackup :: Text -> Text -> RestoreTableFromBackup
- data RestoreTableFromBackupResponse = RestoreTableFromBackupResponse' (Maybe TableDescription) Int
- newRestoreTableFromBackupResponse :: Int -> RestoreTableFromBackupResponse
- data RestoreTableToPointInTime = RestoreTableToPointInTime' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe [LocalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe POSIX) (Maybe SSESpecification) (Maybe Text) (Maybe Text) (Maybe Bool) Text
- newRestoreTableToPointInTime :: Text -> RestoreTableToPointInTime
- data RestoreTableToPointInTimeResponse = RestoreTableToPointInTimeResponse' (Maybe TableDescription) Int
- newRestoreTableToPointInTimeResponse :: Int -> RestoreTableToPointInTimeResponse
- data Scan = Scan' (Maybe (NonEmpty Text)) (Maybe ConditionalOperator) (Maybe Bool) (Maybe (HashMap Text AttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ReturnConsumedCapacity) (Maybe (HashMap Text Condition)) (Maybe Natural) (Maybe Select) (Maybe Natural) Text
- newScan :: Text -> Scan
- data ScanResponse = ScanResponse' (Maybe ConsumedCapacity) (Maybe Int) (Maybe [HashMap Text AttributeValue]) (Maybe (HashMap Text AttributeValue)) (Maybe Int) Int
- newScanResponse :: Int -> ScanResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data TransactGetItems = TransactGetItems' (Maybe ReturnConsumedCapacity) (NonEmpty TransactGetItem)
- newTransactGetItems :: NonEmpty TransactGetItem -> TransactGetItems
- data TransactGetItemsResponse = TransactGetItemsResponse' (Maybe [ConsumedCapacity]) (Maybe (NonEmpty ItemResponse)) Int
- newTransactGetItemsResponse :: Int -> TransactGetItemsResponse
- data TransactWriteItems = TransactWriteItems' (Maybe Text) (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (NonEmpty TransactWriteItem)
- newTransactWriteItems :: NonEmpty TransactWriteItem -> TransactWriteItems
- data TransactWriteItemsResponse = TransactWriteItemsResponse' (Maybe [ConsumedCapacity]) (Maybe (HashMap Text [ItemCollectionMetrics])) Int
- newTransactWriteItemsResponse :: Int -> TransactWriteItemsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateContinuousBackups = UpdateContinuousBackups' Text PointInTimeRecoverySpecification
- newUpdateContinuousBackups :: Text -> PointInTimeRecoverySpecification -> UpdateContinuousBackups
- data UpdateContinuousBackupsResponse = UpdateContinuousBackupsResponse' (Maybe ContinuousBackupsDescription) Int
- newUpdateContinuousBackupsResponse :: Int -> UpdateContinuousBackupsResponse
- data UpdateContributorInsights = UpdateContributorInsights' (Maybe Text) Text ContributorInsightsAction
- newUpdateContributorInsights :: Text -> ContributorInsightsAction -> UpdateContributorInsights
- data UpdateContributorInsightsResponse = UpdateContributorInsightsResponse' (Maybe ContributorInsightsStatus) (Maybe Text) (Maybe Text) Int
- newUpdateContributorInsightsResponse :: Int -> UpdateContributorInsightsResponse
- data UpdateGlobalTable = UpdateGlobalTable' Text [ReplicaUpdate]
- newUpdateGlobalTable :: Text -> UpdateGlobalTable
- data UpdateGlobalTableResponse = UpdateGlobalTableResponse' (Maybe GlobalTableDescription) Int
- newUpdateGlobalTableResponse :: Int -> UpdateGlobalTableResponse
- data UpdateGlobalTableSettings = UpdateGlobalTableSettings' (Maybe BillingMode) (Maybe (NonEmpty GlobalTableGlobalSecondaryIndexSettingsUpdate)) (Maybe AutoScalingSettingsUpdate) (Maybe Natural) (Maybe (NonEmpty ReplicaSettingsUpdate)) Text
- newUpdateGlobalTableSettings :: Text -> UpdateGlobalTableSettings
- data UpdateGlobalTableSettingsResponse = UpdateGlobalTableSettingsResponse' (Maybe Text) (Maybe [ReplicaSettingsDescription]) Int
- newUpdateGlobalTableSettingsResponse :: Int -> UpdateGlobalTableSettingsResponse
- data UpdateItem = UpdateItem' (Maybe (HashMap Text AttributeValueUpdate)) (Maybe Text) (Maybe ConditionalOperator) (Maybe (HashMap Text ExpectedAttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (Maybe ReturnValue) (Maybe Text) Text (HashMap Text AttributeValue)
- newUpdateItem :: Text -> UpdateItem
- data UpdateItemResponse = UpdateItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int
- newUpdateItemResponse :: Int -> UpdateItemResponse
- data UpdateTable = UpdateTable' (Maybe [AttributeDefinition]) (Maybe BillingMode) (Maybe [GlobalSecondaryIndexUpdate]) (Maybe ProvisionedThroughput) (Maybe (NonEmpty ReplicationGroupUpdate)) (Maybe SSESpecification) (Maybe StreamSpecification) (Maybe TableClass) Text
- newUpdateTable :: Text -> UpdateTable
- data UpdateTableResponse = UpdateTableResponse' (Maybe TableDescription) Int
- newUpdateTableResponse :: Int -> UpdateTableResponse
- data UpdateTableReplicaAutoScaling = UpdateTableReplicaAutoScaling' (Maybe (NonEmpty GlobalSecondaryIndexAutoScalingUpdate)) (Maybe AutoScalingSettingsUpdate) (Maybe (NonEmpty ReplicaAutoScalingUpdate)) Text
- newUpdateTableReplicaAutoScaling :: Text -> UpdateTableReplicaAutoScaling
- data UpdateTableReplicaAutoScalingResponse = UpdateTableReplicaAutoScalingResponse' (Maybe TableAutoScalingDescription) Int
- newUpdateTableReplicaAutoScalingResponse :: Int -> UpdateTableReplicaAutoScalingResponse
- data UpdateTimeToLive = UpdateTimeToLive' Text TimeToLiveSpecification
- newUpdateTimeToLive :: Text -> TimeToLiveSpecification -> UpdateTimeToLive
- data UpdateTimeToLiveResponse = UpdateTimeToLiveResponse' (Maybe TimeToLiveSpecification) Int
- newUpdateTimeToLiveResponse :: Int -> UpdateTimeToLiveResponse
- module Amazonka.DynamoDB.Types.AttributeValue
- module Amazonka.DynamoDB.Types.WriteRequest
- newtype AttributeAction where
- AttributeAction' { }
- pattern AttributeAction_ADD :: AttributeAction
- pattern AttributeAction_DELETE :: AttributeAction
- pattern AttributeAction_PUT :: AttributeAction
- newtype BackupStatus where
- BackupStatus' { }
- pattern BackupStatus_AVAILABLE :: BackupStatus
- pattern BackupStatus_CREATING :: BackupStatus
- pattern BackupStatus_DELETED :: BackupStatus
- newtype BackupType where
- BackupType' { }
- pattern BackupType_AWS_BACKUP :: BackupType
- pattern BackupType_SYSTEM :: BackupType
- pattern BackupType_USER :: BackupType
- newtype BackupTypeFilter where
- BackupTypeFilter' { }
- pattern BackupTypeFilter_ALL :: BackupTypeFilter
- pattern BackupTypeFilter_AWS_BACKUP :: BackupTypeFilter
- pattern BackupTypeFilter_SYSTEM :: BackupTypeFilter
- pattern BackupTypeFilter_USER :: BackupTypeFilter
- newtype BatchStatementErrorCodeEnum where
- BatchStatementErrorCodeEnum' { }
- pattern BatchStatementErrorCodeEnum_AccessDenied :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ConditionalCheckFailed :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_DuplicateItem :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_InternalServerError :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ItemCollectionSizeLimitExceeded :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ProvisionedThroughputExceeded :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_RequestLimitExceeded :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ResourceNotFound :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ThrottlingError :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_TransactionConflict :: BatchStatementErrorCodeEnum
- pattern BatchStatementErrorCodeEnum_ValidationError :: BatchStatementErrorCodeEnum
- newtype BillingMode where
- BillingMode' { }
- pattern BillingMode_PAY_PER_REQUEST :: BillingMode
- pattern BillingMode_PROVISIONED :: BillingMode
- newtype ComparisonOperator where
- ComparisonOperator' { }
- pattern ComparisonOperator_BEGINS_WITH :: ComparisonOperator
- pattern ComparisonOperator_BETWEEN :: ComparisonOperator
- pattern ComparisonOperator_CONTAINS :: ComparisonOperator
- pattern ComparisonOperator_EQ :: ComparisonOperator
- pattern ComparisonOperator_GE :: ComparisonOperator
- pattern ComparisonOperator_GT :: ComparisonOperator
- pattern ComparisonOperator_IN :: ComparisonOperator
- pattern ComparisonOperator_LE :: ComparisonOperator
- pattern ComparisonOperator_LT :: ComparisonOperator
- pattern ComparisonOperator_NE :: ComparisonOperator
- pattern ComparisonOperator_NOT_CONTAINS :: ComparisonOperator
- pattern ComparisonOperator_NOT_NULL :: ComparisonOperator
- pattern ComparisonOperator_NULL :: ComparisonOperator
- newtype ConditionalOperator where
- ConditionalOperator' { }
- pattern ConditionalOperator_AND :: ConditionalOperator
- pattern ConditionalOperator_OR :: ConditionalOperator
- newtype ContinuousBackupsStatus where
- newtype ContributorInsightsAction where
- newtype ContributorInsightsStatus where
- ContributorInsightsStatus' { }
- pattern ContributorInsightsStatus_DISABLED :: ContributorInsightsStatus
- pattern ContributorInsightsStatus_DISABLING :: ContributorInsightsStatus
- pattern ContributorInsightsStatus_ENABLED :: ContributorInsightsStatus
- pattern ContributorInsightsStatus_ENABLING :: ContributorInsightsStatus
- pattern ContributorInsightsStatus_FAILED :: ContributorInsightsStatus
- newtype DestinationStatus where
- DestinationStatus' { }
- pattern DestinationStatus_ACTIVE :: DestinationStatus
- pattern DestinationStatus_DISABLED :: DestinationStatus
- pattern DestinationStatus_DISABLING :: DestinationStatus
- pattern DestinationStatus_ENABLE_FAILED :: DestinationStatus
- pattern DestinationStatus_ENABLING :: DestinationStatus
- newtype ExportFormat where
- ExportFormat' { }
- pattern ExportFormat_DYNAMODB_JSON :: ExportFormat
- pattern ExportFormat_ION :: ExportFormat
- newtype ExportStatus where
- ExportStatus' { }
- pattern ExportStatus_COMPLETED :: ExportStatus
- pattern ExportStatus_FAILED :: ExportStatus
- pattern ExportStatus_IN_PROGRESS :: ExportStatus
- newtype GlobalTableStatus where
- GlobalTableStatus' { }
- pattern GlobalTableStatus_ACTIVE :: GlobalTableStatus
- pattern GlobalTableStatus_CREATING :: GlobalTableStatus
- pattern GlobalTableStatus_DELETING :: GlobalTableStatus
- pattern GlobalTableStatus_UPDATING :: GlobalTableStatus
- newtype ImportStatus where
- ImportStatus' { }
- pattern ImportStatus_CANCELLED :: ImportStatus
- pattern ImportStatus_CANCELLING :: ImportStatus
- pattern ImportStatus_COMPLETED :: ImportStatus
- pattern ImportStatus_FAILED :: ImportStatus
- pattern ImportStatus_IN_PROGRESS :: ImportStatus
- newtype IndexStatus where
- IndexStatus' { }
- pattern IndexStatus_ACTIVE :: IndexStatus
- pattern IndexStatus_CREATING :: IndexStatus
- pattern IndexStatus_DELETING :: IndexStatus
- pattern IndexStatus_UPDATING :: IndexStatus
- newtype InputCompressionType where
- newtype InputFormat where
- InputFormat' { }
- pattern InputFormat_CSV :: InputFormat
- pattern InputFormat_DYNAMODB_JSON :: InputFormat
- pattern InputFormat_ION :: InputFormat
- newtype KeyType where
- KeyType' {
- fromKeyType :: Text
- pattern KeyType_HASH :: KeyType
- pattern KeyType_RANGE :: KeyType
- KeyType' {
- newtype PointInTimeRecoveryStatus where
- newtype ProjectionType where
- ProjectionType' { }
- pattern ProjectionType_ALL :: ProjectionType
- pattern ProjectionType_INCLUDE :: ProjectionType
- pattern ProjectionType_KEYS_ONLY :: ProjectionType
- newtype ReplicaStatus where
- ReplicaStatus' { }
- pattern ReplicaStatus_ACTIVE :: ReplicaStatus
- pattern ReplicaStatus_CREATING :: ReplicaStatus
- pattern ReplicaStatus_CREATION_FAILED :: ReplicaStatus
- pattern ReplicaStatus_DELETING :: ReplicaStatus
- pattern ReplicaStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: ReplicaStatus
- pattern ReplicaStatus_REGION_DISABLED :: ReplicaStatus
- pattern ReplicaStatus_UPDATING :: ReplicaStatus
- newtype ReturnConsumedCapacity where
- newtype ReturnItemCollectionMetrics where
- newtype ReturnValue where
- ReturnValue' { }
- pattern ReturnValue_ALL_NEW :: ReturnValue
- pattern ReturnValue_ALL_OLD :: ReturnValue
- pattern ReturnValue_NONE :: ReturnValue
- pattern ReturnValue_UPDATED_NEW :: ReturnValue
- pattern ReturnValue_UPDATED_OLD :: ReturnValue
- newtype ReturnValuesOnConditionCheckFailure where
- newtype S3SseAlgorithm where
- S3SseAlgorithm' { }
- pattern S3SseAlgorithm_AES256 :: S3SseAlgorithm
- pattern S3SseAlgorithm_KMS :: S3SseAlgorithm
- newtype SSEStatus where
- SSEStatus' { }
- pattern SSEStatus_DISABLED :: SSEStatus
- pattern SSEStatus_DISABLING :: SSEStatus
- pattern SSEStatus_ENABLED :: SSEStatus
- pattern SSEStatus_ENABLING :: SSEStatus
- pattern SSEStatus_UPDATING :: SSEStatus
- newtype SSEType where
- SSEType' {
- fromSSEType :: Text
- pattern SSEType_AES256 :: SSEType
- pattern SSEType_KMS :: SSEType
- SSEType' {
- newtype ScalarAttributeType where
- ScalarAttributeType' { }
- pattern ScalarAttributeType_B :: ScalarAttributeType
- pattern ScalarAttributeType_N :: ScalarAttributeType
- pattern ScalarAttributeType_S :: ScalarAttributeType
- newtype Select where
- Select' {
- fromSelect :: Text
- pattern Select_ALL_ATTRIBUTES :: Select
- pattern Select_ALL_PROJECTED_ATTRIBUTES :: Select
- pattern Select_COUNT :: Select
- pattern Select_SPECIFIC_ATTRIBUTES :: Select
- Select' {
- newtype StreamViewType where
- StreamViewType' { }
- pattern StreamViewType_KEYS_ONLY :: StreamViewType
- pattern StreamViewType_NEW_AND_OLD_IMAGES :: StreamViewType
- pattern StreamViewType_NEW_IMAGE :: StreamViewType
- pattern StreamViewType_OLD_IMAGE :: StreamViewType
- newtype TableClass where
- TableClass' { }
- pattern TableClass_STANDARD :: TableClass
- pattern TableClass_STANDARD_INFREQUENT_ACCESS :: TableClass
- newtype TableStatus where
- TableStatus' { }
- pattern TableStatus_ACTIVE :: TableStatus
- pattern TableStatus_ARCHIVED :: TableStatus
- pattern TableStatus_ARCHIVING :: TableStatus
- pattern TableStatus_CREATING :: TableStatus
- pattern TableStatus_DELETING :: TableStatus
- pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus
- pattern TableStatus_UPDATING :: TableStatus
- newtype TimeToLiveStatus where
- TimeToLiveStatus' { }
- pattern TimeToLiveStatus_DISABLED :: TimeToLiveStatus
- pattern TimeToLiveStatus_DISABLING :: TimeToLiveStatus
- pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus
- pattern TimeToLiveStatus_ENABLING :: TimeToLiveStatus
- data ArchivalSummary = ArchivalSummary' (Maybe Text) (Maybe POSIX) (Maybe Text)
- newArchivalSummary :: ArchivalSummary
- data AttributeDefinition = AttributeDefinition' Text ScalarAttributeType
- newAttributeDefinition :: Text -> ScalarAttributeType -> AttributeDefinition
- data AttributeValueUpdate = AttributeValueUpdate' (Maybe AttributeAction) (Maybe AttributeValue)
- newAttributeValueUpdate :: AttributeValueUpdate
- data AutoScalingPolicyDescription = AutoScalingPolicyDescription' (Maybe Text) (Maybe AutoScalingTargetTrackingScalingPolicyConfigurationDescription)
- newAutoScalingPolicyDescription :: AutoScalingPolicyDescription
- data AutoScalingPolicyUpdate = AutoScalingPolicyUpdate' (Maybe Text) AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
- newAutoScalingPolicyUpdate :: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate -> AutoScalingPolicyUpdate
- data AutoScalingSettingsDescription = AutoScalingSettingsDescription' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe [AutoScalingPolicyDescription])
- newAutoScalingSettingsDescription :: AutoScalingSettingsDescription
- data AutoScalingSettingsUpdate = AutoScalingSettingsUpdate' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe AutoScalingPolicyUpdate)
- newAutoScalingSettingsUpdate :: AutoScalingSettingsUpdate
- data AutoScalingTargetTrackingScalingPolicyConfigurationDescription = AutoScalingTargetTrackingScalingPolicyConfigurationDescription' (Maybe Bool) (Maybe Int) (Maybe Int) Double
- newAutoScalingTargetTrackingScalingPolicyConfigurationDescription :: Double -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
- data AutoScalingTargetTrackingScalingPolicyConfigurationUpdate = AutoScalingTargetTrackingScalingPolicyConfigurationUpdate' (Maybe Bool) (Maybe Int) (Maybe Int) Double
- newAutoScalingTargetTrackingScalingPolicyConfigurationUpdate :: Double -> AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
- data BackupDescription = BackupDescription' (Maybe BackupDetails) (Maybe SourceTableDetails) (Maybe SourceTableFeatureDetails)
- newBackupDescription :: BackupDescription
- data BackupDetails = BackupDetails' (Maybe POSIX) (Maybe Natural) Text Text BackupStatus BackupType POSIX
- newBackupDetails :: Text -> Text -> BackupStatus -> BackupType -> UTCTime -> BackupDetails
- data BackupSummary = BackupSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe BackupStatus) (Maybe BackupType) (Maybe Text) (Maybe Text) (Maybe Text)
- newBackupSummary :: BackupSummary
- data BatchStatementError = BatchStatementError' (Maybe BatchStatementErrorCodeEnum) (Maybe Text)
- newBatchStatementError :: BatchStatementError
- data BatchStatementRequest = BatchStatementRequest' (Maybe Bool) (Maybe (NonEmpty AttributeValue)) Text
- newBatchStatementRequest :: Text -> BatchStatementRequest
- data BatchStatementResponse = BatchStatementResponse' (Maybe BatchStatementError) (Maybe (HashMap Text AttributeValue)) (Maybe Text)
- newBatchStatementResponse :: BatchStatementResponse
- data BillingModeSummary = BillingModeSummary' (Maybe BillingMode) (Maybe POSIX)
- newBillingModeSummary :: BillingModeSummary
- data Capacity = Capacity' (Maybe Double) (Maybe Double) (Maybe Double)
- newCapacity :: Capacity
- data Condition = Condition' (Maybe [AttributeValue]) ComparisonOperator
- newCondition :: ComparisonOperator -> Condition
- data ConditionCheck = ConditionCheck' (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text Text
- newConditionCheck :: Text -> Text -> ConditionCheck
- data ConsumedCapacity = ConsumedCapacity' (Maybe Double) (Maybe (HashMap Text Capacity)) (Maybe (HashMap Text Capacity)) (Maybe Double) (Maybe Capacity) (Maybe Text) (Maybe Double)
- newConsumedCapacity :: ConsumedCapacity
- data ContinuousBackupsDescription = ContinuousBackupsDescription' (Maybe PointInTimeRecoveryDescription) ContinuousBackupsStatus
- newContinuousBackupsDescription :: ContinuousBackupsStatus -> ContinuousBackupsDescription
- data ContributorInsightsSummary = ContributorInsightsSummary' (Maybe ContributorInsightsStatus) (Maybe Text) (Maybe Text)
- newContributorInsightsSummary :: ContributorInsightsSummary
- data CreateGlobalSecondaryIndexAction = CreateGlobalSecondaryIndexAction' (Maybe ProvisionedThroughput) Text (NonEmpty KeySchemaElement) Projection
- newCreateGlobalSecondaryIndexAction :: Text -> NonEmpty KeySchemaElement -> Projection -> CreateGlobalSecondaryIndexAction
- data CreateReplicaAction = CreateReplicaAction' Text
- newCreateReplicaAction :: Text -> CreateReplicaAction
- data CreateReplicationGroupMemberAction = CreateReplicationGroupMemberAction' (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) (Maybe Text) (Maybe ProvisionedThroughputOverride) (Maybe TableClass) Text
- newCreateReplicationGroupMemberAction :: Text -> CreateReplicationGroupMemberAction
- data CsvOptions = CsvOptions' (Maybe Text) (Maybe (NonEmpty Text))
- newCsvOptions :: CsvOptions
- data Delete = Delete' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text
- newDelete :: Text -> Delete
- data DeleteGlobalSecondaryIndexAction = DeleteGlobalSecondaryIndexAction' Text
- newDeleteGlobalSecondaryIndexAction :: Text -> DeleteGlobalSecondaryIndexAction
- data DeleteReplicaAction = DeleteReplicaAction' Text
- newDeleteReplicaAction :: Text -> DeleteReplicaAction
- data DeleteReplicationGroupMemberAction = DeleteReplicationGroupMemberAction' Text
- newDeleteReplicationGroupMemberAction :: Text -> DeleteReplicationGroupMemberAction
- data Endpoint = Endpoint' Text Integer
- newEndpoint :: Text -> Integer -> Endpoint
- data ExpectedAttributeValue = ExpectedAttributeValue' (Maybe [AttributeValue]) (Maybe ComparisonOperator) (Maybe Bool) (Maybe AttributeValue)
- newExpectedAttributeValue :: ExpectedAttributeValue
- data ExportDescription = ExportDescription' (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ExportFormat) (Maybe Text) (Maybe ExportStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3SseAlgorithm) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newExportDescription :: ExportDescription
- data ExportSummary = ExportSummary' (Maybe Text) (Maybe ExportStatus)
- newExportSummary :: ExportSummary
- data FailureException = FailureException' (Maybe Text) (Maybe Text)
- newFailureException :: FailureException
- data Get = Get' (Maybe (HashMap Text Text)) (Maybe Text) (HashMap Text AttributeValue) Text
- newGet :: Text -> Get
- data GlobalSecondaryIndex = GlobalSecondaryIndex' (Maybe ProvisionedThroughput) Text (NonEmpty KeySchemaElement) Projection
- newGlobalSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> GlobalSecondaryIndex
- data GlobalSecondaryIndexAutoScalingUpdate = GlobalSecondaryIndexAutoScalingUpdate' (Maybe Text) (Maybe AutoScalingSettingsUpdate)
- newGlobalSecondaryIndexAutoScalingUpdate :: GlobalSecondaryIndexAutoScalingUpdate
- data GlobalSecondaryIndexDescription = GlobalSecondaryIndexDescription' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe IndexStatus) (Maybe Integer) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection) (Maybe ProvisionedThroughputDescription)
- newGlobalSecondaryIndexDescription :: GlobalSecondaryIndexDescription
- data GlobalSecondaryIndexInfo = GlobalSecondaryIndexInfo' (Maybe Text) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection) (Maybe ProvisionedThroughput)
- newGlobalSecondaryIndexInfo :: GlobalSecondaryIndexInfo
- data GlobalSecondaryIndexUpdate = GlobalSecondaryIndexUpdate' (Maybe CreateGlobalSecondaryIndexAction) (Maybe DeleteGlobalSecondaryIndexAction) (Maybe UpdateGlobalSecondaryIndexAction)
- newGlobalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate
- data GlobalTable = GlobalTable' (Maybe Text) (Maybe [Replica])
- newGlobalTable :: GlobalTable
- data GlobalTableDescription = GlobalTableDescription' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe GlobalTableStatus) (Maybe [ReplicaDescription])
- newGlobalTableDescription :: GlobalTableDescription
- data GlobalTableGlobalSecondaryIndexSettingsUpdate = GlobalTableGlobalSecondaryIndexSettingsUpdate' (Maybe AutoScalingSettingsUpdate) (Maybe Natural) Text
- newGlobalTableGlobalSecondaryIndexSettingsUpdate :: Text -> GlobalTableGlobalSecondaryIndexSettingsUpdate
- data ImportSummary = ImportSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ImportStatus) (Maybe InputFormat) (Maybe S3BucketSource) (Maybe POSIX) (Maybe Text)
- newImportSummary :: ImportSummary
- data ImportTableDescription = ImportTableDescription' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ImportStatus) (Maybe Natural) (Maybe InputCompressionType) (Maybe InputFormat) (Maybe InputFormatOptions) (Maybe Natural) (Maybe Integer) (Maybe S3BucketSource) (Maybe POSIX) (Maybe Text) (Maybe TableCreationParameters) (Maybe Text)
- newImportTableDescription :: ImportTableDescription
- data InputFormatOptions = InputFormatOptions' (Maybe CsvOptions)
- newInputFormatOptions :: InputFormatOptions
- data ItemCollectionMetrics = ItemCollectionMetrics' (Maybe (HashMap Text AttributeValue)) (Maybe [Double])
- newItemCollectionMetrics :: ItemCollectionMetrics
- data ItemResponse = ItemResponse' (Maybe (HashMap Text AttributeValue))
- newItemResponse :: ItemResponse
- data KeySchemaElement = KeySchemaElement' Text KeyType
- newKeySchemaElement :: Text -> KeyType -> KeySchemaElement
- data KeysAndAttributes = KeysAndAttributes' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (NonEmpty (HashMap Text AttributeValue))
- newKeysAndAttributes :: NonEmpty (HashMap Text AttributeValue) -> KeysAndAttributes
- data KinesisDataStreamDestination = KinesisDataStreamDestination' (Maybe DestinationStatus) (Maybe Text) (Maybe Text)
- newKinesisDataStreamDestination :: KinesisDataStreamDestination
- data KinesisStreamingDestinationInput = KinesisStreamingDestinationInput' Text Text
- newKinesisStreamingDestinationInput :: Text -> Text -> KinesisStreamingDestinationInput
- data KinesisStreamingDestinationOutput = KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text)
- newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput
- data LocalSecondaryIndex = LocalSecondaryIndex' Text (NonEmpty KeySchemaElement) Projection
- newLocalSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> LocalSecondaryIndex
- data LocalSecondaryIndexDescription = LocalSecondaryIndexDescription' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection)
- newLocalSecondaryIndexDescription :: LocalSecondaryIndexDescription
- data LocalSecondaryIndexInfo = LocalSecondaryIndexInfo' (Maybe Text) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection)
- newLocalSecondaryIndexInfo :: LocalSecondaryIndexInfo
- data ParameterizedStatement = ParameterizedStatement' (Maybe (NonEmpty AttributeValue)) Text
- newParameterizedStatement :: Text -> ParameterizedStatement
- data PointInTimeRecoveryDescription = PointInTimeRecoveryDescription' (Maybe POSIX) (Maybe POSIX) (Maybe PointInTimeRecoveryStatus)
- newPointInTimeRecoveryDescription :: PointInTimeRecoveryDescription
- data PointInTimeRecoverySpecification = PointInTimeRecoverySpecification' Bool
- newPointInTimeRecoverySpecification :: Bool -> PointInTimeRecoverySpecification
- data Projection = Projection' (Maybe (NonEmpty Text)) (Maybe ProjectionType)
- newProjection :: Projection
- data ProvisionedThroughput = ProvisionedThroughput' Natural Natural
- newProvisionedThroughput :: Natural -> Natural -> ProvisionedThroughput
- data ProvisionedThroughputDescription = ProvisionedThroughputDescription' (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newProvisionedThroughputDescription :: ProvisionedThroughputDescription
- data ProvisionedThroughputOverride = ProvisionedThroughputOverride' (Maybe Natural)
- newProvisionedThroughputOverride :: ProvisionedThroughputOverride
- data Put = Put' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text
- newPut :: Text -> Put
- data Replica = Replica' (Maybe Text)
- newReplica :: Replica
- data ReplicaAutoScalingDescription = ReplicaAutoScalingDescription' (Maybe [ReplicaGlobalSecondaryIndexAutoScalingDescription]) (Maybe Text) (Maybe AutoScalingSettingsDescription) (Maybe AutoScalingSettingsDescription) (Maybe ReplicaStatus)
- newReplicaAutoScalingDescription :: ReplicaAutoScalingDescription
- data ReplicaAutoScalingUpdate = ReplicaAutoScalingUpdate' (Maybe [ReplicaGlobalSecondaryIndexAutoScalingUpdate]) (Maybe AutoScalingSettingsUpdate) Text
- newReplicaAutoScalingUpdate :: Text -> ReplicaAutoScalingUpdate
- data ReplicaDescription = ReplicaDescription' (Maybe [ReplicaGlobalSecondaryIndexDescription]) (Maybe Text) (Maybe ProvisionedThroughputOverride) (Maybe Text) (Maybe POSIX) (Maybe ReplicaStatus) (Maybe Text) (Maybe Text) (Maybe TableClassSummary)
- newReplicaDescription :: ReplicaDescription
- data ReplicaGlobalSecondaryIndex = ReplicaGlobalSecondaryIndex' (Maybe ProvisionedThroughputOverride) Text
- newReplicaGlobalSecondaryIndex :: Text -> ReplicaGlobalSecondaryIndex
- data ReplicaGlobalSecondaryIndexAutoScalingDescription = ReplicaGlobalSecondaryIndexAutoScalingDescription' (Maybe Text) (Maybe IndexStatus) (Maybe AutoScalingSettingsDescription) (Maybe AutoScalingSettingsDescription)
- newReplicaGlobalSecondaryIndexAutoScalingDescription :: ReplicaGlobalSecondaryIndexAutoScalingDescription
- data ReplicaGlobalSecondaryIndexAutoScalingUpdate = ReplicaGlobalSecondaryIndexAutoScalingUpdate' (Maybe Text) (Maybe AutoScalingSettingsUpdate)
- newReplicaGlobalSecondaryIndexAutoScalingUpdate :: ReplicaGlobalSecondaryIndexAutoScalingUpdate
- data ReplicaGlobalSecondaryIndexDescription = ReplicaGlobalSecondaryIndexDescription' (Maybe Text) (Maybe ProvisionedThroughputOverride)
- newReplicaGlobalSecondaryIndexDescription :: ReplicaGlobalSecondaryIndexDescription
- data ReplicaGlobalSecondaryIndexSettingsDescription = ReplicaGlobalSecondaryIndexSettingsDescription' (Maybe IndexStatus) (Maybe AutoScalingSettingsDescription) (Maybe Natural) (Maybe AutoScalingSettingsDescription) (Maybe Natural) Text
- newReplicaGlobalSecondaryIndexSettingsDescription :: Text -> ReplicaGlobalSecondaryIndexSettingsDescription
- data ReplicaGlobalSecondaryIndexSettingsUpdate = ReplicaGlobalSecondaryIndexSettingsUpdate' (Maybe AutoScalingSettingsUpdate) (Maybe Natural) Text
- newReplicaGlobalSecondaryIndexSettingsUpdate :: Text -> ReplicaGlobalSecondaryIndexSettingsUpdate
- data ReplicaSettingsDescription = ReplicaSettingsDescription' (Maybe BillingModeSummary) (Maybe [ReplicaGlobalSecondaryIndexSettingsDescription]) (Maybe AutoScalingSettingsDescription) (Maybe Natural) (Maybe AutoScalingSettingsDescription) (Maybe Natural) (Maybe ReplicaStatus) (Maybe TableClassSummary) Text
- newReplicaSettingsDescription :: Text -> ReplicaSettingsDescription
- data ReplicaSettingsUpdate = ReplicaSettingsUpdate' (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate)) (Maybe AutoScalingSettingsUpdate) (Maybe Natural) (Maybe TableClass) Text
- newReplicaSettingsUpdate :: Text -> ReplicaSettingsUpdate
- data ReplicaUpdate = ReplicaUpdate' (Maybe CreateReplicaAction) (Maybe DeleteReplicaAction)
- newReplicaUpdate :: ReplicaUpdate
- data ReplicationGroupUpdate = ReplicationGroupUpdate' (Maybe CreateReplicationGroupMemberAction) (Maybe DeleteReplicationGroupMemberAction) (Maybe UpdateReplicationGroupMemberAction)
- newReplicationGroupUpdate :: ReplicationGroupUpdate
- data RestoreSummary = RestoreSummary' (Maybe Text) (Maybe Text) POSIX Bool
- newRestoreSummary :: UTCTime -> Bool -> RestoreSummary
- data S3BucketSource = S3BucketSource' (Maybe Text) (Maybe Text) Text
- newS3BucketSource :: Text -> S3BucketSource
- data SSEDescription = SSEDescription' (Maybe POSIX) (Maybe Text) (Maybe SSEType) (Maybe SSEStatus)
- newSSEDescription :: SSEDescription
- data SSESpecification = SSESpecification' (Maybe Bool) (Maybe Text) (Maybe SSEType)
- newSSESpecification :: SSESpecification
- data SourceTableDetails = SourceTableDetails' (Maybe BillingMode) (Maybe Natural) (Maybe Text) (Maybe Integer) Text Text (NonEmpty KeySchemaElement) POSIX ProvisionedThroughput
- newSourceTableDetails :: Text -> Text -> NonEmpty KeySchemaElement -> UTCTime -> ProvisionedThroughput -> SourceTableDetails
- data SourceTableFeatureDetails = SourceTableFeatureDetails' (Maybe [GlobalSecondaryIndexInfo]) (Maybe [LocalSecondaryIndexInfo]) (Maybe SSEDescription) (Maybe StreamSpecification) (Maybe TimeToLiveDescription)
- newSourceTableFeatureDetails :: SourceTableFeatureDetails
- data StreamSpecification = StreamSpecification' (Maybe StreamViewType) Bool
- newStreamSpecification :: Bool -> StreamSpecification
- data TableAutoScalingDescription = TableAutoScalingDescription' (Maybe [ReplicaAutoScalingDescription]) (Maybe Text) (Maybe TableStatus)
- newTableAutoScalingDescription :: TableAutoScalingDescription
- data TableClassSummary = TableClassSummary' (Maybe POSIX) (Maybe TableClass)
- newTableClassSummary :: TableClassSummary
- data TableCreationParameters = TableCreationParameters' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe SSESpecification) Text [AttributeDefinition] (NonEmpty KeySchemaElement)
- newTableCreationParameters :: Text -> NonEmpty KeySchemaElement -> TableCreationParameters
- data TableDescription = TableDescription' (Maybe ArchivalSummary) (Maybe [AttributeDefinition]) (Maybe BillingModeSummary) (Maybe POSIX) (Maybe [GlobalSecondaryIndexDescription]) (Maybe Text) (Maybe Integer) (Maybe (NonEmpty KeySchemaElement)) (Maybe Text) (Maybe Text) (Maybe [LocalSecondaryIndexDescription]) (Maybe ProvisionedThroughputDescription) (Maybe [ReplicaDescription]) (Maybe RestoreSummary) (Maybe SSEDescription) (Maybe StreamSpecification) (Maybe Text) (Maybe TableClassSummary) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe TableStatus)
- newTableDescription :: TableDescription
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TimeToLiveDescription = TimeToLiveDescription' (Maybe Text) (Maybe TimeToLiveStatus)
- newTimeToLiveDescription :: TimeToLiveDescription
- data TimeToLiveSpecification = TimeToLiveSpecification' Bool Text
- newTimeToLiveSpecification :: Bool -> Text -> TimeToLiveSpecification
- data TransactGetItem = TransactGetItem' Get
- newTransactGetItem :: Get -> TransactGetItem
- data TransactWriteItem = TransactWriteItem' (Maybe ConditionCheck) (Maybe Delete) (Maybe Put) (Maybe Update)
- newTransactWriteItem :: TransactWriteItem
- data Update = Update' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text Text
- newUpdate :: Text -> Text -> Update
- data UpdateGlobalSecondaryIndexAction = UpdateGlobalSecondaryIndexAction' Text ProvisionedThroughput
- newUpdateGlobalSecondaryIndexAction :: Text -> ProvisionedThroughput -> UpdateGlobalSecondaryIndexAction
- data UpdateReplicationGroupMemberAction = UpdateReplicationGroupMemberAction' (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) (Maybe Text) (Maybe ProvisionedThroughputOverride) (Maybe TableClass) Text
- newUpdateReplicationGroupMemberAction :: Text -> UpdateReplicationGroupMemberAction
Service Configuration
defaultService :: Service Source #
API version 2012-08-10
of the Amazon DynamoDB SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by DynamoDB
.
BackupInUseException
_BackupInUseException :: AsError a => Fold a ServiceError Source #
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
BackupNotFoundException
_BackupNotFoundException :: AsError a => Fold a ServiceError Source #
Backup not found for the given BackupARN.
ConditionalCheckFailedException
_ConditionalCheckFailedException :: AsError a => Fold a ServiceError Source #
A condition specified in the operation could not be evaluated.
ContinuousBackupsUnavailableException
_ContinuousBackupsUnavailableException :: AsError a => Fold a ServiceError Source #
Backups have not yet been enabled for this table.
DuplicateItemException
_DuplicateItemException :: AsError a => Fold a ServiceError Source #
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
ExportConflictException
_ExportConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict when writing to the specified S3 bucket.
ExportNotFoundException
_ExportNotFoundException :: AsError a => Fold a ServiceError Source #
The specified export was not found.
GlobalTableAlreadyExistsException
_GlobalTableAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified global table already exists.
GlobalTableNotFoundException
_GlobalTableNotFoundException :: AsError a => Fold a ServiceError Source #
The specified global table does not exist.
IdempotentParameterMismatchException
_IdempotentParameterMismatchException :: AsError a => Fold a ServiceError Source #
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
ImportConflictException
_ImportConflictException :: AsError a => Fold a ServiceError Source #
There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
ImportNotFoundException
_ImportNotFoundException :: AsError a => Fold a ServiceError Source #
The specified import was not found.
IndexNotFoundException
_IndexNotFoundException :: AsError a => Fold a ServiceError Source #
The operation tried to access a nonexistent index.
InternalServerError
_InternalServerError :: AsError a => Fold a ServiceError Source #
An error occurred on the server side.
InvalidExportTimeException
_InvalidExportTimeException :: AsError a => Fold a ServiceError Source #
The specified ExportTime
is outside of the point in time recovery
window.
InvalidRestoreTimeException
_InvalidRestoreTimeException :: AsError a => Fold a ServiceError Source #
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
ItemCollectionSizeLimitExceededException
_ItemCollectionSizeLimitExceededException :: AsError a => Fold a ServiceError Source #
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed
per account. These operations include CreateTable
, UpdateTable
,
DeleteTable
,UpdateTimeToLive
, RestoreTableFromBackup
, and
RestoreTableToPointInTime
.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
PointInTimeRecoveryUnavailableException
_PointInTimeRecoveryUnavailableException :: AsError a => Fold a ServiceError Source #
Point in time recovery has not yet been enabled for this source table.
ProvisionedThroughputExceededException
_ProvisionedThroughputExceededException :: AsError a => Fold a ServiceError Source #
Your request rate is too high. The Amazon Web Services 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.
ReplicaAlreadyExistsException
_ReplicaAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified replica is already part of the global table.
ReplicaNotFoundException
_ReplicaNotFoundException :: AsError a => Fold a ServiceError Source #
The specified replica is no longer part of the global table.
RequestLimitExceeded
_RequestLimitExceeded :: AsError a => Fold a ServiceError Source #
Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
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.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The operation tried to access a nonexistent table or index. The resource
might not be specified correctly, or its status might not be ACTIVE
.
TableAlreadyExistsException
_TableAlreadyExistsException :: AsError a => Fold a ServiceError Source #
A target table with the specified name already exists.
TableInUseException
_TableInUseException :: AsError a => Fold a ServiceError Source #
A target table with the specified name is either being created or deleted.
TableNotFoundException
_TableNotFoundException :: AsError a => Fold a ServiceError Source #
A source table with the name TableName
does not currently exist within
the subscriber's account or the subscriber is operating in the wrong
Amazon Web Services Region.
TransactionCanceledException
_TransactionCanceledException :: AsError a => Fold a ServiceError Source #
The entire transaction request was canceled.
DynamoDB cancels a TransactWriteItems
request under the following
circumstances:
- A condition in one of the condition expressions is not met.
- A table in the
TransactWriteItems
request is in a different account or region. - More than one action in the
TransactWriteItems
operation targets the same item. - There is insufficient provisioned capacity for the transaction to be completed.
- An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
- There is a user error, such as an invalid data format.
DynamoDB cancels a TransactGetItems
request under the following
circumstances:
- There is an ongoing
TransactGetItems
operation that conflicts with a concurrentPutItem
,UpdateItem
,DeleteItem
orTransactWriteItems
request. In this case theTransactGetItems
operation fails with aTransactionCanceledException
. - A table in the
TransactGetItems
request is in a different account or region. - There is insufficient provisioned capacity for the transaction to be completed.
- There is a user error, such as an invalid data format.
If using Java, DynamoDB lists the cancellation reasons on the
CancellationReasons
property. This property is not set for other
languages. Transaction cancellation reasons are ordered in the order of
requested items, if an item has no error it will have None
code and
Null
message.
Cancellation reason codes and possible error messages:
No Errors:
- Code:
None
- Message:
null
- Code:
Conditional Check Failed:
- Code:
ConditionalCheckFailed
- Message: The conditional request failed.
- Code:
Item Collection Size Limit Exceeded:
- Code:
ItemCollectionSizeLimitExceeded
- Message: Collection size exceeded.
- Code:
Transaction Conflict:
- Code:
TransactionConflict
- Message: Transaction is ongoing for the item.
- Code:
Provisioned Throughput Exceeded:
- Code:
ProvisionedThroughputExceeded
Messages:
The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
- Code:
Throttling Error:
- Code:
ThrottlingError
Messages:
Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
- Code:
Validation Error:
- Code:
ValidationError
Messages:
- One or more parameter values were invalid.
- The update expression attempted to update the secondary index key beyond allowed size limits.
- The update expression attempted to update the secondary index key to unsupported type.
- An operand in the update expression has an incorrect data type.
- Item size to update has exceeded the maximum allowed size.
- Number overflow. Attempting to store a number with magnitude larger than supported range.
- Type mismatch for attribute to update.
- Nesting Levels have exceeded supported limits.
- The document path provided in the update expression is invalid for update.
- The provided expression refers to an attribute that does not exist in the item.
- Code:
TransactionConflictException
_TransactionConflictException :: AsError a => Fold a ServiceError Source #
Operation was rejected because there is an ongoing transaction for the item.
TransactionInProgressException
_TransactionInProgressException :: AsError a => Fold a ServiceError Source #
The transaction with the given request token is already in progress.
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.
TableExists
newTableExists :: Wait DescribeTable Source #
Polls DescribeTable
every 20 seconds until a successful state is reached. An error is returned after 25 failed checks.
TableNotExists
newTableNotExists :: Wait DescribeTable Source #
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.
BatchExecuteStatement
data BatchExecuteStatement Source #
See: newBatchExecuteStatement
smart constructor.
Constructors
BatchExecuteStatement' (Maybe ReturnConsumedCapacity) (NonEmpty BatchStatementRequest) |
Instances
newBatchExecuteStatement Source #
Arguments
:: NonEmpty BatchStatementRequest | |
-> BatchExecuteStatement |
Create a value of BatchExecuteStatement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnConsumedCapacity:BatchExecuteStatement'
, batchExecuteStatement_returnConsumedCapacity
- Undocumented member.
$sel:statements:BatchExecuteStatement'
, batchExecuteStatement_statements
- The list of PartiQL statements representing the batch to run.
data BatchExecuteStatementResponse Source #
See: newBatchExecuteStatementResponse
smart constructor.
Constructors
BatchExecuteStatementResponse' (Maybe [ConsumedCapacity]) (Maybe [BatchStatementResponse]) Int |
Instances
newBatchExecuteStatementResponse Source #
Create a value of BatchExecuteStatementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:BatchExecuteStatementResponse'
, batchExecuteStatementResponse_consumedCapacity
- The capacity units consumed by the entire operation. The values of the
list are ordered according to the ordering of the statements.
$sel:responses:BatchExecuteStatementResponse'
, batchExecuteStatementResponse_responses
- The response to each PartiQL statement in the batch.
$sel:httpStatus:BatchExecuteStatementResponse'
, batchExecuteStatementResponse_httpStatus
- The response's http status code.
BatchGetItem
data BatchGetItem Source #
Represents the input of a BatchGetItem
operation.
See: newBatchGetItem
smart constructor.
Constructors
BatchGetItem' (Maybe ReturnConsumedCapacity) (HashMap Text KeysAndAttributes) |
Instances
newBatchGetItem :: BatchGetItem Source #
Create a value of BatchGetItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnConsumedCapacity:BatchGetItem'
, batchGetItem_returnConsumedCapacity
- Undocumented member.
$sel:requestItems:BatchGetItem'
, batchGetItem_requestItems
- A map of one or more table names and, for each table, a map that
describes one or more items to retrieve from that table. Each table name
can be used only once per BatchGetItem
request.
Each element in the map of items to retrieve consists of the following:
ConsistentRead
- Iftrue
, a strongly consistent read is used; iffalse
(the default), an eventually consistent read is used.ExpressionAttributeNames
- One or more substitution tokens for attribute names in theProjectionExpression
parameter. 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:
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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Keys
- An array of primary key attribute values that define specific items in 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 value. For a composite key, you must provide both the partition key value and the sort key value.ProjectionExpression
- 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 expression must be separated by commas.If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
AttributesToGet
- This is a legacy parameter. UseProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
data BatchGetItemResponse Source #
Represents the output of a BatchGetItem
operation.
See: newBatchGetItemResponse
smart constructor.
Constructors
BatchGetItemResponse' (Maybe [ConsumedCapacity]) Int (HashMap Text [HashMap Text AttributeValue]) (HashMap Text KeysAndAttributes) |
Instances
newBatchGetItemResponse Source #
Arguments
:: Int | |
-> BatchGetItemResponse |
Create a value of BatchGetItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:BatchGetItemResponse'
, batchGetItemResponse_consumedCapacity
- The read capacity units consumed by the entire BatchGetItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.CapacityUnits
- The total number of capacity units consumed.
$sel:httpStatus:BatchGetItemResponse'
, batchGetItemResponse_httpStatus
- The response's http status code.
$sel:responses:BatchGetItemResponse'
, batchGetItemResponse_responses
- A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting
of the data type and attribute value.
$sel:unprocessedKeys:BatchGetItemResponse'
, batchGetItemResponse_unprocessedKeys
- A map of tables and their respective keys that were not processed with
the current response. The UnprocessedKeys
value is in the same form as
RequestItems
, so the value can be provided directly to a subsequent
BatchGetItem
operation. For more information, see RequestItems
in
the Request Parameters section.
Each element consists of:
Keys
- An array of primary key attribute values that define specific items in the table.ProjectionExpression
- One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.ConsistentRead
- The consistency of a read operation. If set totrue
, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an
empty UnprocessedKeys
map.
BatchWriteItem
data BatchWriteItem Source #
Represents the input of a BatchWriteItem
operation.
See: newBatchWriteItem
smart constructor.
Constructors
BatchWriteItem' (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (HashMap Text (NonEmpty WriteRequest)) |
Instances
newBatchWriteItem :: BatchWriteItem Source #
Create a value of BatchWriteItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnConsumedCapacity:BatchWriteItem'
, batchWriteItem_returnConsumedCapacity
- Undocumented member.
$sel:returnItemCollectionMetrics:BatchWriteItem'
, batchWriteItem_returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any,
that were modified during the operation are returned in the response. If
set to NONE
(the default), no statistics are returned.
$sel:requestItems:BatchWriteItem'
, batchWriteItem_requestItems
- A map of one or more table names and, for each table, a list of
operations to be performed (DeleteRequest
or PutRequest
). Each
element in the map consists of the following:
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
subelement:Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
subelement:Item
- A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with aValidationException
exception.If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
data BatchWriteItemResponse Source #
Represents the output of a BatchWriteItem
operation.
See: newBatchWriteItemResponse
smart constructor.
Constructors
BatchWriteItemResponse' (Maybe [ConsumedCapacity]) (Maybe (HashMap Text [ItemCollectionMetrics])) Int (HashMap Text (NonEmpty WriteRequest)) |
Instances
newBatchWriteItemResponse Source #
Create a value of BatchWriteItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:BatchWriteItemResponse'
, batchWriteItemResponse_consumedCapacity
- The capacity units consumed by the entire BatchWriteItem
operation.
Each element consists of:
TableName
- The table that consumed the provisioned throughput.CapacityUnits
- The total number of capacity units consumed.
$sel:itemCollectionMetrics:BatchWriteItemResponse'
, batchWriteItemResponse_itemCollectionMetrics
- A list of tables that were processed by BatchWriteItem
and, for each
table, information about any item collections that were affected by
individual DeleteItem
or PutItem
operations.
Each entry consists of the following subelements:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item.SizeEstimateRangeGB
- An estimate of item collection size, expressed in GB. This 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 the 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.
$sel:httpStatus:BatchWriteItemResponse'
, batchWriteItemResponse_httpStatus
- The response's http status code.
$sel:unprocessedItems:BatchWriteItemResponse'
, batchWriteItemResponse_unprocessedItems
- A map of tables and requests against those tables that were not
processed. The UnprocessedItems
value is in the same form as
RequestItems
, so you can provide this value directly to a subsequent
BatchWriteItem
operation. For more information, see RequestItems
in
the Request Parameters section.
Each UnprocessedItems
entry consists of a table name and, for that
table, a list of operations to perform (DeleteRequest
or
PutRequest
).
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
subelement:Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
subelement:Item
- A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with aValidationException
exception.If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an
empty UnprocessedItems
map.
CreateBackup
data CreateBackup Source #
See: newCreateBackup
smart constructor.
Constructors
CreateBackup' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateBackup |
Create a value of CreateBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackup
, createBackup_tableName
- The name of the table.
CreateBackup
, createBackup_backupName
- Specified name for the backup.
data CreateBackupResponse Source #
See: newCreateBackupResponse
smart constructor.
Constructors
CreateBackupResponse' (Maybe BackupDetails) Int |
Instances
newCreateBackupResponse Source #
Arguments
:: Int | |
-> CreateBackupResponse |
Create a value of CreateBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackupResponse
, createBackupResponse_backupDetails
- Contains the details of the backup created for the table.
$sel:httpStatus:CreateBackupResponse'
, createBackupResponse_httpStatus
- The response's http status code.
CreateGlobalTable
data CreateGlobalTable Source #
See: newCreateGlobalTable
smart constructor.
Constructors
CreateGlobalTable' Text [Replica] |
Instances
Arguments
:: Text | |
-> CreateGlobalTable |
Create a value of CreateGlobalTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateGlobalTable
, createGlobalTable_globalTableName
- The global table name.
CreateGlobalTable
, createGlobalTable_replicationGroup
- The Regions where the global table needs to be created.
data CreateGlobalTableResponse Source #
See: newCreateGlobalTableResponse
smart constructor.
Constructors
CreateGlobalTableResponse' (Maybe GlobalTableDescription) Int |
Instances
newCreateGlobalTableResponse Source #
Create a value of CreateGlobalTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTableDescription:CreateGlobalTableResponse'
, createGlobalTableResponse_globalTableDescription
- Contains the details of the global table.
$sel:httpStatus:CreateGlobalTableResponse'
, createGlobalTableResponse_httpStatus
- The response's http status code.
CreateTable
data CreateTable Source #
Represents the input of a CreateTable
operation.
See: newCreateTable
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> NonEmpty KeySchemaElement | |
-> CreateTable |
Create a value of CreateTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTable
, createTable_billingMode
- Controls how you are charged for read and write throughput and how you
manage capacity. This setting can be changed later.
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
CreateTable
, createTable_globalSecondaryIndexes
- One or more global secondary indexes (the maximum is 20) to be created
on the table. Each global secondary index in the array includes the
following:
IndexName
- The name of the global secondary index. Must be unique only for this table.KeySchema
- Specifies the key schema for the global secondary index.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 is 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 100. 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.
CreateTable
, createTable_localSecondaryIndexes
- One or more local secondary indexes (the maximum is 5) to be created on
the table. Each index is scoped to a given partition key value. There is
a 10 GB size limit per partition key value; otherwise, the size of a
local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName
- The name of the local secondary index. Must be unique only for this table.KeySchema
- Specifies the key schema for the local secondary index. 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 is 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 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
CreateTable
, createTable_provisionedThroughput
- Represents the provisioned throughput settings for a specified table or
index. The settings can be modified using the UpdateTable
operation.
If you set BillingMode as PROVISIONED
, you must specify this property.
If you set BillingMode as PAY_PER_REQUEST
, you cannot specify this
property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
CreateTable
, createTable_sSESpecification
- Represents the settings used to enable server-side encryption.
CreateTable
, createTable_streamSpecification
- The settings for DynamoDB Streams on the table. These settings consist
of:
StreamEnabled
- Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).StreamViewType
- When an item in the table is modified,StreamViewType
determines what information is written to the table's stream. Valid values forStreamViewType
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.
CreateTable
, createTable_tableClass
- The table class of the new table. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
$sel:tags:CreateTable'
, createTable_tags
- A list of key-value pairs to label the table. For more information, see
Tagging for DynamoDB.
CreateTable
, createTable_attributeDefinitions
- An array of attributes that describe the key schema for the table and
indexes.
CreateTable
, createTable_tableName
- The name of the table to create.
CreateTable
, createTable_keySchema
- Specifies the attributes that make up the primary key for a table or an
index. The attributes in KeySchema
must also be defined in the
AttributeDefinitions
array. For more information, see
Data Model
in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement
in the array is composed of:
AttributeName
- The name of this key attribute.KeyType
- The role that the key attribute will assume:HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For a simple primary key (partition key), you must provide exactly one
element with a KeyType
of HASH
.
For a composite primary key (partition key and sort key), you must
provide exactly two elements, in this order: The first element must have
a KeyType
of HASH
, and the second element must have a KeyType
of
RANGE
.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
data CreateTableResponse Source #
Represents the output of a CreateTable
operation.
See: newCreateTableResponse
smart constructor.
Constructors
CreateTableResponse' (Maybe TableDescription) Int |
Instances
newCreateTableResponse Source #
Arguments
:: Int | |
-> CreateTableResponse |
Create a value of CreateTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableDescription:CreateTableResponse'
, createTableResponse_tableDescription
- Represents the properties of the table.
$sel:httpStatus:CreateTableResponse'
, createTableResponse_httpStatus
- The response's http status code.
DeleteBackup
data DeleteBackup Source #
See: newDeleteBackup
smart constructor.
Constructors
DeleteBackup' Text |
Instances
Arguments
:: Text | |
-> DeleteBackup |
Create a value of DeleteBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackup
, deleteBackup_backupArn
- The ARN associated with the backup.
data DeleteBackupResponse Source #
See: newDeleteBackupResponse
smart constructor.
Constructors
DeleteBackupResponse' (Maybe BackupDescription) Int |
Instances
newDeleteBackupResponse Source #
Arguments
:: Int | |
-> DeleteBackupResponse |
Create a value of DeleteBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupDescription:DeleteBackupResponse'
, deleteBackupResponse_backupDescription
- Contains the description of the backup created for the table.
$sel:httpStatus:DeleteBackupResponse'
, deleteBackupResponse_httpStatus
- The response's http status code.
DeleteItem
data DeleteItem Source #
Represents the input of a DeleteItem
operation.
See: newDeleteItem
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> DeleteItem |
Create a value of DeleteItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteItem
, deleteItem_conditionExpression
- A condition that must be satisfied in order for a conditional
DeleteItem
to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
- Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
- Logical operators:
AND | OR | NOT
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:conditionalOperator:DeleteItem'
, deleteItem_conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
ConditionalOperator
in the Amazon DynamoDB Developer Guide.
$sel:expected:DeleteItem'
, deleteItem_expected
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
Expected
in the Amazon DynamoDB Developer Guide.
DeleteItem
, deleteItem_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
DeleteItem
, deleteItem_expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:DeleteItem'
, deleteItem_returnConsumedCapacity
- Undocumented member.
$sel:returnItemCollectionMetrics:DeleteItem'
, deleteItem_returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any,
that were modified during the operation are returned in the response. If
set to NONE
(the default), no statistics are returned.
$sel:returnValues:DeleteItem'
, deleteItem_returnValues
- Use ReturnValues
if you want to get the item attributes as they
appeared before they were deleted. For DeleteItem
, the valid values
are:
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.)ALL_OLD
- The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations;
however, DeleteItem
does not recognize any values other than NONE
or
ALL_OLD
.
DeleteItem
, deleteItem_tableName
- The name of the table from which to delete the item.
DeleteItem
, deleteItem_key
- A map of attribute names to AttributeValue
objects, representing the
primary key of the item to delete.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
data DeleteItemResponse Source #
Represents the output of a DeleteItem
operation.
See: newDeleteItemResponse
smart constructor.
Constructors
DeleteItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int |
Instances
newDeleteItemResponse Source #
Arguments
:: Int | |
-> DeleteItemResponse |
Create a value of DeleteItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:DeleteItemResponse'
, deleteItemResponse_attributes
- A map of attribute names to AttributeValue
objects, representing the
item as it appeared before the DeleteItem
operation. This map appears
in the response only if ReturnValues
was specified as ALL_OLD
in the
request.
$sel:consumedCapacity:DeleteItemResponse'
, deleteItemResponse_consumedCapacity
- The capacity units consumed by the DeleteItem
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Provisioned Mode
in the Amazon DynamoDB Developer Guide.
$sel:itemCollectionMetrics:DeleteItemResponse'
, deleteItemResponse_itemCollectionMetrics
- Information about item collections, if any, that were affected by the
DeleteItem
operation. ItemCollectionMetrics
is only returned if the
ReturnItemCollectionMetrics
parameter was specified. If the table does
not have any local secondary indexes, this information is not returned
in the response.
Each ItemCollectionMetrics
element consists of:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself.SizeEstimateRangeGB
- 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.
$sel:httpStatus:DeleteItemResponse'
, deleteItemResponse_httpStatus
- The response's http status code.
DeleteTable
data DeleteTable Source #
Represents the input of a DeleteTable
operation.
See: newDeleteTable
smart constructor.
Constructors
DeleteTable' Text |
Instances
Arguments
:: Text | |
-> DeleteTable |
Create a value of DeleteTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteTable
, deleteTable_tableName
- The name of the table to delete.
data DeleteTableResponse Source #
Represents the output of a DeleteTable
operation.
See: newDeleteTableResponse
smart constructor.
Constructors
DeleteTableResponse' (Maybe TableDescription) Int |
Instances
newDeleteTableResponse Source #
Arguments
:: Int | |
-> DeleteTableResponse |
Create a value of DeleteTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableDescription:DeleteTableResponse'
, deleteTableResponse_tableDescription
- Represents the properties of a table.
$sel:httpStatus:DeleteTableResponse'
, deleteTableResponse_httpStatus
- The response's http status code.
DescribeBackup
data DescribeBackup Source #
See: newDescribeBackup
smart constructor.
Constructors
DescribeBackup' Text |
Instances
Arguments
:: Text | |
-> DescribeBackup |
Create a value of DescribeBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackup
, describeBackup_backupArn
- The Amazon Resource Name (ARN) associated with the backup.
data DescribeBackupResponse Source #
See: newDescribeBackupResponse
smart constructor.
Constructors
DescribeBackupResponse' (Maybe BackupDescription) Int |
Instances
newDescribeBackupResponse Source #
Create a value of DescribeBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupDescription:DescribeBackupResponse'
, describeBackupResponse_backupDescription
- Contains the description of the backup created for the table.
$sel:httpStatus:DescribeBackupResponse'
, describeBackupResponse_httpStatus
- The response's http status code.
DescribeContinuousBackups
data DescribeContinuousBackups Source #
See: newDescribeContinuousBackups
smart constructor.
Constructors
DescribeContinuousBackups' Text |
Instances
newDescribeContinuousBackups Source #
Arguments
:: Text | |
-> DescribeContinuousBackups |
Create a value of DescribeContinuousBackups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeContinuousBackups
, describeContinuousBackups_tableName
- Name of the table for which the customer wants to check the continuous
backups and point in time recovery settings.
data DescribeContinuousBackupsResponse Source #
See: newDescribeContinuousBackupsResponse
smart constructor.
Instances
newDescribeContinuousBackupsResponse Source #
Arguments
:: Int | |
-> DescribeContinuousBackupsResponse |
Create a value of DescribeContinuousBackupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:continuousBackupsDescription:DescribeContinuousBackupsResponse'
, describeContinuousBackupsResponse_continuousBackupsDescription
- Represents the continuous backups and point in time recovery settings on
the table.
$sel:httpStatus:DescribeContinuousBackupsResponse'
, describeContinuousBackupsResponse_httpStatus
- The response's http status code.
DescribeContributorInsights
data DescribeContributorInsights Source #
See: newDescribeContributorInsights
smart constructor.
Constructors
DescribeContributorInsights' (Maybe Text) Text |
Instances
newDescribeContributorInsights Source #
Arguments
:: Text | |
-> DescribeContributorInsights |
Create a value of DescribeContributorInsights
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeContributorInsights
, describeContributorInsights_indexName
- The name of the global secondary index to describe, if applicable.
DescribeContributorInsights
, describeContributorInsights_tableName
- The name of the table to describe.
data DescribeContributorInsightsResponse Source #
See: newDescribeContributorInsightsResponse
smart constructor.
Constructors
DescribeContributorInsightsResponse' (Maybe [Text]) (Maybe ContributorInsightsStatus) (Maybe FailureException) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newDescribeContributorInsightsResponse Source #
Arguments
:: Int | |
-> DescribeContributorInsightsResponse |
Create a value of DescribeContributorInsightsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contributorInsightsRuleList:DescribeContributorInsightsResponse'
, describeContributorInsightsResponse_contributorInsightsRuleList
- List of names of the associated contributor insights rules.
DescribeContributorInsightsResponse
, describeContributorInsightsResponse_contributorInsightsStatus
- Current status of contributor insights.
$sel:failureException:DescribeContributorInsightsResponse'
, describeContributorInsightsResponse_failureException
- Returns information about the last failure that was encountered.
The most common exceptions for a FAILED status are:
- LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
- AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
- AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
- InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
DescribeContributorInsights
, describeContributorInsightsResponse_indexName
- The name of the global secondary index being described.
DescribeContributorInsightsResponse
, describeContributorInsightsResponse_lastUpdateDateTime
- Timestamp of the last time the status was changed.
DescribeContributorInsights
, describeContributorInsightsResponse_tableName
- The name of the table being described.
$sel:httpStatus:DescribeContributorInsightsResponse'
, describeContributorInsightsResponse_httpStatus
- The response's http status code.
DescribeEndpoints
data DescribeEndpoints Source #
See: newDescribeEndpoints
smart constructor.
Constructors
DescribeEndpoints' | |
Instances
newDescribeEndpoints :: DescribeEndpoints Source #
Create a value of DescribeEndpoints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeEndpointsResponse Source #
See: newDescribeEndpointsResponse
smart constructor.
Constructors
DescribeEndpointsResponse' Int [Endpoint] |
Instances
newDescribeEndpointsResponse Source #
Create a value of DescribeEndpointsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeEndpointsResponse'
, describeEndpointsResponse_httpStatus
- The response's http status code.
$sel:endpoints:DescribeEndpointsResponse'
, describeEndpointsResponse_endpoints
- List of endpoints.
DescribeExport
data DescribeExport Source #
See: newDescribeExport
smart constructor.
Constructors
DescribeExport' Text |
Instances
Arguments
:: Text | |
-> DescribeExport |
Create a value of DescribeExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExport
, describeExport_exportArn
- The Amazon Resource Name (ARN) associated with the export.
data DescribeExportResponse Source #
See: newDescribeExportResponse
smart constructor.
Constructors
DescribeExportResponse' (Maybe ExportDescription) Int |
Instances
newDescribeExportResponse Source #
Create a value of DescribeExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportDescription:DescribeExportResponse'
, describeExportResponse_exportDescription
- Represents the properties of the export.
$sel:httpStatus:DescribeExportResponse'
, describeExportResponse_httpStatus
- The response's http status code.
DescribeGlobalTable
data DescribeGlobalTable Source #
See: newDescribeGlobalTable
smart constructor.
Constructors
DescribeGlobalTable' Text |
Instances
newDescribeGlobalTable Source #
Arguments
:: Text | |
-> DescribeGlobalTable |
Create a value of DescribeGlobalTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGlobalTable
, describeGlobalTable_globalTableName
- The name of the global table.
data DescribeGlobalTableResponse Source #
See: newDescribeGlobalTableResponse
smart constructor.
Constructors
DescribeGlobalTableResponse' (Maybe GlobalTableDescription) Int |
Instances
newDescribeGlobalTableResponse Source #
Create a value of DescribeGlobalTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTableDescription:DescribeGlobalTableResponse'
, describeGlobalTableResponse_globalTableDescription
- Contains the details of the global table.
$sel:httpStatus:DescribeGlobalTableResponse'
, describeGlobalTableResponse_httpStatus
- The response's http status code.
DescribeGlobalTableSettings
data DescribeGlobalTableSettings Source #
See: newDescribeGlobalTableSettings
smart constructor.
Constructors
DescribeGlobalTableSettings' Text |
Instances
newDescribeGlobalTableSettings Source #
Arguments
:: Text | |
-> DescribeGlobalTableSettings |
Create a value of DescribeGlobalTableSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGlobalTableSettings
, describeGlobalTableSettings_globalTableName
- The name of the global table to describe.
data DescribeGlobalTableSettingsResponse Source #
See: newDescribeGlobalTableSettingsResponse
smart constructor.
Constructors
DescribeGlobalTableSettingsResponse' (Maybe Text) (Maybe [ReplicaSettingsDescription]) Int |
Instances
newDescribeGlobalTableSettingsResponse Source #
Arguments
:: Int | |
-> DescribeGlobalTableSettingsResponse |
Create a value of DescribeGlobalTableSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeGlobalTableSettings
, describeGlobalTableSettingsResponse_globalTableName
- The name of the global table.
$sel:replicaSettings:DescribeGlobalTableSettingsResponse'
, describeGlobalTableSettingsResponse_replicaSettings
- The Region-specific settings for the global table.
$sel:httpStatus:DescribeGlobalTableSettingsResponse'
, describeGlobalTableSettingsResponse_httpStatus
- The response's http status code.
DescribeImport
data DescribeImport Source #
See: newDescribeImport
smart constructor.
Constructors
DescribeImport' Text |
Instances
Arguments
:: Text | |
-> DescribeImport |
Create a value of DescribeImport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeImport
, describeImport_importArn
- The Amazon Resource Name (ARN) associated with the table you're
importing to.
data DescribeImportResponse Source #
See: newDescribeImportResponse
smart constructor.
Constructors
DescribeImportResponse' Int ImportTableDescription |
Instances
newDescribeImportResponse Source #
Arguments
:: Int | |
-> ImportTableDescription | |
-> DescribeImportResponse |
Create a value of DescribeImportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeImportResponse'
, describeImportResponse_httpStatus
- The response's http status code.
$sel:importTableDescription:DescribeImportResponse'
, describeImportResponse_importTableDescription
- Represents the properties of the table created for the import, and
parameters of the import. The import parameters include import status,
how many items were processed, and how many errors were encountered.
DescribeKinesisStreamingDestination
data DescribeKinesisStreamingDestination Source #
See: newDescribeKinesisStreamingDestination
smart constructor.
Constructors
DescribeKinesisStreamingDestination' Text |
Instances
newDescribeKinesisStreamingDestination Source #
Create a value of DescribeKinesisStreamingDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeKinesisStreamingDestination
, describeKinesisStreamingDestination_tableName
- The name of the table being described.
data DescribeKinesisStreamingDestinationResponse Source #
See: newDescribeKinesisStreamingDestinationResponse
smart constructor.
Constructors
DescribeKinesisStreamingDestinationResponse' (Maybe [KinesisDataStreamDestination]) (Maybe Text) Int |
Instances
newDescribeKinesisStreamingDestinationResponse Source #
Arguments
:: Int |
|
-> DescribeKinesisStreamingDestinationResponse |
Create a value of DescribeKinesisStreamingDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kinesisDataStreamDestinations:DescribeKinesisStreamingDestinationResponse'
, describeKinesisStreamingDestinationResponse_kinesisDataStreamDestinations
- The list of replica structures for the table being described.
DescribeKinesisStreamingDestination
, describeKinesisStreamingDestinationResponse_tableName
- The name of the table being described.
$sel:httpStatus:DescribeKinesisStreamingDestinationResponse'
, describeKinesisStreamingDestinationResponse_httpStatus
- The response's http status code.
DescribeLimits
data DescribeLimits Source #
Represents the input of a DescribeLimits
operation. Has no content.
See: newDescribeLimits
smart constructor.
Constructors
DescribeLimits' | |
Instances
newDescribeLimits :: DescribeLimits Source #
Create a value of DescribeLimits
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeLimitsResponse Source #
Represents the output of a DescribeLimits
operation.
See: newDescribeLimitsResponse
smart constructor.
Constructors
DescribeLimitsResponse' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) Int |
Instances
newDescribeLimitsResponse Source #
Create a value of DescribeLimitsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountMaxReadCapacityUnits:DescribeLimitsResponse'
, describeLimitsResponse_accountMaxReadCapacityUnits
- The maximum total read capacity units that your account allows you to
provision across all of your tables in this Region.
$sel:accountMaxWriteCapacityUnits:DescribeLimitsResponse'
, describeLimitsResponse_accountMaxWriteCapacityUnits
- The maximum total write capacity units that your account allows you to
provision across all of your tables in this Region.
$sel:tableMaxReadCapacityUnits:DescribeLimitsResponse'
, describeLimitsResponse_tableMaxReadCapacityUnits
- The maximum read capacity units that your account allows you to
provision for a new table that you are creating in this Region,
including the read capacity units provisioned for its global secondary
indexes (GSIs).
$sel:tableMaxWriteCapacityUnits:DescribeLimitsResponse'
, describeLimitsResponse_tableMaxWriteCapacityUnits
- The maximum write capacity units that your account allows you to
provision for a new table that you are creating in this Region,
including the write capacity units provisioned for its global secondary
indexes (GSIs).
$sel:httpStatus:DescribeLimitsResponse'
, describeLimitsResponse_httpStatus
- The response's http status code.
DescribeTable
data DescribeTable Source #
Represents the input of a DescribeTable
operation.
See: newDescribeTable
smart constructor.
Constructors
DescribeTable' Text |
Instances
Arguments
:: Text | |
-> DescribeTable |
Create a value of DescribeTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTable
, describeTable_tableName
- The name of the table to describe.
data DescribeTableResponse Source #
Represents the output of a DescribeTable
operation.
See: newDescribeTableResponse
smart constructor.
Constructors
DescribeTableResponse' (Maybe TableDescription) Int |
Instances
newDescribeTableResponse Source #
Create a value of DescribeTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTableResponse
, describeTableResponse_table
- The properties of the table.
$sel:httpStatus:DescribeTableResponse'
, describeTableResponse_httpStatus
- The response's http status code.
DescribeTableReplicaAutoScaling
data DescribeTableReplicaAutoScaling Source #
See: newDescribeTableReplicaAutoScaling
smart constructor.
Constructors
DescribeTableReplicaAutoScaling' Text |
Instances
newDescribeTableReplicaAutoScaling Source #
Create a value of DescribeTableReplicaAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTableReplicaAutoScaling
, describeTableReplicaAutoScaling_tableName
- The name of the table.
data DescribeTableReplicaAutoScalingResponse Source #
See: newDescribeTableReplicaAutoScalingResponse
smart constructor.
Instances
newDescribeTableReplicaAutoScalingResponse Source #
Arguments
:: Int | |
-> DescribeTableReplicaAutoScalingResponse |
Create a value of DescribeTableReplicaAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableAutoScalingDescription:DescribeTableReplicaAutoScalingResponse'
, describeTableReplicaAutoScalingResponse_tableAutoScalingDescription
- Represents the auto scaling properties of the table.
$sel:httpStatus:DescribeTableReplicaAutoScalingResponse'
, describeTableReplicaAutoScalingResponse_httpStatus
- The response's http status code.
DescribeTimeToLive
data DescribeTimeToLive Source #
See: newDescribeTimeToLive
smart constructor.
Constructors
DescribeTimeToLive' Text |
Instances
newDescribeTimeToLive Source #
Arguments
:: Text | |
-> DescribeTimeToLive |
Create a value of DescribeTimeToLive
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTimeToLive
, describeTimeToLive_tableName
- The name of the table to be described.
data DescribeTimeToLiveResponse Source #
See: newDescribeTimeToLiveResponse
smart constructor.
Constructors
DescribeTimeToLiveResponse' (Maybe TimeToLiveDescription) Int |
Instances
newDescribeTimeToLiveResponse Source #
Create a value of DescribeTimeToLiveResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTimeToLiveResponse
, describeTimeToLiveResponse_timeToLiveDescription
-
$sel:httpStatus:DescribeTimeToLiveResponse'
, describeTimeToLiveResponse_httpStatus
- The response's http status code.
DisableKinesisStreamingDestination
data DisableKinesisStreamingDestination Source #
See: newDisableKinesisStreamingDestination
smart constructor.
Constructors
DisableKinesisStreamingDestination' Text Text |
Instances
newDisableKinesisStreamingDestination Source #
Arguments
:: Text | |
-> Text | |
-> DisableKinesisStreamingDestination |
Create a value of DisableKinesisStreamingDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisableKinesisStreamingDestination
, disableKinesisStreamingDestination_tableName
- The name of the DynamoDB table.
DisableKinesisStreamingDestination
, disableKinesisStreamingDestination_streamArn
- The ARN for a Kinesis data stream.
data KinesisStreamingDestinationOutput Source #
See: newKinesisStreamingDestinationOutput
smart constructor.
Constructors
KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text) |
Instances
newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput Source #
Create a value of KinesisStreamingDestinationOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationStatus:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_destinationStatus
- The current status of the replication.
$sel:streamArn:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_streamArn
- The ARN for the specific Kinesis data stream.
$sel:tableName:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_tableName
- The name of the table being modified.
EnableKinesisStreamingDestination
data EnableKinesisStreamingDestination Source #
See: newEnableKinesisStreamingDestination
smart constructor.
Constructors
EnableKinesisStreamingDestination' Text Text |
Instances
newEnableKinesisStreamingDestination Source #
Arguments
:: Text | |
-> Text | |
-> EnableKinesisStreamingDestination |
Create a value of EnableKinesisStreamingDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EnableKinesisStreamingDestination
, enableKinesisStreamingDestination_tableName
- The name of the DynamoDB table.
EnableKinesisStreamingDestination
, enableKinesisStreamingDestination_streamArn
- The ARN for a Kinesis data stream.
data KinesisStreamingDestinationOutput Source #
See: newKinesisStreamingDestinationOutput
smart constructor.
Constructors
KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text) |
Instances
newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput Source #
Create a value of KinesisStreamingDestinationOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationStatus:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_destinationStatus
- The current status of the replication.
$sel:streamArn:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_streamArn
- The ARN for the specific Kinesis data stream.
$sel:tableName:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_tableName
- The name of the table being modified.
ExecuteStatement
data ExecuteStatement Source #
See: newExecuteStatement
smart constructor.
Constructors
ExecuteStatement' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe (NonEmpty AttributeValue)) (Maybe ReturnConsumedCapacity) Text |
Instances
Arguments
:: Text | |
-> ExecuteStatement |
Create a value of ExecuteStatement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExecuteStatement
, executeStatement_consistentRead
- The consistency of a read operation. If set to true
, then a strongly
consistent read is used; otherwise, an eventually consistent read is
used.
$sel:limit:ExecuteStatement'
, executeStatement_limit
- The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, along with a key in
LastEvaluatedKey
to apply in a subsequent operation so you can pick up
where you left off. Also, if the processed dataset size exceeds 1 MB
before DynamoDB reaches this limit, it stops the operation and returns
the matching values up to the limit, and a key in LastEvaluatedKey
to
apply in a subsequent operation to continue the operation.
ExecuteStatement
, executeStatement_nextToken
- Set this value to get remaining results, if NextToken
was returned in
the statement response.
ExecuteStatement
, executeStatement_parameters
- The parameters for the PartiQL statement, if any.
$sel:returnConsumedCapacity:ExecuteStatement'
, executeStatement_returnConsumedCapacity
- Undocumented member.
ExecuteStatement
, executeStatement_statement
- The PartiQL statement representing the operation to run.
data ExecuteStatementResponse Source #
See: newExecuteStatementResponse
smart constructor.
Constructors
ExecuteStatementResponse' (Maybe ConsumedCapacity) (Maybe [HashMap Text AttributeValue]) (Maybe (HashMap Text AttributeValue)) (Maybe Text) Int |
Instances
newExecuteStatementResponse Source #
Create a value of ExecuteStatementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:ExecuteStatementResponse'
, executeStatementResponse_consumedCapacity
- Undocumented member.
$sel:items:ExecuteStatementResponse'
, executeStatementResponse_items
- If a read operation was used, this property will contain the result of
the read operation; a map of attribute names and their values. For the
write operations this value will be empty.
$sel:lastEvaluatedKey:ExecuteStatementResponse'
, executeStatementResponse_lastEvaluatedKey
- The primary key of the item where the operation stopped, inclusive of
the previous result set. Use this value to start a new operation,
excluding this value in the new request. If LastEvaluatedKey
is empty,
then the "last page" of results has been processed and there is no
more data to be retrieved. If LastEvaluatedKey
is not empty, it does
not necessarily mean that there is more data in the result set. The only
way to know when you have reached the end of the result set is when
LastEvaluatedKey
is empty.
ExecuteStatement
, executeStatementResponse_nextToken
- If the response of a read request exceeds the response payload limit
DynamoDB will set this value in the response. If set, you can use that
this value in the subsequent request to get the remaining results.
$sel:httpStatus:ExecuteStatementResponse'
, executeStatementResponse_httpStatus
- The response's http status code.
ExecuteTransaction
data ExecuteTransaction Source #
See: newExecuteTransaction
smart constructor.
Constructors
ExecuteTransaction' (Maybe Text) (Maybe ReturnConsumedCapacity) (NonEmpty ParameterizedStatement) |
Instances
newExecuteTransaction Source #
Arguments
:: NonEmpty ParameterizedStatement | |
-> ExecuteTransaction |
Create a value of ExecuteTransaction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:ExecuteTransaction'
, executeTransaction_clientRequestToken
- Set this value to get remaining results, if NextToken
was returned in
the statement response.
$sel:returnConsumedCapacity:ExecuteTransaction'
, executeTransaction_returnConsumedCapacity
- Determines the level of detail about either provisioned or on-demand
throughput consumption that is returned in the response. For more
information, see
TransactGetItems
and
TransactWriteItems.
$sel:transactStatements:ExecuteTransaction'
, executeTransaction_transactStatements
- The list of PartiQL statements representing the transaction to run.
data ExecuteTransactionResponse Source #
See: newExecuteTransactionResponse
smart constructor.
Constructors
ExecuteTransactionResponse' (Maybe [ConsumedCapacity]) (Maybe (NonEmpty ItemResponse)) Int |
Instances
newExecuteTransactionResponse Source #
Create a value of ExecuteTransactionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:ExecuteTransactionResponse'
, executeTransactionResponse_consumedCapacity
- The capacity units consumed by the entire operation. The values of the
list are ordered according to the ordering of the statements.
$sel:responses:ExecuteTransactionResponse'
, executeTransactionResponse_responses
- The response to a PartiQL transaction.
$sel:httpStatus:ExecuteTransactionResponse'
, executeTransactionResponse_httpStatus
- The response's http status code.
ExportTableToPointInTime
data ExportTableToPointInTime Source #
See: newExportTableToPointInTime
smart constructor.
Constructors
ExportTableToPointInTime' (Maybe Text) (Maybe ExportFormat) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe S3SseAlgorithm) (Maybe Text) Text Text |
Instances
newExportTableToPointInTime Source #
Create a value of ExportTableToPointInTime
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExportTableToPointInTime
, exportTableToPointInTime_clientToken
- Providing a ClientToken
makes the call to
ExportTableToPointInTimeInput
idempotent, meaning that multiple
identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other
parameters within the 8-hour idempotency window, DynamoDB returns an
ImportConflictException
.
ExportTableToPointInTime
, exportTableToPointInTime_exportFormat
- The format for the exported data. Valid values for ExportFormat
are
DYNAMODB_JSON
or ION
.
ExportTableToPointInTime
, exportTableToPointInTime_exportTime
- Time in the past from which to export table data, counted in seconds
from the start of the Unix epoch. The table export will be a snapshot of
the table's state at this point in time.
ExportTableToPointInTime
, exportTableToPointInTime_s3BucketOwner
- The ID of the Amazon Web Services account that owns the bucket the
export will be stored in.
ExportTableToPointInTime
, exportTableToPointInTime_s3Prefix
- The Amazon S3 bucket prefix to use as the file name and path of the
exported snapshot.
ExportTableToPointInTime
, exportTableToPointInTime_s3SseAlgorithm
- Type of encryption used on the bucket where export data will be stored.
Valid values for S3SseAlgorithm
are:
AES256
- server-side encryption with Amazon S3 managed keysKMS
- server-side encryption with KMS managed keys
ExportTableToPointInTime
, exportTableToPointInTime_s3SseKmsKeyId
- The ID of the KMS managed key used to encrypt the S3 bucket where export
data will be stored (if applicable).
ExportTableToPointInTime
, exportTableToPointInTime_tableArn
- The Amazon Resource Name (ARN) associated with the table to export.
ExportTableToPointInTime
, exportTableToPointInTime_s3Bucket
- The name of the Amazon S3 bucket to export the snapshot to.
data ExportTableToPointInTimeResponse Source #
See: newExportTableToPointInTimeResponse
smart constructor.
Constructors
ExportTableToPointInTimeResponse' (Maybe ExportDescription) Int |
Instances
newExportTableToPointInTimeResponse Source #
Create a value of ExportTableToPointInTimeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportDescription:ExportTableToPointInTimeResponse'
, exportTableToPointInTimeResponse_exportDescription
- Contains a description of the table export.
$sel:httpStatus:ExportTableToPointInTimeResponse'
, exportTableToPointInTimeResponse_httpStatus
- The response's http status code.
GetItem
Represents the input of a GetItem
operation.
See: newGetItem
smart constructor.
Constructors
GetItem' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe ReturnConsumedCapacity) Text (HashMap Text AttributeValue) |
Instances
Create a value of GetItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetItem
, getItem_attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more
information, see
AttributesToGet
in the Amazon DynamoDB Developer Guide.
GetItem
, getItem_consistentRead
- Determines the read consistency model: If set to true
, then the
operation uses strongly consistent reads; otherwise, the operation uses
eventually consistent reads.
GetItem
, getItem_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
GetItem
, getItem_projectionExpression
- 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 expression must be separated by commas.
If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:GetItem'
, getItem_returnConsumedCapacity
- Undocumented member.
GetItem
, getItem_tableName
- The name of the table containing the requested item.
GetItem
, getItem_key
- A map of attribute names to AttributeValue
objects, representing the
primary key of the item to retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
data GetItemResponse Source #
Represents the output of a GetItem
operation.
See: newGetItemResponse
smart constructor.
Constructors
GetItemResponse' (Maybe ConsumedCapacity) (Maybe (HashMap Text AttributeValue)) Int |
Instances
Arguments
:: Int | |
-> GetItemResponse |
Create a value of GetItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:GetItemResponse'
, getItemResponse_consumedCapacity
- The capacity units consumed by the GetItem
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Read/Write Capacity Mode
in the Amazon DynamoDB Developer Guide.
GetItemResponse
, getItemResponse_item
- A map of attribute names to AttributeValue
objects, as specified by
ProjectionExpression
.
$sel:httpStatus:GetItemResponse'
, getItemResponse_httpStatus
- The response's http status code.
ImportTable
data ImportTable Source #
See: newImportTable
smart constructor.
Constructors
ImportTable' (Maybe Text) (Maybe InputCompressionType) (Maybe InputFormatOptions) S3BucketSource InputFormat TableCreationParameters |
Instances
Arguments
:: S3BucketSource | |
-> InputFormat | |
-> TableCreationParameters | |
-> ImportTable |
Create a value of ImportTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ImportTable
, importTable_clientToken
- Providing a ClientToken
makes the call to ImportTableInput
idempotent, meaning that multiple identical calls have the same effect
as one single call.
A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other
parameters within the 8-hour idempotency window, DynamoDB returns an
IdempotentParameterMismatch
exception.
ImportTable
, importTable_inputCompressionType
- Type of compression to be used on the input coming from the imported
table.
ImportTable
, importTable_inputFormatOptions
- Additional properties that specify how the input is formatted,
ImportTable
, importTable_s3BucketSource
- The S3 bucket that provides the source for the import.
ImportTable
, importTable_inputFormat
- The format of the source data. Valid values for ImportFormat
are
CSV
, DYNAMODB_JSON
or ION
.
ImportTable
, importTable_tableCreationParameters
- Parameters for the table to import the data into.
data ImportTableResponse Source #
See: newImportTableResponse
smart constructor.
Constructors
ImportTableResponse' Int ImportTableDescription |
Instances
newImportTableResponse Source #
Arguments
:: Int | |
-> ImportTableDescription | |
-> ImportTableResponse |
Create a value of ImportTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ImportTableResponse'
, importTableResponse_httpStatus
- The response's http status code.
$sel:importTableDescription:ImportTableResponse'
, importTableResponse_importTableDescription
- Represents the properties of the table created for the import, and
parameters of the import. The import parameters include import status,
how many items were processed, and how many errors were encountered.
ListBackups (Paginated)
data ListBackups Source #
See: newListBackups
smart constructor.
Constructors
ListBackups' (Maybe BackupTypeFilter) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newListBackups :: ListBackups Source #
Create a value of ListBackups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBackups
, listBackups_backupType
- The backups from the table specified by BackupType
are listed.
Where BackupType
can be:
USER
- On-demand backup created by you. (The default setting if no other backup types are specified.)SYSTEM
- On-demand backup automatically created by DynamoDB.ALL
- All types of on-demand backups (USER and SYSTEM).
$sel:exclusiveStartBackupArn:ListBackups'
, listBackups_exclusiveStartBackupArn
- LastEvaluatedBackupArn
is the Amazon Resource Name (ARN) of the backup
last evaluated when the current page of results was returned, inclusive
of the current page of results. This value may be specified as the
ExclusiveStartBackupArn
of a new ListBackups
operation in order to
fetch the next page of results.
$sel:limit:ListBackups'
, listBackups_limit
- Maximum number of backups to return at once.
ListBackups
, listBackups_tableName
- The backups from the table specified by TableName
are listed.
$sel:timeRangeLowerBound:ListBackups'
, listBackups_timeRangeLowerBound
- Only backups created after this time are listed. TimeRangeLowerBound
is inclusive.
$sel:timeRangeUpperBound:ListBackups'
, listBackups_timeRangeUpperBound
- Only backups created before this time are listed. TimeRangeUpperBound
is exclusive.
data ListBackupsResponse Source #
See: newListBackupsResponse
smart constructor.
Constructors
ListBackupsResponse' (Maybe [BackupSummary]) (Maybe Text) Int |
Instances
newListBackupsResponse Source #
Arguments
:: Int | |
-> ListBackupsResponse |
Create a value of ListBackupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupSummaries:ListBackupsResponse'
, listBackupsResponse_backupSummaries
- List of BackupSummary
objects.
$sel:lastEvaluatedBackupArn:ListBackupsResponse'
, listBackupsResponse_lastEvaluatedBackupArn
- The ARN of the backup last evaluated when the current page of results
was returned, inclusive of the current page of results. This value may
be specified as the ExclusiveStartBackupArn
of a new ListBackups
operation in order to fetch the next page of results.
If LastEvaluatedBackupArn
is empty, then the last page of results has
been processed and there are no more results to be retrieved.
If LastEvaluatedBackupArn
is not empty, this may or may not indicate
that there is more data to be returned. All results are guaranteed to
have been returned if and only if no value for LastEvaluatedBackupArn
is returned.
$sel:httpStatus:ListBackupsResponse'
, listBackupsResponse_httpStatus
- The response's http status code.
ListContributorInsights
data ListContributorInsights Source #
See: newListContributorInsights
smart constructor.
Instances
newListContributorInsights :: ListContributorInsights Source #
Create a value of ListContributorInsights
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListContributorInsights'
, listContributorInsights_maxResults
- Maximum number of results to return per page.
ListContributorInsights
, listContributorInsights_nextToken
- A token to for the desired page, if there is one.
ListContributorInsights
, listContributorInsights_tableName
- The name of the table.
data ListContributorInsightsResponse Source #
See: newListContributorInsightsResponse
smart constructor.
Constructors
ListContributorInsightsResponse' (Maybe [ContributorInsightsSummary]) (Maybe Text) Int |
Instances
newListContributorInsightsResponse Source #
Create a value of ListContributorInsightsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contributorInsightsSummaries:ListContributorInsightsResponse'
, listContributorInsightsResponse_contributorInsightsSummaries
- A list of ContributorInsightsSummary.
ListContributorInsights
, listContributorInsightsResponse_nextToken
- A token to go to the next page if there is one.
$sel:httpStatus:ListContributorInsightsResponse'
, listContributorInsightsResponse_httpStatus
- The response's http status code.
ListExports
data ListExports Source #
See: newListExports
smart constructor.
Instances
newListExports :: ListExports Source #
Create a value of ListExports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListExports'
, listExports_maxResults
- Maximum number of results to return per page.
ListExports
, listExports_nextToken
- An optional string that, if supplied, must be copied from the output of
a previous call to ListExports
. When provided in this manner, the API
fetches the next page of results.
ListExports
, listExports_tableArn
- The Amazon Resource Name (ARN) associated with the exported table.
data ListExportsResponse Source #
See: newListExportsResponse
smart constructor.
Constructors
ListExportsResponse' (Maybe [ExportSummary]) (Maybe Text) Int |
Instances
newListExportsResponse Source #
Arguments
:: Int | |
-> ListExportsResponse |
Create a value of ListExportsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportSummaries:ListExportsResponse'
, listExportsResponse_exportSummaries
- A list of ExportSummary
objects.
ListExports
, listExportsResponse_nextToken
- If this value is returned, there are additional results to be displayed.
To retrieve them, call ListExports
again, with NextToken
set to this
value.
$sel:httpStatus:ListExportsResponse'
, listExportsResponse_httpStatus
- The response's http status code.
ListGlobalTables
data ListGlobalTables Source #
See: newListGlobalTables
smart constructor.
Instances
newListGlobalTables :: ListGlobalTables Source #
Create a value of ListGlobalTables
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartGlobalTableName:ListGlobalTables'
, listGlobalTables_exclusiveStartGlobalTableName
- The first global table name that this operation will evaluate.
$sel:limit:ListGlobalTables'
, listGlobalTables_limit
- The maximum number of table names to return, if the parameter is not
specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it
stops the operation and returns the table names collected up to that
point, with a table name in the LastEvaluatedGlobalTableName
to apply
in a subsequent operation to the ExclusiveStartGlobalTableName
parameter.
ListGlobalTables
, listGlobalTables_regionName
- Lists the global tables in a specific Region.
data ListGlobalTablesResponse Source #
See: newListGlobalTablesResponse
smart constructor.
Constructors
ListGlobalTablesResponse' (Maybe [GlobalTable]) (Maybe Text) Int |
Instances
newListGlobalTablesResponse Source #
Create a value of ListGlobalTablesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTables:ListGlobalTablesResponse'
, listGlobalTablesResponse_globalTables
- List of global table names.
$sel:lastEvaluatedGlobalTableName:ListGlobalTablesResponse'
, listGlobalTablesResponse_lastEvaluatedGlobalTableName
- Last evaluated global table name.
$sel:httpStatus:ListGlobalTablesResponse'
, listGlobalTablesResponse_httpStatus
- The response's http status code.
ListImports
data ListImports Source #
See: newListImports
smart constructor.
Instances
newListImports :: ListImports Source #
Create a value of ListImports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListImports
, listImports_nextToken
- An optional string that, if supplied, must be copied from the output of
a previous call to ListImports
. When provided in this manner, the API
fetches the next page of results.
$sel:pageSize:ListImports'
, listImports_pageSize
- The number of ImportSummary
objects returned in a single page.
ListImports
, listImports_tableArn
- The Amazon Resource Name (ARN) associated with the table that was
imported to.
data ListImportsResponse Source #
See: newListImportsResponse
smart constructor.
Constructors
ListImportsResponse' (Maybe [ImportSummary]) (Maybe Text) Int |
Instances
newListImportsResponse Source #
Arguments
:: Int | |
-> ListImportsResponse |
Create a value of ListImportsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:importSummaryList:ListImportsResponse'
, listImportsResponse_importSummaryList
- A list of ImportSummary
objects.
ListImports
, listImportsResponse_nextToken
- If this value is returned, there are additional results to be displayed.
To retrieve them, call ListImports
again, with NextToken
set to this
value.
$sel:httpStatus:ListImportsResponse'
, listImportsResponse_httpStatus
- The response's http status code.
ListTables (Paginated)
data ListTables Source #
Represents the input of a ListTables
operation.
See: newListTables
smart constructor.
Constructors
ListTables' (Maybe Text) (Maybe Natural) |
Instances
newListTables :: ListTables Source #
Create a value of ListTables
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exclusiveStartTableName:ListTables'
, listTables_exclusiveStartTableName
- The first table name that this operation will evaluate. Use the value
that was returned for LastEvaluatedTableName
in a previous operation,
so that you can obtain the next page of results.
$sel:limit:ListTables'
, listTables_limit
- A maximum number of table names to return. If this parameter is not
specified, the limit is 100.
data ListTablesResponse Source #
Represents the output of a ListTables
operation.
See: newListTablesResponse
smart constructor.
Instances
newListTablesResponse Source #
Arguments
:: Int | |
-> ListTablesResponse |
Create a value of ListTablesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastEvaluatedTableName:ListTablesResponse'
, listTablesResponse_lastEvaluatedTableName
- The name of the last table in the current page of results. Use this
value as the ExclusiveStartTableName
in a new request to obtain the
next page of results, until all the table names are returned.
If you do not receive a LastEvaluatedTableName
value in the response,
this means that there are no more table names to be retrieved.
$sel:tableNames:ListTablesResponse'
, listTablesResponse_tableNames
- The names of the tables associated with the current account at the
current endpoint. The maximum size of this array is 100.
If LastEvaluatedTableName
also appears in the output, you can use this
value as the ExclusiveStartTableName
parameter in a subsequent
ListTables
request and obtain the next page of results.
$sel:httpStatus:ListTablesResponse'
, listTablesResponse_httpStatus
- The response's http status code.
ListTagsOfResource (Paginated)
data ListTagsOfResource Source #
See: newListTagsOfResource
smart constructor.
Constructors
ListTagsOfResource' (Maybe Text) Text |
Instances
newListTagsOfResource Source #
Arguments
:: Text | |
-> ListTagsOfResource |
Create a value of ListTagsOfResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsOfResource
, listTagsOfResource_nextToken
- An optional string that, if supplied, must be copied from the output of
a previous call to ListTagOfResource. When provided in this manner, this
API fetches the next page of results.
$sel:resourceArn:ListTagsOfResource'
, listTagsOfResource_resourceArn
- The Amazon DynamoDB resource with tags to be listed. This value is an
Amazon Resource Name (ARN).
data ListTagsOfResourceResponse Source #
See: newListTagsOfResourceResponse
smart constructor.
Instances
newListTagsOfResourceResponse Source #
Create a value of ListTagsOfResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsOfResource
, listTagsOfResourceResponse_nextToken
- If this value is returned, there are additional results to be displayed.
To retrieve them, call ListTagsOfResource again, with NextToken set to
this value.
$sel:tags:ListTagsOfResourceResponse'
, listTagsOfResourceResponse_tags
- The tags currently associated with the Amazon DynamoDB resource.
$sel:httpStatus:ListTagsOfResourceResponse'
, listTagsOfResourceResponse_httpStatus
- The response's http status code.
PutItem
Represents the input of a PutItem
operation.
See: newPutItem
smart constructor.
Constructors
Instances
Create a value of PutItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutItem
, putItem_conditionExpression
- A condition that must be satisfied in order for a conditional PutItem
operation to succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
- Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
- Logical operators:
AND | OR | NOT
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:conditionalOperator:PutItem'
, putItem_conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
ConditionalOperator
in the Amazon DynamoDB Developer Guide.
$sel:expected:PutItem'
, putItem_expected
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
Expected
in the Amazon DynamoDB Developer Guide.
PutItem
, putItem_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
PutItem
, putItem_expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:PutItem'
, putItem_returnConsumedCapacity
- Undocumented member.
$sel:returnItemCollectionMetrics:PutItem'
, putItem_returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any,
that were modified during the operation are returned in the response. If
set to NONE
(the default), no statistics are returned.
$sel:returnValues:PutItem'
, putItem_returnValues
- Use ReturnValues
if you want to get the item attributes as they
appeared before they were updated with the PutItem
request. For
PutItem
, the valid values are:
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.)ALL_OLD
- IfPutItem
overwrote an attribute name-value pair, then the content of the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The ReturnValues
parameter is used by several DynamoDB operations;
however, PutItem
does not recognize any values other than NONE
or
ALL_OLD
.
PutItem
, putItem_tableName
- The name of the table to contain the item.
PutItem
, putItem_item
- A map of attribute name/value pairs, one for each attribute. Only the
primary key attributes are required; you can optionally provide other
attribute name-value pairs for the item.
You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item
map is an AttributeValue
object.
data PutItemResponse Source #
Represents the output of a PutItem
operation.
See: newPutItemResponse
smart constructor.
Constructors
PutItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int |
Instances
Arguments
:: Int | |
-> PutItemResponse |
Create a value of PutItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:PutItemResponse'
, putItemResponse_attributes
- The attribute values as they appeared before the PutItem
operation,
but only if ReturnValues
is specified as ALL_OLD
in the request.
Each element consists of an attribute name and an attribute value.
$sel:consumedCapacity:PutItemResponse'
, putItemResponse_consumedCapacity
- The capacity units consumed by the PutItem
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Read/Write Capacity Mode
in the Amazon DynamoDB Developer Guide.
$sel:itemCollectionMetrics:PutItemResponse'
, putItemResponse_itemCollectionMetrics
- Information about item collections, if any, that were affected by the
PutItem
operation. ItemCollectionMetrics
is only returned if the
ReturnItemCollectionMetrics
parameter was specified. If the table does
not have any local secondary indexes, this information is not returned
in the response.
Each ItemCollectionMetrics
element consists of:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself.SizeEstimateRangeGB
- 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.
$sel:httpStatus:PutItemResponse'
, putItemResponse_httpStatus
- The response's http status code.
Query (Paginated)
Represents the input of a Query
operation.
See: newQuery
smart constructor.
Constructors
Query' (Maybe (NonEmpty Text)) (Maybe ConditionalOperator) (Maybe Bool) (Maybe (HashMap Text AttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Condition)) (Maybe Natural) (Maybe Text) (Maybe (HashMap Text Condition)) (Maybe ReturnConsumedCapacity) (Maybe Bool) (Maybe Select) Text |
Instances
Create a value of Query
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Query
, query_attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more
information, see
AttributesToGet
in the Amazon DynamoDB Developer Guide.
$sel:conditionalOperator:Query'
, query_conditionalOperator
- This is a legacy parameter. Use FilterExpression
instead. For more
information, see
ConditionalOperator
in the Amazon DynamoDB Developer Guide.
Query
, query_consistentRead
- Determines the read consistency model: If set to true
, then the
operation uses strongly consistent reads; otherwise, the operation uses
eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes.
If you query a global secondary index with ConsistentRead
set to
true
, you will receive a ValidationException
.
$sel:exclusiveStartKey:Query'
, query_exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use
the value that was returned for LastEvaluatedKey
in the previous
operation.
The data type for ExclusiveStartKey
must be String, Number, or Binary.
No set data types are allowed.
Query
, query_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Query
, query_expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
$sel:filterExpression:Query'
, query_filterExpression
- A string that contains conditions that DynamoDB applies after the
Query
operation, but before the data is returned to you. Items that do
not satisfy the FilterExpression
criteria are not returned.
A FilterExpression
does not allow key attributes. You cannot define a
filter expression based on a partition key or a sort key.
A FilterExpression
is applied after the items have already been read;
the process of filtering does not consume any additional read capacity
units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
Query
, query_indexName
- The name of an index to query. This index can be any local secondary
index or global secondary index on the table. Note that if you use the
IndexName
parameter, you must also provide TableName.
$sel:keyConditionExpression:Query'
, query_keyConditionExpression
- The condition that specifies the key values for items to be retrieved by
the Query
action.
The condition must perform an equality test on a single partition key value.
The condition can optionally perform one of several comparison tests on
a single sort key value. This allows Query
to retrieve one item with a
given partition key value and sort key value, or several items that have
the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be
combined using AND
with the condition for the sort key. Following is
an example, using the = comparison operator for the sort key:
partitionKeyName
=
:partitionkeyval
AND
sortKeyName
=
:sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
=
:sortkeyval
- true if the sort key value is equal to:sortkeyval
.sortKeyName
<
:sortkeyval
- true if the sort key value is less than:sortkeyval
.sortKeyName
<=
:sortkeyval
- true if the sort key value is less than or equal to:sortkeyval
.sortKeyName
>
:sortkeyval
- true if the sort key value is greater than:sortkeyval
.sortKeyName
>=
:sortkeyval
- true if the sort key value is greater than or equal to:sortkeyval
.sortKeyName
BETWEEN
:sortkeyval1
AND
:sortkeyval2
- true if the sort key value is greater than or equal to:sortkeyval1
, and less than or equal to:sortkeyval2
.begins_with (
sortKeyName
,:sortkeyval
)
- true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function namebegins_with
is case-sensitive.
Use the ExpressionAttributeValues
parameter to replace tokens such as
:partitionval
and :sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames
parameter to
replace the names of the partition key and sort key with placeholder
tokens. This option might be necessary if an attribute name conflicts
with a DynamoDB reserved word. For example, the following
KeyConditionExpression
parameter causes an error because Size is a
reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the
attribute name Size. KeyConditionExpression
then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames
and
ExpressionAttributeValues
, see
Using Placeholders for Attribute Names and Values
in the Amazon DynamoDB Developer Guide.
$sel:keyConditions:Query'
, query_keyConditions
- This is a legacy parameter. Use KeyConditionExpression
instead. For
more information, see
KeyConditions
in the Amazon DynamoDB Developer Guide.
$sel:limit:Query'
, query_limit
- The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in LastEvaluatedKey
to
apply in a subsequent operation, so that you can pick up where you left
off. Also, if the processed dataset size exceeds 1 MB before DynamoDB
reaches this limit, it stops the operation and returns the matching
values up to the limit, and a key in LastEvaluatedKey
to apply in a
subsequent operation to continue the operation. For more information,
see
Query and Scan
in the Amazon DynamoDB Developer Guide.
Query
, query_projectionExpression
- 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 expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
$sel:queryFilter:Query'
, query_queryFilter
- This is a legacy parameter. Use FilterExpression
instead. For more
information, see
QueryFilter
in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:Query'
, query_returnConsumedCapacity
- Undocumented member.
$sel:scanIndexForward:Query'
, query_scanIndexForward
- Specifies the order for index traversal: If true
(default), the
traversal is performed in ascending order; if false
, the traversal is
performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward
is true
, DynamoDB returns the results in the
order in which they are stored (by sort key value). This is the default
behavior. If ScanIndexForward
is false
, DynamoDB reads the results
in reverse order by sort key value, and then returns the results to the
client.
$sel:select:Query'
, query_select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, the count of matching items, or in
the case of an index, some or all of the attributes projected into the
index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
.COUNT
- Returns the number of matching items, rather than the matching items themselves.SPECIFIC_ATTRIBUTES
- Returns only the attributes listed inProjectionExpression
. This return value is equivalent to specifyingProjectionExpression
without specifying any value forSelect
.If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select
nor ProjectionExpression
are specified, DynamoDB
defaults to ALL_ATTRIBUTES
when accessing a table, and
ALL_PROJECTED_ATTRIBUTES
when accessing an index. You cannot use both
Select
and ProjectionExpression
together in a single request, unless
the value for Select
is SPECIFIC_ATTRIBUTES
. (This usage is
equivalent to specifying ProjectionExpression
without any value for
Select
.)
If you use the ProjectionExpression
parameter, then the value for
Select
can only be SPECIFIC_ATTRIBUTES
. Any other value for Select
will return an error.
Query
, query_tableName
- The name of the table containing the requested items.
data QueryResponse Source #
Represents the output of a Query
operation.
See: newQueryResponse
smart constructor.
Constructors
QueryResponse' (Maybe ConsumedCapacity) (Maybe Int) (Maybe (HashMap Text AttributeValue)) (Maybe Int) Int [HashMap Text AttributeValue] |
Instances
Arguments
:: Int | |
-> QueryResponse |
Create a value of QueryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:QueryResponse'
, queryResponse_consumedCapacity
- The capacity units consumed by the Query
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Provisioned Throughput
in the Amazon DynamoDB Developer Guide.
$sel:count:QueryResponse'
, queryResponse_count
- The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number
of items returned after the filter was applied, and ScannedCount
is
the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count
and
ScannedCount
are the same.
$sel:lastEvaluatedKey:QueryResponse'
, queryResponse_lastEvaluatedKey
- The primary key of the item where the operation stopped, inclusive of
the previous result set. Use this value to start a new operation,
excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has
been processed and there is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that
there is more data in the result set. The only way to know when you have
reached the end of the result set is when LastEvaluatedKey
is empty.
$sel:scannedCount:QueryResponse'
, queryResponse_scannedCount
- The number of items evaluated, before any QueryFilter
is applied. A
high ScannedCount
value with few, or no, Count
results indicates an
inefficient Query
operation. For more information, see
Count and ScannedCount
in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the
same as Count
.
$sel:httpStatus:QueryResponse'
, queryResponse_httpStatus
- The response's http status code.
$sel:items:QueryResponse'
, queryResponse_items
- An array of item attributes that match the query criteria. Each element
in this array consists of an attribute name and the value for that
attribute.
RestoreTableFromBackup
data RestoreTableFromBackup Source #
See: newRestoreTableFromBackup
smart constructor.
Constructors
RestoreTableFromBackup' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe [LocalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe SSESpecification) Text Text |
Instances
newRestoreTableFromBackup Source #
Arguments
:: Text | |
-> Text | |
-> RestoreTableFromBackup |
Create a value of RestoreTableFromBackup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billingModeOverride:RestoreTableFromBackup'
, restoreTableFromBackup_billingModeOverride
- The billing mode of the restored table.
$sel:globalSecondaryIndexOverride:RestoreTableFromBackup'
, restoreTableFromBackup_globalSecondaryIndexOverride
- List of global secondary indexes for the restored table. The indexes
provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
$sel:localSecondaryIndexOverride:RestoreTableFromBackup'
, restoreTableFromBackup_localSecondaryIndexOverride
- List of local secondary indexes for the restored table. The indexes
provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
RestoreTableFromBackup
, restoreTableFromBackup_provisionedThroughputOverride
- Provisioned throughput settings for the restored table.
$sel:sSESpecificationOverride:RestoreTableFromBackup'
, restoreTableFromBackup_sSESpecificationOverride
- The new server-side encryption settings for the restored table.
$sel:targetTableName:RestoreTableFromBackup'
, restoreTableFromBackup_targetTableName
- The name of the new table to which the backup must be restored.
RestoreTableFromBackup
, restoreTableFromBackup_backupArn
- The Amazon Resource Name (ARN) associated with the backup.
data RestoreTableFromBackupResponse Source #
See: newRestoreTableFromBackupResponse
smart constructor.
Constructors
RestoreTableFromBackupResponse' (Maybe TableDescription) Int |
Instances
newRestoreTableFromBackupResponse Source #
Create a value of RestoreTableFromBackupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableDescription:RestoreTableFromBackupResponse'
, restoreTableFromBackupResponse_tableDescription
- The description of the table created from an existing backup.
$sel:httpStatus:RestoreTableFromBackupResponse'
, restoreTableFromBackupResponse_httpStatus
- The response's http status code.
RestoreTableToPointInTime
data RestoreTableToPointInTime Source #
See: newRestoreTableToPointInTime
smart constructor.
Constructors
Instances
newRestoreTableToPointInTime Source #
Create a value of RestoreTableToPointInTime
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billingModeOverride:RestoreTableToPointInTime'
, restoreTableToPointInTime_billingModeOverride
- The billing mode of the restored table.
$sel:globalSecondaryIndexOverride:RestoreTableToPointInTime'
, restoreTableToPointInTime_globalSecondaryIndexOverride
- List of global secondary indexes for the restored table. The indexes
provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
$sel:localSecondaryIndexOverride:RestoreTableToPointInTime'
, restoreTableToPointInTime_localSecondaryIndexOverride
- List of local secondary indexes for the restored table. The indexes
provided should match existing secondary indexes. You can choose to
exclude some or all of the indexes at the time of restore.
RestoreTableToPointInTime
, restoreTableToPointInTime_provisionedThroughputOverride
- Provisioned throughput settings for the restored table.
RestoreTableToPointInTime
, restoreTableToPointInTime_restoreDateTime
- Time in the past to restore the table to.
$sel:sSESpecificationOverride:RestoreTableToPointInTime'
, restoreTableToPointInTime_sSESpecificationOverride
- The new server-side encryption settings for the restored table.
RestoreTableToPointInTime
, restoreTableToPointInTime_sourceTableArn
- The DynamoDB table that will be restored. This value is an Amazon
Resource Name (ARN).
$sel:sourceTableName:RestoreTableToPointInTime'
, restoreTableToPointInTime_sourceTableName
- Name of the source table that is being restored.
$sel:useLatestRestorableTime:RestoreTableToPointInTime'
, restoreTableToPointInTime_useLatestRestorableTime
- Restore the table to the latest possible time.
LatestRestorableDateTime
is typically 5 minutes before the current
time.
$sel:targetTableName:RestoreTableToPointInTime'
, restoreTableToPointInTime_targetTableName
- The name of the new table to which it must be restored to.
data RestoreTableToPointInTimeResponse Source #
See: newRestoreTableToPointInTimeResponse
smart constructor.
Constructors
RestoreTableToPointInTimeResponse' (Maybe TableDescription) Int |
Instances
newRestoreTableToPointInTimeResponse Source #
Arguments
:: Int | |
-> RestoreTableToPointInTimeResponse |
Create a value of RestoreTableToPointInTimeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableDescription:RestoreTableToPointInTimeResponse'
, restoreTableToPointInTimeResponse_tableDescription
- Represents the properties of a table.
$sel:httpStatus:RestoreTableToPointInTimeResponse'
, restoreTableToPointInTimeResponse_httpStatus
- The response's http status code.
Scan (Paginated)
Represents the input of a Scan
operation.
See: newScan
smart constructor.
Constructors
Scan' (Maybe (NonEmpty Text)) (Maybe ConditionalOperator) (Maybe Bool) (Maybe (HashMap Text AttributeValue)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe ReturnConsumedCapacity) (Maybe (HashMap Text Condition)) (Maybe Natural) (Maybe Select) (Maybe Natural) Text |
Instances
Create a value of Scan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Scan
, scan_attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more
information, see
AttributesToGet
in the Amazon DynamoDB Developer Guide.
$sel:conditionalOperator:Scan'
, scan_conditionalOperator
- This is a legacy parameter. Use FilterExpression
instead. For more
information, see
ConditionalOperator
in the Amazon DynamoDB Developer Guide.
Scan
, scan_consistentRead
- A Boolean value that determines the read consistency model during the
scan:
- If
ConsistentRead
isfalse
, then the data returned fromScan
might not contain the results from other recently completed write operations (PutItem
,UpdateItem
, orDeleteItem
). - If
ConsistentRead
istrue
, then all of the write operations that completed before theScan
began are guaranteed to be contained in theScan
response.
The default setting for ConsistentRead
is false
.
The ConsistentRead
parameter is not supported on global secondary
indexes. If you scan a global secondary index with ConsistentRead
set
to true, you will receive a ValidationException
.
$sel:exclusiveStartKey:Scan'
, scan_exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use
the value that was returned for LastEvaluatedKey
in the previous
operation.
The data type for ExclusiveStartKey
must be String, Number or Binary.
No set data types are allowed.
In a parallel scan, a Scan
request that includes ExclusiveStartKey
must specify the same segment whose previous Scan
returned the
corresponding value of LastEvaluatedKey
.
Scan
, scan_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
Scan
, scan_expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an
attribute value. For example, suppose that you wanted to check whether
the value of the ProductStatus
attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:filterExpression:Scan'
, scan_filterExpression
- A string that contains conditions that DynamoDB applies after the Scan
operation, but before the data is returned to you. Items that do not
satisfy the FilterExpression
criteria are not returned.
A FilterExpression
is applied after the items have already been read;
the process of filtering does not consume any additional read capacity
units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
Scan
, scan_indexName
- The name of a secondary index to scan. This index can be any local
secondary index or global secondary index. Note that if you use the
IndexName
parameter, you must also provide TableName
.
$sel:limit:Scan'
, scan_limit
- The maximum number of items to evaluate (not necessarily the number of
matching items). If DynamoDB processes the number of items up to the
limit while processing the results, it stops the operation and returns
the matching values up to that point, and a key in LastEvaluatedKey
to
apply in a subsequent operation, so that you can pick up where you left
off. Also, if the processed dataset size exceeds 1 MB before DynamoDB
reaches this limit, it stops the operation and returns the matching
values up to the limit, and a key in LastEvaluatedKey
to apply in a
subsequent operation to continue the operation. For more information,
see
Working with Queries
in the Amazon DynamoDB Developer Guide.
Scan
, scan_projectionExpression
- A string that identifies one or more attributes to retrieve from the
specified table or index. These attributes can include scalars, sets, or
elements of a JSON document. The attributes in the expression must be
separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:Scan'
, scan_returnConsumedCapacity
- Undocumented member.
$sel:scanFilter:Scan'
, scan_scanFilter
- This is a legacy parameter. Use FilterExpression
instead. For more
information, see
ScanFilter
in the Amazon DynamoDB Developer Guide.
$sel:segment:Scan'
, scan_segment
- For a parallel Scan
request, Segment
identifies an individual
segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For
example, if you want to use four application threads to scan a table or
an index, then the first thread specifies a Segment
value of 0, the
second thread specifies 1, and so on.
The value of LastEvaluatedKey
returned from a parallel Scan
request
must be used as ExclusiveStartKey
with the same segment ID in a
subsequent Scan
operation.
The value for Segment
must be greater than or equal to 0, and less
than the value provided for TotalSegments
.
If you provide Segment
, you must also provide TotalSegments
.
$sel:select:Scan'
, scan_select
- The attributes to be returned in the result. You can retrieve all item
attributes, specific item attributes, the count of matching items, or in
the case of an index, some or all of the attributes projected into the
index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifyingALL_ATTRIBUTES
.COUNT
- Returns the number of matching items, rather than the matching items themselves.SPECIFIC_ATTRIBUTES
- Returns only the attributes listed inProjectionExpression
. This return value is equivalent to specifyingProjectionExpression
without specifying any value forSelect
.If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select
nor ProjectionExpression
are specified, DynamoDB
defaults to ALL_ATTRIBUTES
when accessing a table, and
ALL_PROJECTED_ATTRIBUTES
when accessing an index. You cannot use both
Select
and ProjectionExpression
together in a single request, unless
the value for Select
is SPECIFIC_ATTRIBUTES
. (This usage is
equivalent to specifying ProjectionExpression
without any value for
Select
.)
If you use the ProjectionExpression
parameter, then the value for
Select
can only be SPECIFIC_ATTRIBUTES
. Any other value for Select
will return an error.
$sel:totalSegments:Scan'
, scan_totalSegments
- For a parallel Scan
request, TotalSegments
represents the total
number of segments into which the Scan
operation will be divided. The
value of TotalSegments
corresponds to the number of application
workers that will perform the parallel scan. For example, if you want to
use four application threads to scan a table or an index, specify a
TotalSegments
value of 4.
The value for TotalSegments
must be greater than or equal to 1, and
less than or equal to 1000000. If you specify a TotalSegments
value of
1, the Scan
operation will be sequential rather than parallel.
If you specify TotalSegments
, you must also specify Segment
.
Scan
, scan_tableName
- The name of the table containing the requested items; or, if you provide
IndexName
, the name of the table to which that index belongs.
data ScanResponse Source #
Represents the output of a Scan
operation.
See: newScanResponse
smart constructor.
Constructors
ScanResponse' (Maybe ConsumedCapacity) (Maybe Int) (Maybe [HashMap Text AttributeValue]) (Maybe (HashMap Text AttributeValue)) (Maybe Int) Int |
Instances
Arguments
:: Int | |
-> ScanResponse |
Create a value of ScanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:ScanResponse'
, scanResponse_consumedCapacity
- The capacity units consumed by the Scan
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Provisioned Throughput
in the Amazon DynamoDB Developer Guide.
$sel:count:ScanResponse'
, scanResponse_count
- The number of items in the response.
If you set ScanFilter
in the request, then Count
is the number of
items returned after the filter was applied, and ScannedCount
is the
number of matching items before the filter was applied.
If you did not use a filter in the request, then Count
is the same as
ScannedCount
.
$sel:items:ScanResponse'
, scanResponse_items
- An array of item attributes that match the scan criteria. Each element
in this array consists of an attribute name and the value for that
attribute.
$sel:lastEvaluatedKey:ScanResponse'
, scanResponse_lastEvaluatedKey
- The primary key of the item where the operation stopped, inclusive of
the previous result set. Use this value to start a new operation,
excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has
been processed and there is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that
there is more data in the result set. The only way to know when you have
reached the end of the result set is when LastEvaluatedKey
is empty.
$sel:scannedCount:ScanResponse'
, scanResponse_scannedCount
- The number of items evaluated, before any ScanFilter
is applied. A
high ScannedCount
value with few, or no, Count
results indicates an
inefficient Scan
operation. For more information, see
Count and ScannedCount
in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the
same as Count
.
$sel:httpStatus:ScanResponse'
, scanResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- Identifies the Amazon DynamoDB resource to which tags should be added.
This value is an Amazon Resource Name (ARN).
$sel:tags:TagResource'
, tagResource_tags
- The tags to be assigned to the Amazon DynamoDB resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TransactGetItems
data TransactGetItems Source #
See: newTransactGetItems
smart constructor.
Constructors
TransactGetItems' (Maybe ReturnConsumedCapacity) (NonEmpty TransactGetItem) |
Instances
Create a value of TransactGetItems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:returnConsumedCapacity:TransactGetItems'
, transactGetItems_returnConsumedCapacity
- A value of TOTAL
causes consumed capacity information to be returned,
and a value of NONE
prevents that information from being returned. No
other value is valid.
$sel:transactItems:TransactGetItems'
, transactGetItems_transactItems
- An ordered array of up to 100 TransactGetItem
objects, each of which
contains a Get
structure.
data TransactGetItemsResponse Source #
See: newTransactGetItemsResponse
smart constructor.
Constructors
TransactGetItemsResponse' (Maybe [ConsumedCapacity]) (Maybe (NonEmpty ItemResponse)) Int |
Instances
newTransactGetItemsResponse Source #
Create a value of TransactGetItemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:TransactGetItemsResponse'
, transactGetItemsResponse_consumedCapacity
- If the ReturnConsumedCapacity value was TOTAL
, this is an array of
ConsumedCapacity
objects, one for each table addressed by
TransactGetItem
objects in the TransactItems parameter. These
ConsumedCapacity
objects report the read-capacity units consumed by
the TransactGetItems
call in that table.
$sel:responses:TransactGetItemsResponse'
, transactGetItemsResponse_responses
- An ordered array of up to 100 ItemResponse
objects, each of which
corresponds to the TransactGetItem
object in the same position in the
TransactItems array. Each ItemResponse
object contains a Map of the
name-value pairs that are the projected attributes of the requested
item.
If a requested item could not be retrieved, the corresponding
ItemResponse
object is Null, or if the requested item has no projected
attributes, the corresponding ItemResponse
object is an empty Map.
$sel:httpStatus:TransactGetItemsResponse'
, transactGetItemsResponse_httpStatus
- The response's http status code.
TransactWriteItems
data TransactWriteItems Source #
See: newTransactWriteItems
smart constructor.
Constructors
TransactWriteItems' (Maybe Text) (Maybe ReturnConsumedCapacity) (Maybe ReturnItemCollectionMetrics) (NonEmpty TransactWriteItem) |
Instances
newTransactWriteItems Source #
Create a value of TransactWriteItems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:TransactWriteItems'
, transactWriteItems_clientRequestToken
- Providing a ClientRequestToken
makes the call to TransactWriteItems
idempotent, meaning that multiple identical calls have the same effect
as one single call.
Although multiple identical calls using the same client request token
produce the same result on the server (no side effects), the responses
to the calls might not be the same. If the ReturnConsumedCapacity>
parameter is set, then the initial TransactWriteItems
call returns the
amount of write capacity units consumed in making the changes.
Subsequent TransactWriteItems
calls with the same client token return
the number of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.
If you submit a request with the same client token but a change in other
parameters within the 10-minute idempotency window, DynamoDB returns an
IdempotentParameterMismatch
exception.
$sel:returnConsumedCapacity:TransactWriteItems'
, transactWriteItems_returnConsumedCapacity
- Undocumented member.
$sel:returnItemCollectionMetrics:TransactWriteItems'
, transactWriteItems_returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections (if
any), that were modified during the operation and are returned in the
response. If set to NONE
(the default), no statistics are returned.
$sel:transactItems:TransactWriteItems'
, transactWriteItems_transactItems
- An ordered array of up to 100 TransactWriteItem
objects, each of which
contains a ConditionCheck
, Put
, Update
, or Delete
object. These
can operate on items in different tables, but the tables must reside in
the same Amazon Web Services account and Region, and no two of them can
operate on the same item.
data TransactWriteItemsResponse Source #
See: newTransactWriteItemsResponse
smart constructor.
Constructors
TransactWriteItemsResponse' (Maybe [ConsumedCapacity]) (Maybe (HashMap Text [ItemCollectionMetrics])) Int |
Instances
newTransactWriteItemsResponse Source #
Create a value of TransactWriteItemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consumedCapacity:TransactWriteItemsResponse'
, transactWriteItemsResponse_consumedCapacity
- The capacity units consumed by the entire TransactWriteItems
operation. The values of the list are ordered according to the ordering
of the TransactItems
request parameter.
$sel:itemCollectionMetrics:TransactWriteItemsResponse'
, transactWriteItemsResponse_itemCollectionMetrics
- A list of tables that were processed by TransactWriteItems
and, for
each table, information about any item collections that were affected by
individual UpdateItem
, PutItem
, or DeleteItem
operations.
$sel:httpStatus:TransactWriteItemsResponse'
, transactWriteItemsResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The DynamoDB resource that the tags will be removed from. This value is
an Amazon Resource Name (ARN).
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of tag keys. Existing tags of the resource whose keys are members
of this list will be removed from the DynamoDB resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateContinuousBackups
data UpdateContinuousBackups Source #
See: newUpdateContinuousBackups
smart constructor.
Instances
newUpdateContinuousBackups Source #
Arguments
:: Text | |
-> PointInTimeRecoverySpecification |
|
-> UpdateContinuousBackups |
Create a value of UpdateContinuousBackups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateContinuousBackups
, updateContinuousBackups_tableName
- The name of the table.
$sel:pointInTimeRecoverySpecification:UpdateContinuousBackups'
, updateContinuousBackups_pointInTimeRecoverySpecification
- Represents the settings used to enable point in time recovery.
data UpdateContinuousBackupsResponse Source #
See: newUpdateContinuousBackupsResponse
smart constructor.
Constructors
UpdateContinuousBackupsResponse' (Maybe ContinuousBackupsDescription) Int |
Instances
newUpdateContinuousBackupsResponse Source #
Create a value of UpdateContinuousBackupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:continuousBackupsDescription:UpdateContinuousBackupsResponse'
, updateContinuousBackupsResponse_continuousBackupsDescription
- Represents the continuous backups and point in time recovery settings on
the table.
$sel:httpStatus:UpdateContinuousBackupsResponse'
, updateContinuousBackupsResponse_httpStatus
- The response's http status code.
UpdateContributorInsights
data UpdateContributorInsights Source #
See: newUpdateContributorInsights
smart constructor.
Constructors
UpdateContributorInsights' (Maybe Text) Text ContributorInsightsAction |
Instances
newUpdateContributorInsights Source #
Arguments
:: Text | |
-> ContributorInsightsAction | |
-> UpdateContributorInsights |
Create a value of UpdateContributorInsights
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateContributorInsights
, updateContributorInsights_indexName
- The global secondary index name, if applicable.
UpdateContributorInsights
, updateContributorInsights_tableName
- The name of the table.
$sel:contributorInsightsAction:UpdateContributorInsights'
, updateContributorInsights_contributorInsightsAction
- Represents the contributor insights action.
data UpdateContributorInsightsResponse Source #
See: newUpdateContributorInsightsResponse
smart constructor.
Constructors
UpdateContributorInsightsResponse' (Maybe ContributorInsightsStatus) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateContributorInsightsResponse Source #
Arguments
:: Int | |
-> UpdateContributorInsightsResponse |
Create a value of UpdateContributorInsightsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateContributorInsightsResponse
, updateContributorInsightsResponse_contributorInsightsStatus
- The status of contributor insights
UpdateContributorInsights
, updateContributorInsightsResponse_indexName
- The name of the global secondary index, if applicable.
UpdateContributorInsights
, updateContributorInsightsResponse_tableName
- The name of the table.
$sel:httpStatus:UpdateContributorInsightsResponse'
, updateContributorInsightsResponse_httpStatus
- The response's http status code.
UpdateGlobalTable
data UpdateGlobalTable Source #
See: newUpdateGlobalTable
smart constructor.
Constructors
UpdateGlobalTable' Text [ReplicaUpdate] |
Instances
Arguments
:: Text | |
-> UpdateGlobalTable |
Create a value of UpdateGlobalTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateGlobalTable
, updateGlobalTable_globalTableName
- The global table name.
$sel:replicaUpdates:UpdateGlobalTable'
, updateGlobalTable_replicaUpdates
- A list of Regions that should be added or removed from the global table.
data UpdateGlobalTableResponse Source #
See: newUpdateGlobalTableResponse
smart constructor.
Constructors
UpdateGlobalTableResponse' (Maybe GlobalTableDescription) Int |
Instances
newUpdateGlobalTableResponse Source #
Create a value of UpdateGlobalTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTableDescription:UpdateGlobalTableResponse'
, updateGlobalTableResponse_globalTableDescription
- Contains the details of the global table.
$sel:httpStatus:UpdateGlobalTableResponse'
, updateGlobalTableResponse_httpStatus
- The response's http status code.
UpdateGlobalTableSettings
data UpdateGlobalTableSettings Source #
See: newUpdateGlobalTableSettings
smart constructor.
Constructors
Instances
newUpdateGlobalTableSettings Source #
Arguments
:: Text | |
-> UpdateGlobalTableSettings |
Create a value of UpdateGlobalTableSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTableBillingMode:UpdateGlobalTableSettings'
, updateGlobalTableSettings_globalTableBillingMode
- The billing mode of the global table. If GlobalTableBillingMode
is not
specified, the global table defaults to PROVISIONED
capacity billing
mode.
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
$sel:globalTableGlobalSecondaryIndexSettingsUpdate:UpdateGlobalTableSettings'
, updateGlobalTableSettings_globalTableGlobalSecondaryIndexSettingsUpdate
- Represents the settings of a global secondary index for a global table
that will be modified.
$sel:globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate:UpdateGlobalTableSettings'
, updateGlobalTableSettings_globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate
- Auto scaling settings for managing provisioned write capacity for the
global table.
$sel:globalTableProvisionedWriteCapacityUnits:UpdateGlobalTableSettings'
, updateGlobalTableSettings_globalTableProvisionedWriteCapacityUnits
- The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException.
$sel:replicaSettingsUpdate:UpdateGlobalTableSettings'
, updateGlobalTableSettings_replicaSettingsUpdate
- Represents the settings for a global table in a Region that will be
modified.
UpdateGlobalTableSettings
, updateGlobalTableSettings_globalTableName
- The name of the global table
data UpdateGlobalTableSettingsResponse Source #
See: newUpdateGlobalTableSettingsResponse
smart constructor.
Constructors
UpdateGlobalTableSettingsResponse' (Maybe Text) (Maybe [ReplicaSettingsDescription]) Int |
Instances
newUpdateGlobalTableSettingsResponse Source #
Arguments
:: Int | |
-> UpdateGlobalTableSettingsResponse |
Create a value of UpdateGlobalTableSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateGlobalTableSettings
, updateGlobalTableSettingsResponse_globalTableName
- The name of the global table.
$sel:replicaSettings:UpdateGlobalTableSettingsResponse'
, updateGlobalTableSettingsResponse_replicaSettings
- The Region-specific settings for the global table.
$sel:httpStatus:UpdateGlobalTableSettingsResponse'
, updateGlobalTableSettingsResponse_httpStatus
- The response's http status code.
UpdateItem
data UpdateItem Source #
Represents the input of an UpdateItem
operation.
See: newUpdateItem
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> UpdateItem |
Create a value of UpdateItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeUpdates:UpdateItem'
, updateItem_attributeUpdates
- This is a legacy parameter. Use UpdateExpression
instead. For more
information, see
AttributeUpdates
in the Amazon DynamoDB Developer Guide.
UpdateItem
, updateItem_conditionExpression
- A condition that must be satisfied in order for a conditional update to
succeed.
An expression can contain any of the following:
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
- Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
- Logical operators:
AND | OR | NOT
For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
$sel:conditionalOperator:UpdateItem'
, updateItem_conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
ConditionalOperator
in the Amazon DynamoDB Developer Guide.
$sel:expected:UpdateItem'
, updateItem_expected
- This is a legacy parameter. Use ConditionExpression
instead. For more
information, see
Expected
in the Amazon DynamoDB Developer Guide.
UpdateItem
, updateItem_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
UpdateItem
, updateItem_expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an
attribute value. For example, suppose that you wanted to check whether
the value of the ProductStatus
attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues
as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
$sel:returnConsumedCapacity:UpdateItem'
, updateItem_returnConsumedCapacity
- Undocumented member.
$sel:returnItemCollectionMetrics:UpdateItem'
, updateItem_returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any,
that were modified during the operation are returned in the response. If
set to NONE
(the default), no statistics are returned.
$sel:returnValues:UpdateItem'
, updateItem_returnValues
- Use ReturnValues
if you want to get the item attributes as they appear
before or after they are updated. For UpdateItem
, the valid values
are:
NONE
- IfReturnValues
is not specified, or if its value isNONE
, then nothing is returned. (This setting is the default forReturnValues
.)ALL_OLD
- Returns all of the attributes of the item, as they appeared before the UpdateItem operation.UPDATED_OLD
- Returns only the updated attributes, as they appeared before the UpdateItem operation.ALL_NEW
- Returns all of the attributes of the item, as they appear after the UpdateItem operation.UPDATED_NEW
- Returns only the updated attributes, as they appear after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
UpdateItem
, updateItem_updateExpression
- An expression that defines one or more attributes to be updated, the
action to be performed on them, and new values for them.
The following action values are available for UpdateExpression
.
SET
- Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_not_exists
evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.list_append (operand, operand)
- evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE
- Removes one or more attributes from an item.ADD
- Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior ofADD
depends on the data type of the attribute:If the existing attribute is a number, and if
Value
is also a number, thenValue
is mathematically added to the existing attribute. IfValue
is a negative number, then it is subtracted from the existing attribute.If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute nameditemcount
, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create theitemcount
attribute, set its initial value to0
, and finally add3
to it. The result will be a newitemcount
attribute in the item, with a value of3
.If the existing data type is a set and if
Value
is also a set, thenValue
is added to the existing set. For example, if the attribute value is the set[1,2]
, and theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
ADD
action only supports Number and set data types. In addition,ADD
can only be used on top-level attributes, not nested attributes.DELETE
- Deletes an element from a set.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 theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports set data types. In addition,DELETE
can only be used on top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the following:
SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateItem
, updateItem_tableName
- The name of the table containing the item to update.
UpdateItem
, updateItem_key
- The primary key of the item to be updated. Each element consists of an
attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
data UpdateItemResponse Source #
Represents the output of an UpdateItem
operation.
See: newUpdateItemResponse
smart constructor.
Constructors
UpdateItemResponse' (Maybe (HashMap Text AttributeValue)) (Maybe ConsumedCapacity) (Maybe ItemCollectionMetrics) Int |
Instances
newUpdateItemResponse Source #
Arguments
:: Int | |
-> UpdateItemResponse |
Create a value of UpdateItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:UpdateItemResponse'
, updateItemResponse_attributes
- A map of attribute values as they appear before or after the
UpdateItem
operation, as determined by the ReturnValues
parameter.
The Attributes
map is only present if ReturnValues
was specified as
something other than NONE
in the request. Each element represents one
attribute.
$sel:consumedCapacity:UpdateItemResponse'
, updateItemResponse_consumedCapacity
- The capacity units consumed by the UpdateItem
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 ReturnConsumedCapacity
parameter was specified. For more information, see
Provisioned Throughput
in the Amazon DynamoDB Developer Guide.
$sel:itemCollectionMetrics:UpdateItemResponse'
, updateItemResponse_itemCollectionMetrics
- Information about item collections, if any, that were affected by the
UpdateItem
operation. ItemCollectionMetrics
is only returned if the
ReturnItemCollectionMetrics
parameter was specified. If the table does
not have any local secondary indexes, this information is not returned
in the response.
Each ItemCollectionMetrics
element consists of:
ItemCollectionKey
- The partition key value of the item collection. This is the same as the partition key value of the item itself.SizeEstimateRangeGB
- 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.
$sel:httpStatus:UpdateItemResponse'
, updateItemResponse_httpStatus
- The response's http status code.
UpdateTable
data UpdateTable Source #
Represents the input of an UpdateTable
operation.
See: newUpdateTable
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> UpdateTable |
Create a value of UpdateTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTable
, updateTable_attributeDefinitions
- An array of attributes that describe the key schema for the table and
indexes. If you are adding a new global secondary index to the table,
AttributeDefinitions
must include the key element(s) of the new index.
UpdateTable
, updateTable_billingMode
- Controls how you are charged for read and write throughput and how you
manage capacity. When switching from pay-per-request to provisioned
capacity, initial provisioned capacity values must be set. The initial
provisioned capacity values are estimated based on the consumed read and
write capacity of your table and global secondary indexes over the past
30 minutes.
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode.PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
$sel:globalSecondaryIndexUpdates:UpdateTable'
, updateTable_globalSecondaryIndexUpdates
- An array of one or more global secondary indexes for the table. For each
index in the array, you can request one action:
Create
- add a new global secondary index to the table.Update
- modify the provisioned throughput settings of an existing global secondary index.Delete
- remove a global secondary index from the table.
You can create or delete only one global secondary index per
UpdateTable
operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
UpdateTable
, updateTable_provisionedThroughput
- The new provisioned throughput settings for the specified table or
index.
$sel:replicaUpdates:UpdateTable'
, updateTable_replicaUpdates
- A list of replica update actions (create, delete, or update) for the
table.
This property only applies to Version 2019.11.21 of global tables.
UpdateTable
, updateTable_sSESpecification
- The new server-side encryption settings for the specified table.
UpdateTable
, updateTable_streamSpecification
- Represents the DynamoDB Streams configuration for the table.
You receive a ResourceInUseException
if you try to enable a stream on
a table that already has a stream, or if you try to disable a stream on
a table that doesn't have a stream.
UpdateTable
, updateTable_tableClass
- The table class of the table to be updated. Valid values are STANDARD
and STANDARD_INFREQUENT_ACCESS
.
UpdateTable
, updateTable_tableName
- The name of the table to be updated.
data UpdateTableResponse Source #
Represents the output of an UpdateTable
operation.
See: newUpdateTableResponse
smart constructor.
Constructors
UpdateTableResponse' (Maybe TableDescription) Int |
Instances
newUpdateTableResponse Source #
Arguments
:: Int | |
-> UpdateTableResponse |
Create a value of UpdateTableResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableDescription:UpdateTableResponse'
, updateTableResponse_tableDescription
- Represents the properties of the table.
$sel:httpStatus:UpdateTableResponse'
, updateTableResponse_httpStatus
- The response's http status code.
UpdateTableReplicaAutoScaling
data UpdateTableReplicaAutoScaling Source #
See: newUpdateTableReplicaAutoScaling
smart constructor.
Constructors
UpdateTableReplicaAutoScaling' (Maybe (NonEmpty GlobalSecondaryIndexAutoScalingUpdate)) (Maybe AutoScalingSettingsUpdate) (Maybe (NonEmpty ReplicaAutoScalingUpdate)) Text |
Instances
newUpdateTableReplicaAutoScaling Source #
Create a value of UpdateTableReplicaAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexUpdates:UpdateTableReplicaAutoScaling'
, updateTableReplicaAutoScaling_globalSecondaryIndexUpdates
- Represents the auto scaling settings of the global secondary indexes of
the replica to be updated.
UpdateTableReplicaAutoScaling
, updateTableReplicaAutoScaling_provisionedWriteCapacityAutoScalingUpdate
- Undocumented member.
$sel:replicaUpdates:UpdateTableReplicaAutoScaling'
, updateTableReplicaAutoScaling_replicaUpdates
- Represents the auto scaling settings of replicas of the table that will
be modified.
UpdateTableReplicaAutoScaling
, updateTableReplicaAutoScaling_tableName
- The name of the global table to be updated.
data UpdateTableReplicaAutoScalingResponse Source #
See: newUpdateTableReplicaAutoScalingResponse
smart constructor.
Instances
newUpdateTableReplicaAutoScalingResponse Source #
Arguments
:: Int | |
-> UpdateTableReplicaAutoScalingResponse |
Create a value of UpdateTableReplicaAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableAutoScalingDescription:UpdateTableReplicaAutoScalingResponse'
, updateTableReplicaAutoScalingResponse_tableAutoScalingDescription
- Returns information about the auto scaling settings of a table with
replicas.
$sel:httpStatus:UpdateTableReplicaAutoScalingResponse'
, updateTableReplicaAutoScalingResponse_httpStatus
- The response's http status code.
UpdateTimeToLive
data UpdateTimeToLive Source #
Represents the input of an UpdateTimeToLive
operation.
See: newUpdateTimeToLive
smart constructor.
Constructors
UpdateTimeToLive' Text TimeToLiveSpecification |
Instances
Create a value of UpdateTimeToLive
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTimeToLive
, updateTimeToLive_tableName
- The name of the table to be configured.
UpdateTimeToLive
, updateTimeToLive_timeToLiveSpecification
- Represents the settings used to enable or disable Time to Live for the
specified table.
data UpdateTimeToLiveResponse Source #
See: newUpdateTimeToLiveResponse
smart constructor.
Constructors
UpdateTimeToLiveResponse' (Maybe TimeToLiveSpecification) Int |
Instances
newUpdateTimeToLiveResponse Source #
Create a value of UpdateTimeToLiveResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTimeToLive
, updateTimeToLiveResponse_timeToLiveSpecification
- Represents the output of an UpdateTimeToLive
operation.
$sel:httpStatus:UpdateTimeToLiveResponse'
, updateTimeToLiveResponse_httpStatus
- The response's http status code.
Types
Common
AttributeAction
newtype AttributeAction Source #
Constructors
AttributeAction' | |
Fields |
Bundled Patterns
pattern AttributeAction_ADD :: AttributeAction | |
pattern AttributeAction_DELETE :: AttributeAction | |
pattern AttributeAction_PUT :: AttributeAction |
Instances
BackupStatus
newtype BackupStatus Source #
Constructors
BackupStatus' | |
Fields |
Bundled Patterns
pattern BackupStatus_AVAILABLE :: BackupStatus | |
pattern BackupStatus_CREATING :: BackupStatus | |
pattern BackupStatus_DELETED :: BackupStatus |
Instances
BackupType
newtype BackupType Source #
Constructors
BackupType' | |
Fields |
Bundled Patterns
pattern BackupType_AWS_BACKUP :: BackupType | |
pattern BackupType_SYSTEM :: BackupType | |
pattern BackupType_USER :: BackupType |
Instances
BackupTypeFilter
newtype BackupTypeFilter Source #
Constructors
BackupTypeFilter' | |
Fields |
Bundled Patterns
pattern BackupTypeFilter_ALL :: BackupTypeFilter | |
pattern BackupTypeFilter_AWS_BACKUP :: BackupTypeFilter | |
pattern BackupTypeFilter_SYSTEM :: BackupTypeFilter | |
pattern BackupTypeFilter_USER :: BackupTypeFilter |
Instances
BatchStatementErrorCodeEnum
newtype BatchStatementErrorCodeEnum Source #
Constructors
BatchStatementErrorCodeEnum' | |
Fields |
Bundled Patterns
Instances
BillingMode
newtype BillingMode Source #
Constructors
BillingMode' | |
Fields |
Bundled Patterns
pattern BillingMode_PAY_PER_REQUEST :: BillingMode | |
pattern BillingMode_PROVISIONED :: BillingMode |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Constructors
ComparisonOperator' | |
Fields |
Bundled Patterns
pattern ComparisonOperator_BEGINS_WITH :: ComparisonOperator | |
pattern ComparisonOperator_BETWEEN :: ComparisonOperator | |
pattern ComparisonOperator_CONTAINS :: ComparisonOperator | |
pattern ComparisonOperator_EQ :: ComparisonOperator | |
pattern ComparisonOperator_GE :: ComparisonOperator | |
pattern ComparisonOperator_GT :: ComparisonOperator | |
pattern ComparisonOperator_IN :: ComparisonOperator | |
pattern ComparisonOperator_LE :: ComparisonOperator | |
pattern ComparisonOperator_LT :: ComparisonOperator | |
pattern ComparisonOperator_NE :: ComparisonOperator | |
pattern ComparisonOperator_NOT_CONTAINS :: ComparisonOperator | |
pattern ComparisonOperator_NOT_NULL :: ComparisonOperator | |
pattern ComparisonOperator_NULL :: ComparisonOperator |
Instances
ConditionalOperator
newtype ConditionalOperator Source #
Constructors
ConditionalOperator' | |
Fields |
Bundled Patterns
pattern ConditionalOperator_AND :: ConditionalOperator | |
pattern ConditionalOperator_OR :: ConditionalOperator |
Instances
ContinuousBackupsStatus
newtype ContinuousBackupsStatus Source #
Constructors
ContinuousBackupsStatus' | |
Fields |
Bundled Patterns
pattern ContinuousBackupsStatus_DISABLED :: ContinuousBackupsStatus | |
pattern ContinuousBackupsStatus_ENABLED :: ContinuousBackupsStatus |
Instances
ContributorInsightsAction
newtype ContributorInsightsAction Source #
Constructors
ContributorInsightsAction' | |
Fields |
Bundled Patterns
pattern ContributorInsightsAction_DISABLE :: ContributorInsightsAction | |
pattern ContributorInsightsAction_ENABLE :: ContributorInsightsAction |
Instances
ContributorInsightsStatus
newtype ContributorInsightsStatus Source #
Constructors
ContributorInsightsStatus' | |
Fields |
Bundled Patterns
Instances
DestinationStatus
newtype DestinationStatus Source #
Constructors
DestinationStatus' | |
Fields |
Bundled Patterns
pattern DestinationStatus_ACTIVE :: DestinationStatus | |
pattern DestinationStatus_DISABLED :: DestinationStatus | |
pattern DestinationStatus_DISABLING :: DestinationStatus | |
pattern DestinationStatus_ENABLE_FAILED :: DestinationStatus | |
pattern DestinationStatus_ENABLING :: DestinationStatus |
Instances
ExportFormat
newtype ExportFormat Source #
Constructors
ExportFormat' | |
Fields |
Bundled Patterns
pattern ExportFormat_DYNAMODB_JSON :: ExportFormat | |
pattern ExportFormat_ION :: ExportFormat |
Instances
ExportStatus
newtype ExportStatus Source #
Constructors
ExportStatus' | |
Fields |
Bundled Patterns
pattern ExportStatus_COMPLETED :: ExportStatus | |
pattern ExportStatus_FAILED :: ExportStatus | |
pattern ExportStatus_IN_PROGRESS :: ExportStatus |
Instances
GlobalTableStatus
newtype GlobalTableStatus Source #
Constructors
GlobalTableStatus' | |
Fields |
Bundled Patterns
pattern GlobalTableStatus_ACTIVE :: GlobalTableStatus | |
pattern GlobalTableStatus_CREATING :: GlobalTableStatus | |
pattern GlobalTableStatus_DELETING :: GlobalTableStatus | |
pattern GlobalTableStatus_UPDATING :: GlobalTableStatus |
Instances
ImportStatus
newtype ImportStatus Source #
Constructors
ImportStatus' | |
Fields |
Bundled Patterns
pattern ImportStatus_CANCELLED :: ImportStatus | |
pattern ImportStatus_CANCELLING :: ImportStatus | |
pattern ImportStatus_COMPLETED :: ImportStatus | |
pattern ImportStatus_FAILED :: ImportStatus | |
pattern ImportStatus_IN_PROGRESS :: ImportStatus |
Instances
IndexStatus
newtype IndexStatus Source #
Constructors
IndexStatus' | |
Fields |
Bundled Patterns
pattern IndexStatus_ACTIVE :: IndexStatus | |
pattern IndexStatus_CREATING :: IndexStatus | |
pattern IndexStatus_DELETING :: IndexStatus | |
pattern IndexStatus_UPDATING :: IndexStatus |
Instances
InputCompressionType
newtype InputCompressionType Source #
Constructors
InputCompressionType' | |
Fields |
Bundled Patterns
pattern InputCompressionType_GZIP :: InputCompressionType | |
pattern InputCompressionType_NONE :: InputCompressionType | |
pattern InputCompressionType_ZSTD :: InputCompressionType |
Instances
InputFormat
newtype InputFormat Source #
Constructors
InputFormat' | |
Fields |
Bundled Patterns
pattern InputFormat_CSV :: InputFormat | |
pattern InputFormat_DYNAMODB_JSON :: InputFormat | |
pattern InputFormat_ION :: InputFormat |
Instances
KeyType
Constructors
KeyType' | |
Fields
|
Bundled Patterns
pattern KeyType_HASH :: KeyType | |
pattern KeyType_RANGE :: KeyType |
Instances
PointInTimeRecoveryStatus
newtype PointInTimeRecoveryStatus Source #
Constructors
PointInTimeRecoveryStatus' | |
Fields |
Bundled Patterns
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus | |
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus |
Instances
ProjectionType
newtype ProjectionType Source #
Constructors
ProjectionType' | |
Fields |
Bundled Patterns
pattern ProjectionType_ALL :: ProjectionType | |
pattern ProjectionType_INCLUDE :: ProjectionType | |
pattern ProjectionType_KEYS_ONLY :: ProjectionType |
Instances
ReplicaStatus
newtype ReplicaStatus Source #
Constructors
ReplicaStatus' | |
Fields |
Bundled Patterns
pattern ReplicaStatus_ACTIVE :: ReplicaStatus | |
pattern ReplicaStatus_CREATING :: ReplicaStatus | |
pattern ReplicaStatus_CREATION_FAILED :: ReplicaStatus | |
pattern ReplicaStatus_DELETING :: ReplicaStatus | |
pattern ReplicaStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: ReplicaStatus | |
pattern ReplicaStatus_REGION_DISABLED :: ReplicaStatus | |
pattern ReplicaStatus_UPDATING :: ReplicaStatus |
Instances
ReturnConsumedCapacity
newtype ReturnConsumedCapacity Source #
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
INDEXES
- The response includes the aggregateConsumedCapacity
for the operation, together withConsumedCapacity
for each table and secondary index that was accessed.Note that some operations, such as
GetItem
andBatchGetItem
, do not access any indexes at all. In these cases, specifyingINDEXES
will only returnConsumedCapacity
information for table(s).TOTAL
- The response includes only the aggregateConsumedCapacity
for the operation.NONE
- NoConsumedCapacity
details are included in the response.
Constructors
ReturnConsumedCapacity' | |
Fields |
Bundled Patterns
pattern ReturnConsumedCapacity_INDEXES :: ReturnConsumedCapacity | |
pattern ReturnConsumedCapacity_NONE :: ReturnConsumedCapacity | |
pattern ReturnConsumedCapacity_TOTAL :: ReturnConsumedCapacity |
Instances
ReturnItemCollectionMetrics
newtype ReturnItemCollectionMetrics Source #
Constructors
ReturnItemCollectionMetrics' | |
Fields |
Bundled Patterns
pattern ReturnItemCollectionMetrics_NONE :: ReturnItemCollectionMetrics | |
pattern ReturnItemCollectionMetrics_SIZE :: ReturnItemCollectionMetrics |
Instances
ReturnValue
newtype ReturnValue Source #
Constructors
ReturnValue' | |
Fields |
Bundled Patterns
pattern ReturnValue_ALL_NEW :: ReturnValue | |
pattern ReturnValue_ALL_OLD :: ReturnValue | |
pattern ReturnValue_NONE :: ReturnValue | |
pattern ReturnValue_UPDATED_NEW :: ReturnValue | |
pattern ReturnValue_UPDATED_OLD :: ReturnValue |
Instances
ReturnValuesOnConditionCheckFailure
newtype ReturnValuesOnConditionCheckFailure Source #
Constructors
ReturnValuesOnConditionCheckFailure' | |
Bundled Patterns
pattern ReturnValuesOnConditionCheckFailure_ALL_OLD :: ReturnValuesOnConditionCheckFailure | |
pattern ReturnValuesOnConditionCheckFailure_NONE :: ReturnValuesOnConditionCheckFailure |
Instances
S3SseAlgorithm
newtype S3SseAlgorithm Source #
Constructors
S3SseAlgorithm' | |
Fields |
Bundled Patterns
pattern S3SseAlgorithm_AES256 :: S3SseAlgorithm | |
pattern S3SseAlgorithm_KMS :: S3SseAlgorithm |
Instances
SSEStatus
Constructors
SSEStatus' | |
Fields |
Bundled Patterns
pattern SSEStatus_DISABLED :: SSEStatus | |
pattern SSEStatus_DISABLING :: SSEStatus | |
pattern SSEStatus_ENABLED :: SSEStatus | |
pattern SSEStatus_ENABLING :: SSEStatus | |
pattern SSEStatus_UPDATING :: SSEStatus |
Instances
SSEType
Constructors
SSEType' | |
Fields
|
Bundled Patterns
pattern SSEType_AES256 :: SSEType | |
pattern SSEType_KMS :: SSEType |
Instances
ScalarAttributeType
newtype ScalarAttributeType Source #
Constructors
ScalarAttributeType' | |
Fields |
Bundled Patterns
pattern ScalarAttributeType_B :: ScalarAttributeType | |
pattern ScalarAttributeType_N :: ScalarAttributeType | |
pattern ScalarAttributeType_S :: ScalarAttributeType |
Instances
Select
Constructors
Select' | |
Fields
|
Bundled Patterns
pattern Select_ALL_ATTRIBUTES :: Select | |
pattern Select_ALL_PROJECTED_ATTRIBUTES :: Select | |
pattern Select_COUNT :: Select | |
pattern Select_SPECIFIC_ATTRIBUTES :: Select |
Instances
StreamViewType
newtype StreamViewType Source #
Constructors
StreamViewType' | |
Fields |
Bundled Patterns
pattern StreamViewType_KEYS_ONLY :: StreamViewType | |
pattern StreamViewType_NEW_AND_OLD_IMAGES :: StreamViewType | |
pattern StreamViewType_NEW_IMAGE :: StreamViewType | |
pattern StreamViewType_OLD_IMAGE :: StreamViewType |
Instances
TableClass
newtype TableClass Source #
Constructors
TableClass' | |
Fields |
Bundled Patterns
pattern TableClass_STANDARD :: TableClass | |
pattern TableClass_STANDARD_INFREQUENT_ACCESS :: TableClass |
Instances
TableStatus
newtype TableStatus Source #
Constructors
TableStatus' | |
Fields |
Bundled Patterns
pattern TableStatus_ACTIVE :: TableStatus | |
pattern TableStatus_ARCHIVED :: TableStatus | |
pattern TableStatus_ARCHIVING :: TableStatus | |
pattern TableStatus_CREATING :: TableStatus | |
pattern TableStatus_DELETING :: TableStatus | |
pattern TableStatus_INACCESSIBLE_ENCRYPTION_CREDENTIALS :: TableStatus | |
pattern TableStatus_UPDATING :: TableStatus |
Instances
TimeToLiveStatus
newtype TimeToLiveStatus Source #
Constructors
TimeToLiveStatus' | |
Fields |
Bundled Patterns
pattern TimeToLiveStatus_DISABLED :: TimeToLiveStatus | |
pattern TimeToLiveStatus_DISABLING :: TimeToLiveStatus | |
pattern TimeToLiveStatus_ENABLED :: TimeToLiveStatus | |
pattern TimeToLiveStatus_ENABLING :: TimeToLiveStatus |
Instances
ArchivalSummary
data ArchivalSummary Source #
Contains details of a table archival operation.
See: newArchivalSummary
smart constructor.
Instances
newArchivalSummary :: ArchivalSummary Source #
Create a value of ArchivalSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:archivalBackupArn:ArchivalSummary'
, archivalSummary_archivalBackupArn
- The Amazon Resource Name (ARN) of the backup the table was archived to,
when applicable in the archival reason. If you wish to restore this
backup to the same table name, you will need to delete the original
table.
$sel:archivalDateTime:ArchivalSummary'
, archivalSummary_archivalDateTime
- The date and time when table archival was initiated by DynamoDB, in UNIX
epoch time format.
$sel:archivalReason:ArchivalSummary'
, archivalSummary_archivalReason
- The reason DynamoDB archived the table. Currently, the only possible
value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
AttributeDefinition
data AttributeDefinition Source #
Represents an attribute for describing the key schema for the table and indexes.
See: newAttributeDefinition
smart constructor.
Constructors
AttributeDefinition' Text ScalarAttributeType |
Instances
newAttributeDefinition Source #
Arguments
:: Text | |
-> ScalarAttributeType | |
-> AttributeDefinition |
Create a value of AttributeDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:AttributeDefinition'
, attributeDefinition_attributeName
- A name for the attribute.
$sel:attributeType:AttributeDefinition'
, attributeDefinition_attributeType
- The data type for the attribute, where:
S
- the attribute is of type StringN
- the attribute is of type NumberB
- the attribute is of type Binary
AttributeValueUpdate
data AttributeValueUpdate Source #
For the UpdateItem
operation, represents the attributes to be
modified, the action to perform on each, and the new value for each.
You cannot use UpdateItem
to update any primary key attributes.
Instead, you will need to delete the item, and then use PutItem
to
create a new item with new attributes.
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: newAttributeValueUpdate
smart constructor.
Constructors
AttributeValueUpdate' (Maybe AttributeAction) (Maybe AttributeValue) |
Instances
newAttributeValueUpdate :: AttributeValueUpdate Source #
Create a value of AttributeValueUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:AttributeValueUpdate'
, attributeValueUpdate_action
- 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 theDELETE
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 ofADD
depends on the data type of the attribute:If the existing attribute is a number, and if
Value
is also a number, then theValue
is mathematically added to the existing attribute. IfValue
is a negative number, then it is subtracted from the existing attribute.If you use
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.In addition, if you use
ADD
to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
.If the existing data type is a set, and if the
Value
is also a set, then theValue
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 theADD
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 a new item with the supplied primary key and number (or set) for the attribute value. The only data types allowed are number, number set, string set or binary set.
$sel:value:AttributeValueUpdate'
, attributeValueUpdate_value
- 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.
AutoScalingPolicyDescription
data AutoScalingPolicyDescription Source #
Represents the properties of the scaling policy.
See: newAutoScalingPolicyDescription
smart constructor.
Constructors
AutoScalingPolicyDescription' (Maybe Text) (Maybe AutoScalingTargetTrackingScalingPolicyConfigurationDescription) |
Instances
newAutoScalingPolicyDescription :: AutoScalingPolicyDescription Source #
Create a value of AutoScalingPolicyDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyName:AutoScalingPolicyDescription'
, autoScalingPolicyDescription_policyName
- The name of the scaling policy.
$sel:targetTrackingScalingPolicyConfiguration:AutoScalingPolicyDescription'
, autoScalingPolicyDescription_targetTrackingScalingPolicyConfiguration
- Represents a target tracking scaling policy configuration.
AutoScalingPolicyUpdate
data AutoScalingPolicyUpdate Source #
Represents the auto scaling policy to be modified.
See: newAutoScalingPolicyUpdate
smart constructor.
Constructors
AutoScalingPolicyUpdate' (Maybe Text) AutoScalingTargetTrackingScalingPolicyConfigurationUpdate |
Instances
newAutoScalingPolicyUpdate Source #
Arguments
:: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate |
|
-> AutoScalingPolicyUpdate |
Create a value of AutoScalingPolicyUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyName:AutoScalingPolicyUpdate'
, autoScalingPolicyUpdate_policyName
- The name of the scaling policy.
$sel:targetTrackingScalingPolicyConfiguration:AutoScalingPolicyUpdate'
, autoScalingPolicyUpdate_targetTrackingScalingPolicyConfiguration
- Represents a target tracking scaling policy configuration.
AutoScalingSettingsDescription
data AutoScalingSettingsDescription Source #
Represents the auto scaling settings for a global table or global secondary index.
See: newAutoScalingSettingsDescription
smart constructor.
Constructors
AutoScalingSettingsDescription' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe [AutoScalingPolicyDescription]) |
Instances
newAutoScalingSettingsDescription :: AutoScalingSettingsDescription Source #
Create a value of AutoScalingSettingsDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingDisabled:AutoScalingSettingsDescription'
, autoScalingSettingsDescription_autoScalingDisabled
- Disabled auto scaling for this global table or global secondary index.
$sel:autoScalingRoleArn:AutoScalingSettingsDescription'
, autoScalingSettingsDescription_autoScalingRoleArn
- Role ARN used for configuring the auto scaling policy.
$sel:maximumUnits:AutoScalingSettingsDescription'
, autoScalingSettingsDescription_maximumUnits
- The maximum capacity units that a global table or global secondary index
should be scaled up to.
$sel:minimumUnits:AutoScalingSettingsDescription'
, autoScalingSettingsDescription_minimumUnits
- The minimum capacity units that a global table or global secondary index
should be scaled down to.
$sel:scalingPolicies:AutoScalingSettingsDescription'
, autoScalingSettingsDescription_scalingPolicies
- Information about the scaling policies.
AutoScalingSettingsUpdate
data AutoScalingSettingsUpdate Source #
Represents the auto scaling settings to be modified for a global table or global secondary index.
See: newAutoScalingSettingsUpdate
smart constructor.
Constructors
AutoScalingSettingsUpdate' (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe AutoScalingPolicyUpdate) |
Instances
newAutoScalingSettingsUpdate :: AutoScalingSettingsUpdate Source #
Create a value of AutoScalingSettingsUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingDisabled:AutoScalingSettingsUpdate'
, autoScalingSettingsUpdate_autoScalingDisabled
- Disabled auto scaling for this global table or global secondary index.
$sel:autoScalingRoleArn:AutoScalingSettingsUpdate'
, autoScalingSettingsUpdate_autoScalingRoleArn
- Role ARN used for configuring auto scaling policy.
$sel:maximumUnits:AutoScalingSettingsUpdate'
, autoScalingSettingsUpdate_maximumUnits
- The maximum capacity units that a global table or global secondary index
should be scaled up to.
$sel:minimumUnits:AutoScalingSettingsUpdate'
, autoScalingSettingsUpdate_minimumUnits
- The minimum capacity units that a global table or global secondary index
should be scaled down to.
$sel:scalingPolicyUpdate:AutoScalingSettingsUpdate'
, autoScalingSettingsUpdate_scalingPolicyUpdate
- The scaling policy to apply for scaling target global table or global
secondary index capacity units.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription
data AutoScalingTargetTrackingScalingPolicyConfigurationDescription Source #
Represents the properties of a target tracking scaling policy.
See: newAutoScalingTargetTrackingScalingPolicyConfigurationDescription
smart constructor.
Constructors
AutoScalingTargetTrackingScalingPolicyConfigurationDescription' (Maybe Bool) (Maybe Int) (Maybe Int) Double |
Instances
newAutoScalingTargetTrackingScalingPolicyConfigurationDescription Source #
Arguments
:: Double |
|
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription |
Create a value of AutoScalingTargetTrackingScalingPolicyConfigurationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
, autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn
- Indicates whether scale in by the target tracking policy is disabled. If
the value is true, scale in is disabled and the target tracking policy
won't remove capacity from the scalable resource. Otherwise, scale in
is enabled and the target tracking policy can remove capacity from the
scalable resource. The default value is false.
$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
, autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown
- The amount of time, in seconds, after a scale in activity completes
before another scale in activity can start. The cooldown period is used
to block subsequent scale in requests until it has expired. You should
scale in conservatively to protect your application's availability.
However, if another alarm triggers a scale out policy during the
cooldown period after a scale-in, application auto scaling scales out
your scalable target immediately.
$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
, autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown
- The amount of time, in seconds, after a scale out activity completes
before another scale out activity can start. While the cooldown period
is in effect, the capacity that has been added by the previous scale out
event that initiated the cooldown is calculated as part of the desired
capacity for the next scale out. You should continuously (but not
excessively) scale out.
$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
, autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue
- The target value for the metric. The range is 8.515920e-109 to
1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
data AutoScalingTargetTrackingScalingPolicyConfigurationUpdate Source #
Represents the settings of a target tracking scaling policy that will be modified.
See: newAutoScalingTargetTrackingScalingPolicyConfigurationUpdate
smart constructor.
Constructors
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate' (Maybe Bool) (Maybe Int) (Maybe Int) Double |
Instances
newAutoScalingTargetTrackingScalingPolicyConfigurationUpdate Source #
Arguments
:: Double |
|
-> AutoScalingTargetTrackingScalingPolicyConfigurationUpdate |
Create a value of AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationUpdate'
, autoScalingTargetTrackingScalingPolicyConfigurationUpdate_disableScaleIn
- Indicates whether scale in by the target tracking policy is disabled. If
the value is true, scale in is disabled and the target tracking policy
won't remove capacity from the scalable resource. Otherwise, scale in
is enabled and the target tracking policy can remove capacity from the
scalable resource. The default value is false.
$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationUpdate'
, autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleInCooldown
- The amount of time, in seconds, after a scale in activity completes
before another scale in activity can start. The cooldown period is used
to block subsequent scale in requests until it has expired. You should
scale in conservatively to protect your application's availability.
However, if another alarm triggers a scale out policy during the
cooldown period after a scale-in, application auto scaling scales out
your scalable target immediately.
$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationUpdate'
, autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleOutCooldown
- The amount of time, in seconds, after a scale out activity completes
before another scale out activity can start. While the cooldown period
is in effect, the capacity that has been added by the previous scale out
event that initiated the cooldown is calculated as part of the desired
capacity for the next scale out. You should continuously (but not
excessively) scale out.
$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationUpdate'
, autoScalingTargetTrackingScalingPolicyConfigurationUpdate_targetValue
- The target value for the metric. The range is 8.515920e-109 to
1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
BackupDescription
data BackupDescription Source #
Contains the description of the backup created for the table.
See: newBackupDescription
smart constructor.
Constructors
BackupDescription' (Maybe BackupDetails) (Maybe SourceTableDetails) (Maybe SourceTableFeatureDetails) |
Instances
newBackupDescription :: BackupDescription Source #
Create a value of BackupDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupDetails:BackupDescription'
, backupDescription_backupDetails
- Contains the details of the backup created for the table.
$sel:sourceTableDetails:BackupDescription'
, backupDescription_sourceTableDetails
- Contains the details of the table when the backup was created.
$sel:sourceTableFeatureDetails:BackupDescription'
, backupDescription_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 Source #
Contains the details of the backup created for the table.
See: newBackupDetails
smart constructor.
Constructors
BackupDetails' (Maybe POSIX) (Maybe Natural) Text Text BackupStatus BackupType POSIX |
Instances
Arguments
:: Text | |
-> Text | |
-> BackupStatus | |
-> BackupType | |
-> UTCTime | |
-> BackupDetails |
Create a value of BackupDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupExpiryDateTime:BackupDetails'
, backupDetails_backupExpiryDateTime
- Time at which the automatic on-demand backup created by DynamoDB will
expire. This SYSTEM
on-demand backup expires automatically 35 days
after its creation.
$sel:backupSizeBytes:BackupDetails'
, backupDetails_backupSizeBytes
- Size of the backup in bytes. DynamoDB updates this value approximately
every six hours. Recent changes might not be reflected in this value.
$sel:backupArn:BackupDetails'
, backupDetails_backupArn
- ARN associated with the backup.
$sel:backupName:BackupDetails'
, backupDetails_backupName
- Name of the requested backup.
$sel:backupStatus:BackupDetails'
, backupDetails_backupStatus
- Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
$sel:backupType:BackupDetails'
, backupDetails_backupType
- BackupType:
USER
- You create and manage these using the on-demand backup feature.SYSTEM
- If you delete a table with point-in-time recovery enabled, aSYSTEM
backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.AWS_BACKUP
- On-demand backup created by you from Backup service.
$sel:backupCreationDateTime:BackupDetails'
, backupDetails_backupCreationDateTime
- Time at which the backup was created. This is the request time of the
backup.
BackupSummary
data BackupSummary Source #
Contains details for the backup.
See: newBackupSummary
smart constructor.
Constructors
BackupSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe BackupStatus) (Maybe BackupType) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newBackupSummary :: BackupSummary Source #
Create a value of BackupSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupArn:BackupSummary'
, backupSummary_backupArn
- ARN associated with the backup.
$sel:backupCreationDateTime:BackupSummary'
, backupSummary_backupCreationDateTime
- Time at which the backup was created.
$sel:backupExpiryDateTime:BackupSummary'
, backupSummary_backupExpiryDateTime
- Time at which the automatic on-demand backup created by DynamoDB will
expire. This SYSTEM
on-demand backup expires automatically 35 days
after its creation.
$sel:backupName:BackupSummary'
, backupSummary_backupName
- Name of the specified backup.
$sel:backupSizeBytes:BackupSummary'
, backupSummary_backupSizeBytes
- Size of the backup in bytes.
$sel:backupStatus:BackupSummary'
, backupSummary_backupStatus
- Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
$sel:backupType:BackupSummary'
, backupSummary_backupType
- BackupType:
USER
- You create and manage these using the on-demand backup feature.SYSTEM
- If you delete a table with point-in-time recovery enabled, aSYSTEM
backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.AWS_BACKUP
- On-demand backup created by you from Backup service.
$sel:tableArn:BackupSummary'
, backupSummary_tableArn
- ARN associated with the table.
$sel:tableId:BackupSummary'
, backupSummary_tableId
- Unique identifier for the table.
$sel:tableName:BackupSummary'
, backupSummary_tableName
- Name of the table.
BatchStatementError
data BatchStatementError Source #
An error associated with a statement in a PartiQL batch that was run.
See: newBatchStatementError
smart constructor.
Constructors
BatchStatementError' (Maybe BatchStatementErrorCodeEnum) (Maybe Text) |
Instances
newBatchStatementError :: BatchStatementError Source #
Create a value of BatchStatementError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:code:BatchStatementError'
, batchStatementError_code
- The error code associated with the failed PartiQL batch statement.
$sel:message:BatchStatementError'
, batchStatementError_message
- The error message associated with the PartiQL batch response.
BatchStatementRequest
data BatchStatementRequest Source #
A PartiQL batch statement request.
See: newBatchStatementRequest
smart constructor.
Constructors
BatchStatementRequest' (Maybe Bool) (Maybe (NonEmpty AttributeValue)) Text |
Instances
newBatchStatementRequest Source #
Create a value of BatchStatementRequest
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:consistentRead:BatchStatementRequest'
, batchStatementRequest_consistentRead
- The read consistency of the PartiQL batch request.
$sel:parameters:BatchStatementRequest'
, batchStatementRequest_parameters
- The parameters associated with a PartiQL statement in the batch request.
$sel:statement:BatchStatementRequest'
, batchStatementRequest_statement
- A valid PartiQL statement.
BatchStatementResponse
data BatchStatementResponse Source #
A PartiQL batch statement response..
See: newBatchStatementResponse
smart constructor.
Constructors
BatchStatementResponse' (Maybe BatchStatementError) (Maybe (HashMap Text AttributeValue)) (Maybe Text) |
Instances
newBatchStatementResponse :: BatchStatementResponse Source #
Create a value of BatchStatementResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:error:BatchStatementResponse'
, batchStatementResponse_error
- The error associated with a failed PartiQL batch statement.
$sel:item:BatchStatementResponse'
, batchStatementResponse_item
- A DynamoDB item associated with a BatchStatementResponse
$sel:tableName:BatchStatementResponse'
, batchStatementResponse_tableName
- The table name associated with a failed PartiQL batch statement.
BillingModeSummary
data BillingModeSummary Source #
Contains the details for the read/write capacity mode. This page talks
about PROVISIONED
and PAY_PER_REQUEST
billing modes. For more
information about these modes, see
Read/write capacity mode.
You may need to switch to on-demand mode at least once in order to
return a BillingModeSummary
response.
See: newBillingModeSummary
smart constructor.
Constructors
BillingModeSummary' (Maybe BillingMode) (Maybe POSIX) |
Instances
newBillingModeSummary :: BillingModeSummary Source #
Create a value of BillingModeSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billingMode:BillingModeSummary'
, billingModeSummary_billingMode
- Controls how you are charged for read and write throughput and how you
manage capacity. This setting can be changed later.
PROVISIONED
- Sets the read/write capacity mode toPROVISIONED
. We recommend usingPROVISIONED
for predictable workloads.PAY_PER_REQUEST
- Sets the read/write capacity mode toPAY_PER_REQUEST
. We recommend usingPAY_PER_REQUEST
for unpredictable workloads.
$sel:lastUpdateToPayPerRequestDateTime:BillingModeSummary'
, billingModeSummary_lastUpdateToPayPerRequestDateTime
- Represents the time when PAY_PER_REQUEST
was last set as the
read/write capacity mode.
Capacity
Represents the amount of provisioned throughput capacity consumed on a table or an index.
See: newCapacity
smart constructor.
Instances
FromJSON Capacity Source # | |
Generic Capacity Source # | |
Read Capacity Source # | |
Show Capacity Source # | |
NFData Capacity Source # | |
Defined in Amazonka.DynamoDB.Types.Capacity | |
Eq Capacity Source # | |
Hashable Capacity Source # | |
Defined in Amazonka.DynamoDB.Types.Capacity | |
type Rep Capacity Source # | |
Defined in Amazonka.DynamoDB.Types.Capacity type Rep Capacity = D1 ('MetaData "Capacity" "Amazonka.DynamoDB.Types.Capacity" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Capacity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "readCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "writeCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) |
newCapacity :: Capacity Source #
Create a value of Capacity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:capacityUnits:Capacity'
, capacity_capacityUnits
- The total number of capacity units consumed on a table or an index.
$sel:readCapacityUnits:Capacity'
, capacity_readCapacityUnits
- The total number of read capacity units consumed on a table or an index.
$sel:writeCapacityUnits:Capacity'
, capacity_writeCapacityUnits
- The total number of write capacity units consumed on a table or an
index.
Condition
Represents the selection criteria for a Query
or Scan
operation:
For a
Query
operation,Condition
is used for specifying theKeyConditions
to 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 aQueryFilter
, which evaluates the query results and returns only the desired values.- For a
Scan
operation,Condition
is used in aScanFilter
, which evaluates the scan results and returns only the desired values.
See: newCondition
smart constructor.
Constructors
Condition' (Maybe [AttributeValue]) ComparisonOperator |
Instances
ToJSON Condition Source # | |
Defined in Amazonka.DynamoDB.Types.Condition | |
Generic Condition Source # | |
Read Condition Source # | |
Show Condition Source # | |
NFData Condition Source # | |
Defined in Amazonka.DynamoDB.Types.Condition | |
Eq Condition Source # | |
Hashable Condition Source # | |
Defined in Amazonka.DynamoDB.Types.Condition | |
type Rep Condition Source # | |
Defined in Amazonka.DynamoDB.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.DynamoDB.Types.Condition" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeValueList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeValue])) :*: S1 ('MetaSel ('Just "comparisonOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ComparisonOperator))) |
Create a value of Condition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeValueList:Condition'
, condition_attributeValueList
- 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.
$sel:comparisonOperator:Condition'
, 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 oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
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 oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Booleantrue
. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator.NULL
: The attribute does not exist.NULL
is supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Booleanfalse
. This is because the attribute "a
" exists; its data type is not relevant to theNULL
comparison operator.CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 moreAttributeValue
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 twoAttributeValue
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 anAttributeValue
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.
ConditionCheck
data ConditionCheck Source #
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.
See: newConditionCheck
smart constructor.
Constructors
ConditionCheck' (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> ConditionCheck |
Create a value of ConditionCheck
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expressionAttributeNames:ConditionCheck'
, conditionCheck_expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.
$sel:expressionAttributeValues:ConditionCheck'
, conditionCheck_expressionAttributeValues
- One or more values that can be substituted in an expression.
$sel:returnValuesOnConditionCheckFailure:ConditionCheck'
, conditionCheck_returnValuesOnConditionCheckFailure
- Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the ConditionCheck
condition fails. For
ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and
ALL_OLD.
$sel:key:ConditionCheck'
, conditionCheck_key
- The primary key of the item to be checked. Each element consists of an
attribute name and a value for that attribute.
$sel:tableName:ConditionCheck'
, conditionCheck_tableName
- Name of the table for the check item request.
$sel:conditionExpression:ConditionCheck'
, conditionCheck_conditionExpression
- A condition that must be satisfied in order for a conditional update to
succeed.
ConsumedCapacity
data ConsumedCapacity Source #
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: newConsumedCapacity
smart constructor.
Constructors
ConsumedCapacity' (Maybe Double) (Maybe (HashMap Text Capacity)) (Maybe (HashMap Text Capacity)) (Maybe Double) (Maybe Capacity) (Maybe Text) (Maybe Double) |
Instances
newConsumedCapacity :: ConsumedCapacity Source #
Create a value of ConsumedCapacity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ConsumedCapacity
, consumedCapacity_capacityUnits
- The total number of capacity units consumed by the operation.
$sel:globalSecondaryIndexes:ConsumedCapacity'
, consumedCapacity_globalSecondaryIndexes
- The amount of throughput consumed on each global index affected by the
operation.
$sel:localSecondaryIndexes:ConsumedCapacity'
, consumedCapacity_localSecondaryIndexes
- The amount of throughput consumed on each local index affected by the
operation.
ConsumedCapacity
, consumedCapacity_readCapacityUnits
- The total number of read capacity units consumed by the operation.
$sel:table:ConsumedCapacity'
, consumedCapacity_table
- The amount of throughput consumed on the table affected by the
operation.
$sel:tableName:ConsumedCapacity'
, consumedCapacity_tableName
- The name of the table that was affected by the operation.
ConsumedCapacity
, consumedCapacity_writeCapacityUnits
- The total number of write capacity units consumed by the operation.
ContinuousBackupsDescription
data ContinuousBackupsDescription Source #
Represents the continuous backups and point in time recovery settings on the table.
See: newContinuousBackupsDescription
smart constructor.
Constructors
ContinuousBackupsDescription' (Maybe PointInTimeRecoveryDescription) ContinuousBackupsStatus |
Instances
newContinuousBackupsDescription Source #
Arguments
:: ContinuousBackupsStatus | |
-> ContinuousBackupsDescription |
Create a value of ContinuousBackupsDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pointInTimeRecoveryDescription:ContinuousBackupsDescription'
, continuousBackupsDescription_pointInTimeRecoveryDescription
- The description of the point in time recovery settings applied to the
table.
$sel:continuousBackupsStatus:ContinuousBackupsDescription'
, continuousBackupsDescription_continuousBackupsStatus
- ContinuousBackupsStatus
can be one of the following states: ENABLED,
DISABLED
ContributorInsightsSummary
data ContributorInsightsSummary Source #
Represents a Contributor Insights summary entry.
See: newContributorInsightsSummary
smart constructor.
Constructors
ContributorInsightsSummary' (Maybe ContributorInsightsStatus) (Maybe Text) (Maybe Text) |
Instances
newContributorInsightsSummary :: ContributorInsightsSummary Source #
Create a value of ContributorInsightsSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contributorInsightsStatus:ContributorInsightsSummary'
, contributorInsightsSummary_contributorInsightsStatus
- Describes the current status for contributor insights for the given
table and index, if applicable.
$sel:indexName:ContributorInsightsSummary'
, contributorInsightsSummary_indexName
- Name of the index associated with the summary, if any.
$sel:tableName:ContributorInsightsSummary'
, contributorInsightsSummary_tableName
- Name of the table associated with the summary.
CreateGlobalSecondaryIndexAction
data CreateGlobalSecondaryIndexAction Source #
Represents a new global secondary index to be added to an existing table.
See: newCreateGlobalSecondaryIndexAction
smart constructor.
Constructors
CreateGlobalSecondaryIndexAction' (Maybe ProvisionedThroughput) Text (NonEmpty KeySchemaElement) Projection |
Instances
newCreateGlobalSecondaryIndexAction Source #
Arguments
:: Text | |
-> NonEmpty KeySchemaElement | |
-> Projection | |
-> CreateGlobalSecondaryIndexAction |
Create a value of CreateGlobalSecondaryIndexAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:provisionedThroughput:CreateGlobalSecondaryIndexAction'
, createGlobalSecondaryIndexAction_provisionedThroughput
- Represents the provisioned throughput settings for the specified global
secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
$sel:indexName:CreateGlobalSecondaryIndexAction'
, createGlobalSecondaryIndexAction_indexName
- The name of the global secondary index to be created.
$sel:keySchema:CreateGlobalSecondaryIndexAction'
, createGlobalSecondaryIndexAction_keySchema
- The key schema for the global secondary index.
$sel:projection:CreateGlobalSecondaryIndexAction'
, 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.
CreateReplicaAction
data CreateReplicaAction Source #
Represents a replica to be added.
See: newCreateReplicaAction
smart constructor.
Constructors
CreateReplicaAction' Text |
Instances
newCreateReplicaAction Source #
Arguments
:: Text | |
-> CreateReplicaAction |
Create a value of CreateReplicaAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:CreateReplicaAction'
, createReplicaAction_regionName
- The Region of the replica to be added.
CreateReplicationGroupMemberAction
data CreateReplicationGroupMemberAction Source #
Represents a replica to be created.
See: newCreateReplicationGroupMemberAction
smart constructor.
Constructors
CreateReplicationGroupMemberAction' (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) (Maybe Text) (Maybe ProvisionedThroughputOverride) (Maybe TableClass) Text |
Instances
newCreateReplicationGroupMemberAction Source #
Arguments
:: Text | |
-> CreateReplicationGroupMemberAction |
Create a value of CreateReplicationGroupMemberAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexes:CreateReplicationGroupMemberAction'
, createReplicationGroupMemberAction_globalSecondaryIndexes
- Replica-specific global secondary index settings.
$sel:kmsMasterKeyId:CreateReplicationGroupMemberAction'
, createReplicationGroupMemberAction_kmsMasterKeyId
- The KMS key that should be used for KMS encryption in the new replica.
To specify a key, use its key ID, Amazon Resource Name (ARN), alias
name, or alias ARN. Note that you should only provide this parameter if
the key is different from the default DynamoDB KMS key
alias/aws/dynamodb
.
CreateReplicationGroupMemberAction
, createReplicationGroupMemberAction_provisionedThroughputOverride
- Replica-specific provisioned throughput. If not specified, uses the
source table's provisioned throughput settings.
$sel:tableClassOverride:CreateReplicationGroupMemberAction'
, createReplicationGroupMemberAction_tableClassOverride
- Replica-specific table class. If not specified, uses the source table's
table class.
$sel:regionName:CreateReplicationGroupMemberAction'
, createReplicationGroupMemberAction_regionName
- The Region where the new replica will be created.
CsvOptions
data CsvOptions Source #
Processing options for the CSV file being imported.
See: newCsvOptions
smart constructor.
Instances
newCsvOptions :: CsvOptions Source #
Create a value of CsvOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delimiter:CsvOptions'
, csvOptions_delimiter
- The delimiter used for separating items in the CSV file being imported.
$sel:headerList:CsvOptions'
, csvOptions_headerList
- List of the headers used to specify a common header for all source CSV
files being imported. If this field is specified then the first line of
each CSV file is treated as data instead of the header. If this field is
not specified the the first line of each CSV file is treated as the
header.
Delete
Represents a request to perform a DeleteItem
operation.
See: newDelete
smart constructor.
Constructors
Delete' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text |
Instances
Create a value of Delete
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionExpression:Delete'
, delete_conditionExpression
- A condition that must be satisfied in order for a conditional delete to
succeed.
$sel:expressionAttributeNames:Delete'
, delete_expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.
$sel:expressionAttributeValues:Delete'
, delete_expressionAttributeValues
- One or more values that can be substituted in an expression.
$sel:returnValuesOnConditionCheckFailure:Delete'
, delete_returnValuesOnConditionCheckFailure
- Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Delete
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE and ALL_OLD.
$sel:key:Delete'
, delete_key
- The primary key of the item to be deleted. Each element consists of an
attribute name and a value for that attribute.
$sel:tableName:Delete'
, delete_tableName
- Name of the table in which the item to be deleted resides.
DeleteGlobalSecondaryIndexAction
data DeleteGlobalSecondaryIndexAction Source #
Represents a global secondary index to be deleted from an existing table.
See: newDeleteGlobalSecondaryIndexAction
smart constructor.
Constructors
DeleteGlobalSecondaryIndexAction' Text |
Instances
newDeleteGlobalSecondaryIndexAction Source #
Create a value of DeleteGlobalSecondaryIndexAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:DeleteGlobalSecondaryIndexAction'
, deleteGlobalSecondaryIndexAction_indexName
- The name of the global secondary index to be deleted.
DeleteReplicaAction
data DeleteReplicaAction Source #
Represents a replica to be removed.
See: newDeleteReplicaAction
smart constructor.
Constructors
DeleteReplicaAction' Text |
Instances
newDeleteReplicaAction Source #
Arguments
:: Text | |
-> DeleteReplicaAction |
Create a value of DeleteReplicaAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:DeleteReplicaAction'
, deleteReplicaAction_regionName
- The Region of the replica to be removed.
DeleteReplicationGroupMemberAction
data DeleteReplicationGroupMemberAction Source #
Represents a replica to be deleted.
See: newDeleteReplicationGroupMemberAction
smart constructor.
Constructors
DeleteReplicationGroupMemberAction' Text |
Instances
newDeleteReplicationGroupMemberAction Source #
Arguments
:: Text | |
-> DeleteReplicationGroupMemberAction |
Create a value of DeleteReplicationGroupMemberAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:DeleteReplicationGroupMemberAction'
, deleteReplicationGroupMemberAction_regionName
- The Region where the replica exists.
Endpoint
An endpoint information details.
See: newEndpoint
smart constructor.
Instances
FromJSON Endpoint Source # | |
Generic Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.DynamoDB.Types.Endpoint | |
Eq Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Amazonka.DynamoDB.Types.Endpoint | |
type Rep Endpoint Source # | |
Defined in Amazonka.DynamoDB.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.DynamoDB.Types.Endpoint" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cachePeriodInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) |
Create a value of Endpoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:Endpoint'
, endpoint_address
- IP address of the endpoint.
$sel:cachePeriodInMinutes:Endpoint'
, endpoint_cachePeriodInMinutes
- Endpoint cache time to live (TTL) value.
ExpectedAttributeValue
data ExpectedAttributeValue Source #
Represents a condition to be compared with an attribute value. This
condition can be used with DeleteItem
, PutItem
, or UpdateItem
operations; if the comparison evaluates to true, the operation succeeds;
if not, the operation fails. You can use ExpectedAttributeValue
in one
of two different ways:
- Use
AttributeValueList
to specify one or more values to compare against an attribute. UseComparisonOperator
to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. - Use
Value
to specify a value that DynamoDB will compare against an attribute. If the values match, thenExpectedAttributeValue
evaluates to true and the conditional operation succeeds. Optionally, you can also setExists
to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.
Value
and Exists
are incompatible with AttributeValueList
and
ComparisonOperator
. Note that if you use both sets of parameters at
once, DynamoDB will return a ValidationException
exception.
See: newExpectedAttributeValue
smart constructor.
Constructors
ExpectedAttributeValue' (Maybe [AttributeValue]) (Maybe ComparisonOperator) (Maybe Bool) (Maybe AttributeValue) |
Instances
newExpectedAttributeValue :: ExpectedAttributeValue Source #
Create a value of ExpectedAttributeValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeValueList:ExpectedAttributeValue'
, expectedAttributeValue_attributeValueList
- 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.
$sel:comparisonOperator:ExpectedAttributeValue'
, expectedAttributeValue_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 oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
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 oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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 oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
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.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Booleantrue
. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator.NULL
: The attribute does not exist.NULL
is supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Booleanfalse
. This is because the attribute "a
" exists; its data type is not relevant to theNULL
comparison operator.CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 moreAttributeValue
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 twoAttributeValue
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 anAttributeValue
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"]}
$sel:exists:ExpectedAttributeValue'
, expectedAttributeValue_exists
- Causes DynamoDB to evaluate the value before attempting a conditional
operation:
- If
Exists
istrue
, 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 aConditionCheckFailedException
. - If
Exists
isfalse
, 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 aConditionCheckFailedException
.
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
istrue
but there is noValue
to check. (You expect a value to exist, but don't specify what that value is.)Exists
isfalse
but you also provide aValue
. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
$sel:value:ExpectedAttributeValue'
, expectedAttributeValue_value
- 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.
ExportDescription
data ExportDescription Source #
Represents the properties of the exported table.
See: newExportDescription
smart constructor.
Constructors
ExportDescription' (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ExportFormat) (Maybe Text) (Maybe ExportStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe S3SseAlgorithm) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newExportDescription :: ExportDescription Source #
Create a value of ExportDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billedSizeBytes:ExportDescription'
, exportDescription_billedSizeBytes
- The billable size of the table export.
$sel:clientToken:ExportDescription'
, exportDescription_clientToken
- The client token that was provided for the export task. A client token
makes calls to ExportTableToPointInTimeInput
idempotent, meaning that
multiple identical calls have the same effect as one single call.
$sel:endTime:ExportDescription'
, exportDescription_endTime
- The time at which the export task completed.
$sel:exportArn:ExportDescription'
, exportDescription_exportArn
- The Amazon Resource Name (ARN) of the table export.
$sel:exportFormat:ExportDescription'
, exportDescription_exportFormat
- The format of the exported data. Valid values for ExportFormat
are
DYNAMODB_JSON
or ION
.
$sel:exportManifest:ExportDescription'
, exportDescription_exportManifest
- The name of the manifest file for the export task.
$sel:exportStatus:ExportDescription'
, exportDescription_exportStatus
- Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
FAILED.
$sel:exportTime:ExportDescription'
, exportDescription_exportTime
- Point in time from which table data was exported.
$sel:failureCode:ExportDescription'
, exportDescription_failureCode
- Status code for the result of the failed export.
$sel:failureMessage:ExportDescription'
, exportDescription_failureMessage
- Export failure reason description.
$sel:itemCount:ExportDescription'
, exportDescription_itemCount
- The number of items exported.
$sel:s3Bucket:ExportDescription'
, exportDescription_s3Bucket
- The name of the Amazon S3 bucket containing the export.
$sel:s3BucketOwner:ExportDescription'
, exportDescription_s3BucketOwner
- The ID of the Amazon Web Services account that owns the bucket
containing the export.
$sel:s3Prefix:ExportDescription'
, exportDescription_s3Prefix
- The Amazon S3 bucket prefix used as the file name and path of the
exported snapshot.
$sel:s3SseAlgorithm:ExportDescription'
, exportDescription_s3SseAlgorithm
- Type of encryption used on the bucket where export data is stored. Valid
values for S3SseAlgorithm
are:
AES256
- server-side encryption with Amazon S3 managed keysKMS
- server-side encryption with KMS managed keys
$sel:s3SseKmsKeyId:ExportDescription'
, exportDescription_s3SseKmsKeyId
- The ID of the KMS managed key used to encrypt the S3 bucket where export
data is stored (if applicable).
$sel:startTime:ExportDescription'
, exportDescription_startTime
- The time at which the export task began.
$sel:tableArn:ExportDescription'
, exportDescription_tableArn
- The Amazon Resource Name (ARN) of the table that was exported.
$sel:tableId:ExportDescription'
, exportDescription_tableId
- Unique ID of the table that was exported.
ExportSummary
data ExportSummary Source #
Summary information about an export task.
See: newExportSummary
smart constructor.
Constructors
ExportSummary' (Maybe Text) (Maybe ExportStatus) |
Instances
newExportSummary :: ExportSummary Source #
Create a value of ExportSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exportArn:ExportSummary'
, exportSummary_exportArn
- The Amazon Resource Name (ARN) of the export.
$sel:exportStatus:ExportSummary'
, exportSummary_exportStatus
- Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
FAILED.
FailureException
data FailureException Source #
Represents a failure a contributor insights operation.
See: newFailureException
smart constructor.
Constructors
FailureException' (Maybe Text) (Maybe Text) |
Instances
newFailureException :: FailureException Source #
Create a value of FailureException
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:exceptionDescription:FailureException'
, failureException_exceptionDescription
- Description of the failure.
$sel:exceptionName:FailureException'
, failureException_exceptionName
- Exception name.
Get
Specifies an item and related attribute values to retrieve in a
TransactGetItem
object.
See: newGet
smart constructor.
Instances
ToJSON Get Source # | |
Defined in Amazonka.DynamoDB.Types.Get | |
Generic Get Source # | |
Read Get Source # | |
Show Get Source # | |
NFData Get Source # | |
Defined in Amazonka.DynamoDB.Types.Get | |
Eq Get Source # | |
Hashable Get Source # | |
Defined in Amazonka.DynamoDB.Types.Get | |
type Rep Get Source # | |
Defined in Amazonka.DynamoDB.Types.Get type Rep Get = D1 ('MetaData "Get" "Amazonka.DynamoDB.Types.Get" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Get'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expressionAttributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "projectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text AttributeValue)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
Create a value of Get
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expressionAttributeNames:Get'
, get_expressionAttributeNames
- One or more substitution tokens for attribute names in the
ProjectionExpression parameter.
$sel:projectionExpression:Get'
, get_projectionExpression
- A string that identifies one or more attributes of the specified item to
retrieve from the table. The attributes in the expression must be
separated by commas. If no attribute names are specified, then all
attributes of the specified item are returned. If any of the requested
attributes are not found, they do not appear in the result.
$sel:key:Get'
, get_key
- A map of attribute names to AttributeValue
objects that specifies the
primary key of the item to retrieve.
$sel:tableName:Get'
, get_tableName
- The name of the table from which to retrieve the specified item.
GlobalSecondaryIndex
data GlobalSecondaryIndex Source #
Represents the properties of a global secondary index.
See: newGlobalSecondaryIndex
smart constructor.
Constructors
GlobalSecondaryIndex' (Maybe ProvisionedThroughput) Text (NonEmpty KeySchemaElement) Projection |
Instances
newGlobalSecondaryIndex Source #
Arguments
:: Text | |
-> NonEmpty KeySchemaElement | |
-> Projection | |
-> GlobalSecondaryIndex |
Create a value of GlobalSecondaryIndex
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:provisionedThroughput:GlobalSecondaryIndex'
, globalSecondaryIndex_provisionedThroughput
- Represents the provisioned throughput settings for the specified global
secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
$sel:indexName:GlobalSecondaryIndex'
, globalSecondaryIndex_indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.
$sel:keySchema:GlobalSecondaryIndex'
, globalSecondaryIndex_keySchema
- The complete key schema for a global secondary index, which consists of
one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:GlobalSecondaryIndex'
, 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.
GlobalSecondaryIndexAutoScalingUpdate
data GlobalSecondaryIndexAutoScalingUpdate Source #
Represents the auto scaling settings of a global secondary index for a global table that will be modified.
See: newGlobalSecondaryIndexAutoScalingUpdate
smart constructor.
Constructors
GlobalSecondaryIndexAutoScalingUpdate' (Maybe Text) (Maybe AutoScalingSettingsUpdate) |
Instances
newGlobalSecondaryIndexAutoScalingUpdate :: GlobalSecondaryIndexAutoScalingUpdate Source #
Create a value of GlobalSecondaryIndexAutoScalingUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:GlobalSecondaryIndexAutoScalingUpdate'
, globalSecondaryIndexAutoScalingUpdate_indexName
- The name of the global secondary index.
$sel:provisionedWriteCapacityAutoScalingUpdate:GlobalSecondaryIndexAutoScalingUpdate'
, globalSecondaryIndexAutoScalingUpdate_provisionedWriteCapacityAutoScalingUpdate
- Undocumented member.
GlobalSecondaryIndexDescription
data GlobalSecondaryIndexDescription Source #
Represents the properties of a global secondary index.
See: newGlobalSecondaryIndexDescription
smart constructor.
Constructors
Instances
newGlobalSecondaryIndexDescription :: GlobalSecondaryIndexDescription Source #
Create a value of GlobalSecondaryIndexDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backfilling:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_backfilling
- 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.
You can delete an index that is being created during the Backfilling
phase when IndexStatus
is set to CREATING and Backfilling
is true.
You can't delete the index that is being created when IndexStatus
is
set to CREATING and Backfilling
is false.
For indexes that were created during a CreateTable
operation, the
Backfilling
attribute does not appear in the DescribeTable
output.
$sel:indexArn:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
$sel:indexName:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_indexName
- The name of the global secondary index.
$sel:indexSizeBytes:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_indexSizeBytes
- The total size of the specified index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be
reflected in this value.
$sel:indexStatus:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_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.
$sel:itemCount:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_itemCount
- The number of items in the specified index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in
this value.
$sel:keySchema:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_keySchema
- The complete key schema for a global secondary index, which consists of
one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_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.
$sel:provisionedThroughput:GlobalSecondaryIndexDescription'
, globalSecondaryIndexDescription_provisionedThroughput
- Represents the provisioned throughput settings for the specified global
secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
GlobalSecondaryIndexInfo
data GlobalSecondaryIndexInfo Source #
Represents the properties of a global secondary index for the table when the backup was created.
See: newGlobalSecondaryIndexInfo
smart constructor.
Constructors
GlobalSecondaryIndexInfo' (Maybe Text) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection) (Maybe ProvisionedThroughput) |
Instances
newGlobalSecondaryIndexInfo :: GlobalSecondaryIndexInfo Source #
Create a value of GlobalSecondaryIndexInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:GlobalSecondaryIndexInfo'
, globalSecondaryIndexInfo_indexName
- The name of the global secondary index.
$sel:keySchema:GlobalSecondaryIndexInfo'
, globalSecondaryIndexInfo_keySchema
- The complete key schema for a global secondary index, which consists of
one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:GlobalSecondaryIndexInfo'
, globalSecondaryIndexInfo_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.
$sel:provisionedThroughput:GlobalSecondaryIndexInfo'
, globalSecondaryIndexInfo_provisionedThroughput
- Represents the provisioned throughput settings for the specified global
secondary index.
GlobalSecondaryIndexUpdate
data GlobalSecondaryIndexUpdate Source #
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: newGlobalSecondaryIndexUpdate
smart constructor.
Constructors
GlobalSecondaryIndexUpdate' (Maybe CreateGlobalSecondaryIndexAction) (Maybe DeleteGlobalSecondaryIndexAction) (Maybe UpdateGlobalSecondaryIndexAction) |
Instances
newGlobalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate Source #
Create a value of GlobalSecondaryIndexUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:create:GlobalSecondaryIndexUpdate'
, globalSecondaryIndexUpdate_create
- The parameters required for creating a global secondary index on an
existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
$sel:delete':GlobalSecondaryIndexUpdate'
, globalSecondaryIndexUpdate_delete
- The name of an existing global secondary index to be removed.
$sel:update:GlobalSecondaryIndexUpdate'
, globalSecondaryIndexUpdate_update
- The name of an existing global secondary index, along with new
provisioned throughput settings to be applied to that index.
GlobalTable
data GlobalTable Source #
Represents the properties of a global table.
See: newGlobalTable
smart constructor.
Constructors
GlobalTable' (Maybe Text) (Maybe [Replica]) |
Instances
newGlobalTable :: GlobalTable Source #
Create a value of GlobalTable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalTableName:GlobalTable'
, globalTable_globalTableName
- The global table name.
$sel:replicationGroup:GlobalTable'
, globalTable_replicationGroup
- The Regions where the global table has replicas.
GlobalTableDescription
data GlobalTableDescription Source #
Contains details about the global table.
See: newGlobalTableDescription
smart constructor.
Constructors
GlobalTableDescription' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe GlobalTableStatus) (Maybe [ReplicaDescription]) |
Instances
newGlobalTableDescription :: GlobalTableDescription Source #
Create a value of GlobalTableDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationDateTime:GlobalTableDescription'
, globalTableDescription_creationDateTime
- The creation time of the global table.
$sel:globalTableArn:GlobalTableDescription'
, globalTableDescription_globalTableArn
- The unique identifier of the global table.
$sel:globalTableName:GlobalTableDescription'
, globalTableDescription_globalTableName
- The global table name.
$sel:globalTableStatus:GlobalTableDescription'
, globalTableDescription_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.
$sel:replicationGroup:GlobalTableDescription'
, globalTableDescription_replicationGroup
- The Regions where the global table has replicas.
GlobalTableGlobalSecondaryIndexSettingsUpdate
data GlobalTableGlobalSecondaryIndexSettingsUpdate Source #
Represents the settings of a global secondary index for a global table that will be modified.
See: newGlobalTableGlobalSecondaryIndexSettingsUpdate
smart constructor.
Constructors
GlobalTableGlobalSecondaryIndexSettingsUpdate' (Maybe AutoScalingSettingsUpdate) (Maybe Natural) Text |
Instances
newGlobalTableGlobalSecondaryIndexSettingsUpdate Source #
Arguments
:: Text |
|
-> GlobalTableGlobalSecondaryIndexSettingsUpdate |
Create a value of GlobalTableGlobalSecondaryIndexSettingsUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:provisionedWriteCapacityAutoScalingSettingsUpdate:GlobalTableGlobalSecondaryIndexSettingsUpdate'
, globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityAutoScalingSettingsUpdate
- Auto scaling settings for managing a global secondary index's write
capacity units.
$sel:provisionedWriteCapacityUnits:GlobalTableGlobalSecondaryIndexSettingsUpdate'
, globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityUnits
- The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException.
$sel:indexName:GlobalTableGlobalSecondaryIndexSettingsUpdate'
, globalTableGlobalSecondaryIndexSettingsUpdate_indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.
ImportSummary
data ImportSummary Source #
Summary information about the source file for the import.
See: newImportSummary
smart constructor.
Constructors
ImportSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ImportStatus) (Maybe InputFormat) (Maybe S3BucketSource) (Maybe POSIX) (Maybe Text) |
Instances
newImportSummary :: ImportSummary Source #
Create a value of ImportSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupArn:ImportSummary'
, importSummary_cloudWatchLogGroupArn
- The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated
with this import task.
$sel:endTime:ImportSummary'
, importSummary_endTime
- The time at which this import task ended. (Does this include the
successful complete creation of the table it was imported to?)
$sel:importArn:ImportSummary'
, importSummary_importArn
- The Amazon Resource Number (ARN) corresponding to the import request.
$sel:importStatus:ImportSummary'
, importSummary_importStatus
- The status of the import operation.
$sel:inputFormat:ImportSummary'
, importSummary_inputFormat
- The format of the source data. Valid values are CSV
, DYNAMODB_JSON
or ION
.
$sel:s3BucketSource:ImportSummary'
, importSummary_s3BucketSource
- The path and S3 bucket of the source file that is being imported. This
includes the S3Bucket (required), S3KeyPrefix (optional) and
S3BucketOwner (optional if the bucket is owned by the requester).
$sel:startTime:ImportSummary'
, importSummary_startTime
- The time at which this import task began.
$sel:tableArn:ImportSummary'
, importSummary_tableArn
- The Amazon Resource Number (ARN) of the table being imported into.
ImportTableDescription
data ImportTableDescription Source #
Represents the properties of the table being imported into.
See: newImportTableDescription
smart constructor.
Constructors
ImportTableDescription' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ImportStatus) (Maybe Natural) (Maybe InputCompressionType) (Maybe InputFormat) (Maybe InputFormatOptions) (Maybe Natural) (Maybe Integer) (Maybe S3BucketSource) (Maybe POSIX) (Maybe Text) (Maybe TableCreationParameters) (Maybe Text) |
Instances
newImportTableDescription :: ImportTableDescription Source #
Create a value of ImportTableDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:ImportTableDescription'
, importTableDescription_clientToken
- The client token that was provided for the import task. Reusing the
client token on retry makes a call to ImportTable
idempotent.
$sel:cloudWatchLogGroupArn:ImportTableDescription'
, importTableDescription_cloudWatchLogGroupArn
- The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated
with the target table.
$sel:endTime:ImportTableDescription'
, importTableDescription_endTime
- The time at which the creation of the table associated with this import
task completed.
$sel:errorCount:ImportTableDescription'
, importTableDescription_errorCount
- The number of errors occurred on importing the source file into the
target table.
$sel:failureCode:ImportTableDescription'
, importTableDescription_failureCode
- The error code corresponding to the failure that the import job ran into
during execution.
$sel:failureMessage:ImportTableDescription'
, importTableDescription_failureMessage
- The error message corresponding to the failure that the import job ran
into during execution.
$sel:importArn:ImportTableDescription'
, importTableDescription_importArn
- The Amazon Resource Number (ARN) corresponding to the import request.
$sel:importStatus:ImportTableDescription'
, importTableDescription_importStatus
- The status of the import.
$sel:importedItemCount:ImportTableDescription'
, importTableDescription_importedItemCount
- The number of items successfully imported into the new table.
$sel:inputCompressionType:ImportTableDescription'
, importTableDescription_inputCompressionType
- The compression options for the data that has been imported into the
target table. The values are NONE, GZIP, or ZSTD.
$sel:inputFormat:ImportTableDescription'
, importTableDescription_inputFormat
- The format of the source data going into the target table.
$sel:inputFormatOptions:ImportTableDescription'
, importTableDescription_inputFormatOptions
- The format options for the data that was imported into the target table.
There is one value, CsvOption.
$sel:processedItemCount:ImportTableDescription'
, importTableDescription_processedItemCount
- The total number of items processed from the source file.
$sel:processedSizeBytes:ImportTableDescription'
, importTableDescription_processedSizeBytes
- The total size of data processed from the source file, in Bytes.
$sel:s3BucketSource:ImportTableDescription'
, importTableDescription_s3BucketSource
- Values for the S3 bucket the source file is imported from. Includes
bucket name (required), key prefix (optional) and bucket account owner
ID (optional).
$sel:startTime:ImportTableDescription'
, importTableDescription_startTime
- The time when this import task started.
$sel:tableArn:ImportTableDescription'
, importTableDescription_tableArn
- The Amazon Resource Number (ARN) of the table being imported into.
$sel:tableCreationParameters:ImportTableDescription'
, importTableDescription_tableCreationParameters
- The parameters for the new table that is being imported into.
$sel:tableId:ImportTableDescription'
, importTableDescription_tableId
- The table id corresponding to the table created by import table process.
InputFormatOptions
data InputFormatOptions Source #
The format options for the data that was imported into the target table. There is one value, CsvOption.
See: newInputFormatOptions
smart constructor.
Constructors
InputFormatOptions' (Maybe CsvOptions) |
Instances
newInputFormatOptions :: InputFormatOptions Source #
Create a value of InputFormatOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:csv:InputFormatOptions'
, inputFormatOptions_csv
- The options for imported source files in CSV format. The values are
Delimiter and HeaderList.
ItemCollectionMetrics
data ItemCollectionMetrics Source #
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: newItemCollectionMetrics
smart constructor.
Constructors
ItemCollectionMetrics' (Maybe (HashMap Text AttributeValue)) (Maybe [Double]) |
Instances
newItemCollectionMetrics :: ItemCollectionMetrics Source #
Create a value of ItemCollectionMetrics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:itemCollectionKey:ItemCollectionMetrics'
, itemCollectionMetrics_itemCollectionKey
- The partition key value of the item collection. This value is the same
as the partition key value of the item.
$sel:sizeEstimateRangeGB:ItemCollectionMetrics'
, itemCollectionMetrics_sizeEstimateRangeGB
- 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.
ItemResponse
data ItemResponse Source #
Details for the requested item.
See: newItemResponse
smart constructor.
Constructors
ItemResponse' (Maybe (HashMap Text AttributeValue)) |
Instances
newItemResponse :: ItemResponse Source #
Create a value of ItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:item:ItemResponse'
, itemResponse_item
- Map of attribute data consisting of the data type and attribute value.
KeySchemaElement
data KeySchemaElement Source #
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: newKeySchemaElement
smart constructor.
Constructors
KeySchemaElement' Text KeyType |
Instances
Arguments
:: Text | |
-> KeyType | |
-> KeySchemaElement |
Create a value of KeySchemaElement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:KeySchemaElement'
, keySchemaElement_attributeName
- The name of a key attribute.
$sel:keyType:KeySchemaElement'
, keySchemaElement_keyType
- The role that this key attribute will assume:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
KeysAndAttributes
data KeysAndAttributes Source #
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: newKeysAndAttributes
smart constructor.
Constructors
KeysAndAttributes' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (NonEmpty (HashMap Text AttributeValue)) |
Instances
Arguments
:: NonEmpty (HashMap Text AttributeValue) | |
-> KeysAndAttributes |
Create a value of KeysAndAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributesToGet:KeysAndAttributes'
, keysAndAttributes_attributesToGet
- This is a legacy parameter. Use ProjectionExpression
instead. For more
information, see
Legacy Conditional Parameters
in the Amazon DynamoDB Developer Guide.
$sel:consistentRead:KeysAndAttributes'
, keysAndAttributes_consistentRead
- The consistency of a read operation. If set to true
, then a strongly
consistent read is used; otherwise, an eventually consistent read is
used.
$sel:expressionAttributeNames:KeysAndAttributes'
, keysAndAttributes_expressionAttributeNames
- 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
Tokens that begin with the : character are /expression attribute values/, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
$sel:projectionExpression:KeysAndAttributes'
, keysAndAttributes_projectionExpression
- 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.
$sel:keys:KeysAndAttributes'
, keysAndAttributes_keys
- The primary key attribute values that define the items and the
attributes associated with the items.
KinesisDataStreamDestination
data KinesisDataStreamDestination Source #
Describes a Kinesis data stream destination.
See: newKinesisDataStreamDestination
smart constructor.
Constructors
KinesisDataStreamDestination' (Maybe DestinationStatus) (Maybe Text) (Maybe Text) |
Instances
newKinesisDataStreamDestination :: KinesisDataStreamDestination Source #
Create a value of KinesisDataStreamDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationStatus:KinesisDataStreamDestination'
, kinesisDataStreamDestination_destinationStatus
- The current status of replication.
$sel:destinationStatusDescription:KinesisDataStreamDestination'
, kinesisDataStreamDestination_destinationStatusDescription
- The human-readable string that corresponds to the replica status.
$sel:streamArn:KinesisDataStreamDestination'
, kinesisDataStreamDestination_streamArn
- The ARN for a specific Kinesis data stream.
KinesisStreamingDestinationInput
data KinesisStreamingDestinationInput Source #
See: newKinesisStreamingDestinationInput
smart constructor.
Constructors
KinesisStreamingDestinationInput' Text Text |
Instances
newKinesisStreamingDestinationInput Source #
Arguments
:: Text | |
-> Text | |
-> KinesisStreamingDestinationInput |
Create a value of KinesisStreamingDestinationInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableName:KinesisStreamingDestinationInput'
, kinesisStreamingDestinationInput_tableName
- The name of the DynamoDB table.
$sel:streamArn:KinesisStreamingDestinationInput'
, kinesisStreamingDestinationInput_streamArn
- The ARN for a Kinesis data stream.
KinesisStreamingDestinationOutput
data KinesisStreamingDestinationOutput Source #
See: newKinesisStreamingDestinationOutput
smart constructor.
Constructors
KinesisStreamingDestinationOutput' (Maybe DestinationStatus) (Maybe Text) (Maybe Text) |
Instances
newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput Source #
Create a value of KinesisStreamingDestinationOutput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationStatus:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_destinationStatus
- The current status of the replication.
$sel:streamArn:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_streamArn
- The ARN for the specific Kinesis data stream.
$sel:tableName:KinesisStreamingDestinationOutput'
, kinesisStreamingDestinationOutput_tableName
- The name of the table being modified.
LocalSecondaryIndex
data LocalSecondaryIndex Source #
Represents the properties of a local secondary index.
See: newLocalSecondaryIndex
smart constructor.
Constructors
LocalSecondaryIndex' Text (NonEmpty KeySchemaElement) Projection |
Instances
newLocalSecondaryIndex Source #
Arguments
:: Text | |
-> NonEmpty KeySchemaElement | |
-> Projection | |
-> LocalSecondaryIndex |
Create a value of LocalSecondaryIndex
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:LocalSecondaryIndex'
, localSecondaryIndex_indexName
- The name of the local secondary index. The name must be unique among all
other indexes on this table.
$sel:keySchema:LocalSecondaryIndex'
, localSecondaryIndex_keySchema
- The complete key schema for the local secondary index, consisting of one
or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:LocalSecondaryIndex'
, 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 Source #
Represents the properties of a local secondary index.
See: newLocalSecondaryIndexDescription
smart constructor.
Constructors
LocalSecondaryIndexDescription' (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection) |
Instances
newLocalSecondaryIndexDescription :: LocalSecondaryIndexDescription Source #
Create a value of LocalSecondaryIndexDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexArn:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
$sel:indexName:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_indexName
- Represents the name of the local secondary index.
$sel:indexSizeBytes:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_indexSizeBytes
- The total size of the specified index, in bytes. DynamoDB updates this
value approximately every six hours. Recent changes might not be
reflected in this value.
$sel:itemCount:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_itemCount
- The number of items in the specified index. DynamoDB updates this value
approximately every six hours. Recent changes might not be reflected in
this value.
$sel:keySchema:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_keySchema
- The complete key schema for the local secondary index, consisting of one
or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:LocalSecondaryIndexDescription'
, localSecondaryIndexDescription_projection
- Represents attributes that are copied (projected) from the table into
the global secondary index. These are in addition to the primary key
attributes and index key attributes, which are automatically projected.
LocalSecondaryIndexInfo
data LocalSecondaryIndexInfo Source #
Represents the properties of a local secondary index for the table when the backup was created.
See: newLocalSecondaryIndexInfo
smart constructor.
Constructors
LocalSecondaryIndexInfo' (Maybe Text) (Maybe (NonEmpty KeySchemaElement)) (Maybe Projection) |
Instances
newLocalSecondaryIndexInfo :: LocalSecondaryIndexInfo Source #
Create a value of LocalSecondaryIndexInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:LocalSecondaryIndexInfo'
, localSecondaryIndexInfo_indexName
- Represents the name of the local secondary index.
$sel:keySchema:LocalSecondaryIndexInfo'
, localSecondaryIndexInfo_keySchema
- The complete key schema for a local secondary index, which consists of
one or more pairs of attribute names and key types:
HASH
- partition keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
$sel:projection:LocalSecondaryIndexInfo'
, localSecondaryIndexInfo_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.
ParameterizedStatement
data ParameterizedStatement Source #
Represents a PartiQL statment that uses parameters.
See: newParameterizedStatement
smart constructor.
Constructors
ParameterizedStatement' (Maybe (NonEmpty AttributeValue)) Text |
Instances
newParameterizedStatement Source #
Create a value of ParameterizedStatement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameters:ParameterizedStatement'
, parameterizedStatement_parameters
- The parameter values.
$sel:statement:ParameterizedStatement'
, parameterizedStatement_statement
- A PartiQL statment that uses parameters.
PointInTimeRecoveryDescription
data PointInTimeRecoveryDescription Source #
The description of the point in time settings applied to the table.
See: newPointInTimeRecoveryDescription
smart constructor.
Constructors
PointInTimeRecoveryDescription' (Maybe POSIX) (Maybe POSIX) (Maybe PointInTimeRecoveryStatus) |
Instances
newPointInTimeRecoveryDescription :: PointInTimeRecoveryDescription Source #
Create a value of PointInTimeRecoveryDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:earliestRestorableDateTime:PointInTimeRecoveryDescription'
, pointInTimeRecoveryDescription_earliestRestorableDateTime
- Specifies the earliest point in time you can restore your table to. You
can restore your table to any point in time during the last 35 days.
$sel:latestRestorableDateTime:PointInTimeRecoveryDescription'
, pointInTimeRecoveryDescription_latestRestorableDateTime
- LatestRestorableDateTime
is typically 5 minutes before the current
time.
$sel:pointInTimeRecoveryStatus:PointInTimeRecoveryDescription'
, pointInTimeRecoveryDescription_pointInTimeRecoveryStatus
- The current state of point in time recovery:
ENABLED
- Point in time recovery is enabled.DISABLED
- Point in time recovery is disabled.
PointInTimeRecoverySpecification
data PointInTimeRecoverySpecification Source #
Represents the settings used to enable point in time recovery.
See: newPointInTimeRecoverySpecification
smart constructor.
Constructors
PointInTimeRecoverySpecification' Bool |
Instances
newPointInTimeRecoverySpecification Source #
Arguments
:: Bool |
|
-> PointInTimeRecoverySpecification |
Create a value of PointInTimeRecoverySpecification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pointInTimeRecoveryEnabled:PointInTimeRecoverySpecification'
, pointInTimeRecoverySpecification_pointInTimeRecoveryEnabled
- Indicates whether point in time recovery is enabled (true) or disabled
(false) on the table.
Projection
data Projection Source #
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: newProjection
smart constructor.
Constructors
Projection' (Maybe (NonEmpty Text)) (Maybe ProjectionType) |
Instances
newProjection :: Projection Source #
Create a value of Projection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nonKeyAttributes:Projection'
, projection_nonKeyAttributes
- 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 100.
If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
$sel:projectionType:Projection'
, projection_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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify.ALL
- All of the table attributes are projected into the index.
ProvisionedThroughput
data ProvisionedThroughput Source #
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 Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
See: newProvisionedThroughput
smart constructor.
Constructors
ProvisionedThroughput' Natural Natural |
Instances
newProvisionedThroughput Source #
Arguments
:: Natural | |
-> Natural | |
-> ProvisionedThroughput |
Create a value of ProvisionedThroughput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readCapacityUnits:ProvisionedThroughput'
, provisionedThroughput_readCapacityUnits
- 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.
If read/write capacity mode is PAY_PER_REQUEST
the value is set to 0.
$sel:writeCapacityUnits:ProvisionedThroughput'
, provisionedThroughput_writeCapacityUnits
- 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.
If read/write capacity mode is PAY_PER_REQUEST
the value is set to 0.
ProvisionedThroughputDescription
data ProvisionedThroughputDescription Source #
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
See: newProvisionedThroughputDescription
smart constructor.
Constructors
ProvisionedThroughputDescription' (Maybe POSIX) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe Natural) |
Instances
newProvisionedThroughputDescription :: ProvisionedThroughputDescription Source #
Create a value of ProvisionedThroughputDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastDecreaseDateTime:ProvisionedThroughputDescription'
, provisionedThroughputDescription_lastDecreaseDateTime
- The date and time of the last provisioned throughput decrease for this
table.
$sel:lastIncreaseDateTime:ProvisionedThroughputDescription'
, provisionedThroughputDescription_lastIncreaseDateTime
- The date and time of the last provisioned throughput increase for this
table.
$sel:numberOfDecreasesToday:ProvisionedThroughputDescription'
, provisionedThroughputDescription_numberOfDecreasesToday
- The number of provisioned throughput decreases for this table during
this UTC calendar day. For current maximums on provisioned throughput
decreases, see
Service, Account, and Table Quotas
in the Amazon DynamoDB Developer Guide.
$sel:readCapacityUnits:ProvisionedThroughputDescription'
, provisionedThroughputDescription_readCapacityUnits
- 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.
$sel:writeCapacityUnits:ProvisionedThroughputDescription'
, provisionedThroughputDescription_writeCapacityUnits
- The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException
.
ProvisionedThroughputOverride
data ProvisionedThroughputOverride Source #
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
See: newProvisionedThroughputOverride
smart constructor.
Constructors
ProvisionedThroughputOverride' (Maybe Natural) |
Instances
newProvisionedThroughputOverride :: ProvisionedThroughputOverride Source #
Create a value of ProvisionedThroughputOverride
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:readCapacityUnits:ProvisionedThroughputOverride'
, provisionedThroughputOverride_readCapacityUnits
- Replica-specific read capacity units. If not specified, uses the source
table's read capacity settings.
Put
Represents a request to perform a PutItem
operation.
See: newPut
smart constructor.
Constructors
Put' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text |
Instances
Create a value of Put
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionExpression:Put'
, put_conditionExpression
- A condition that must be satisfied in order for a conditional update to
succeed.
$sel:expressionAttributeNames:Put'
, put_expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.
$sel:expressionAttributeValues:Put'
, put_expressionAttributeValues
- One or more values that can be substituted in an expression.
$sel:returnValuesOnConditionCheckFailure:Put'
, put_returnValuesOnConditionCheckFailure
- Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Put
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE and ALL_OLD.
$sel:item:Put'
, put_item
- A map of attribute name to attribute values, representing the primary
key of the item to be written 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
that are part of an index key schema for the table, their types must
match the index key schema.
$sel:tableName:Put'
, put_tableName
- Name of the table in which to write the item.
Replica
Represents the properties of a replica.
See: newReplica
smart constructor.
Instances
FromJSON Replica Source # | |
ToJSON Replica Source # | |
Defined in Amazonka.DynamoDB.Types.Replica | |
Generic Replica Source # | |
Read Replica Source # | |
Show Replica Source # | |
NFData Replica Source # | |
Defined in Amazonka.DynamoDB.Types.Replica | |
Eq Replica Source # | |
Hashable Replica Source # | |
Defined in Amazonka.DynamoDB.Types.Replica | |
type Rep Replica Source # | |
Defined in Amazonka.DynamoDB.Types.Replica |
newReplica :: Replica Source #
Create a value of Replica
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:regionName:Replica'
, replica_regionName
- The Region where the replica needs to be created.
ReplicaAutoScalingDescription
data ReplicaAutoScalingDescription Source #
Represents the auto scaling settings of the replica.
See: newReplicaAutoScalingDescription
smart constructor.
Constructors
Instances
newReplicaAutoScalingDescription :: ReplicaAutoScalingDescription Source #
Create a value of ReplicaAutoScalingDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexes:ReplicaAutoScalingDescription'
, replicaAutoScalingDescription_globalSecondaryIndexes
- Replica-specific global secondary index auto scaling settings.
$sel:regionName:ReplicaAutoScalingDescription'
, replicaAutoScalingDescription_regionName
- The Region where the replica exists.
$sel:replicaProvisionedReadCapacityAutoScalingSettings:ReplicaAutoScalingDescription'
, replicaAutoScalingDescription_replicaProvisionedReadCapacityAutoScalingSettings
- Undocumented member.
$sel:replicaProvisionedWriteCapacityAutoScalingSettings:ReplicaAutoScalingDescription'
, replicaAutoScalingDescription_replicaProvisionedWriteCapacityAutoScalingSettings
- Undocumented member.
$sel:replicaStatus:ReplicaAutoScalingDescription'
, replicaAutoScalingDescription_replicaStatus
- The current state of the replica:
CREATING
- The replica is being created.UPDATING
- The replica is being updated.DELETING
- The replica is being deleted.ACTIVE
- The replica is ready for use.
ReplicaAutoScalingUpdate
data ReplicaAutoScalingUpdate Source #
Represents the auto scaling settings of a replica that will be modified.
See: newReplicaAutoScalingUpdate
smart constructor.
Constructors
ReplicaAutoScalingUpdate' (Maybe [ReplicaGlobalSecondaryIndexAutoScalingUpdate]) (Maybe AutoScalingSettingsUpdate) Text |
Instances
newReplicaAutoScalingUpdate Source #
Create a value of ReplicaAutoScalingUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaGlobalSecondaryIndexUpdates:ReplicaAutoScalingUpdate'
, replicaAutoScalingUpdate_replicaGlobalSecondaryIndexUpdates
- Represents the auto scaling settings of global secondary indexes that
will be modified.
$sel:replicaProvisionedReadCapacityAutoScalingUpdate:ReplicaAutoScalingUpdate'
, replicaAutoScalingUpdate_replicaProvisionedReadCapacityAutoScalingUpdate
- Undocumented member.
$sel:regionName:ReplicaAutoScalingUpdate'
, replicaAutoScalingUpdate_regionName
- The Region where the replica exists.
ReplicaDescription
data ReplicaDescription Source #
Contains the details of the replica.
See: newReplicaDescription
smart constructor.
Constructors
Instances
newReplicaDescription :: ReplicaDescription Source #
Create a value of ReplicaDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexes:ReplicaDescription'
, replicaDescription_globalSecondaryIndexes
- Replica-specific global secondary index settings.
$sel:kmsMasterKeyId:ReplicaDescription'
, replicaDescription_kmsMasterKeyId
- The KMS key of the replica that will be used for KMS encryption.
ReplicaDescription
, replicaDescription_provisionedThroughputOverride
- Replica-specific provisioned throughput. If not described, uses the
source table's provisioned throughput settings.
$sel:regionName:ReplicaDescription'
, replicaDescription_regionName
- The name of the Region.
$sel:replicaInaccessibleDateTime:ReplicaDescription'
, replicaDescription_replicaInaccessibleDateTime
- The time at which the replica was first detected as inaccessible. To
determine cause of inaccessibility check the ReplicaStatus
property.
$sel:replicaStatus:ReplicaDescription'
, replicaDescription_replicaStatus
- The current state of the replica:
CREATING
- The replica is being created.UPDATING
- The replica is being updated.DELETING
- The replica is being deleted.ACTIVE
- The replica is ready for use.REGION_DISABLED
- The replica is inaccessible because the Amazon Web Services Region has been disabled.If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table is inaccessible.If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
$sel:replicaStatusDescription:ReplicaDescription'
, replicaDescription_replicaStatusDescription
- Detailed information about the replica status.
$sel:replicaStatusPercentProgress:ReplicaDescription'
, replicaDescription_replicaStatusPercentProgress
- Specifies the progress of a Create, Update, or Delete action on the
replica as a percentage.
$sel:replicaTableClassSummary:ReplicaDescription'
, replicaDescription_replicaTableClassSummary
- Undocumented member.
ReplicaGlobalSecondaryIndex
data ReplicaGlobalSecondaryIndex Source #
Represents the properties of a replica global secondary index.
See: newReplicaGlobalSecondaryIndex
smart constructor.
Constructors
ReplicaGlobalSecondaryIndex' (Maybe ProvisionedThroughputOverride) Text |
Instances
newReplicaGlobalSecondaryIndex Source #
Create a value of ReplicaGlobalSecondaryIndex
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:provisionedThroughputOverride:ReplicaGlobalSecondaryIndex'
, replicaGlobalSecondaryIndex_provisionedThroughputOverride
- Replica table GSI-specific provisioned throughput. If not specified,
uses the source table GSI's read capacity settings.
$sel:indexName:ReplicaGlobalSecondaryIndex'
, replicaGlobalSecondaryIndex_indexName
- The name of the global secondary index.
ReplicaGlobalSecondaryIndexAutoScalingDescription
data ReplicaGlobalSecondaryIndexAutoScalingDescription Source #
Represents the auto scaling configuration for a replica global secondary index.
See: newReplicaGlobalSecondaryIndexAutoScalingDescription
smart constructor.
Constructors
ReplicaGlobalSecondaryIndexAutoScalingDescription' (Maybe Text) (Maybe IndexStatus) (Maybe AutoScalingSettingsDescription) (Maybe AutoScalingSettingsDescription) |
Instances
newReplicaGlobalSecondaryIndexAutoScalingDescription :: ReplicaGlobalSecondaryIndexAutoScalingDescription Source #
Create a value of ReplicaGlobalSecondaryIndexAutoScalingDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:ReplicaGlobalSecondaryIndexAutoScalingDescription'
, replicaGlobalSecondaryIndexAutoScalingDescription_indexName
- The name of the global secondary index.
$sel:indexStatus:ReplicaGlobalSecondaryIndexAutoScalingDescription'
, replicaGlobalSecondaryIndexAutoScalingDescription_indexStatus
- The current state of the replica global secondary index:
CREATING
- The index is being created.UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
DELETING
- The index is being deleted.ACTIVE
- The index is ready for use.
$sel:provisionedReadCapacityAutoScalingSettings:ReplicaGlobalSecondaryIndexAutoScalingDescription'
, replicaGlobalSecondaryIndexAutoScalingDescription_provisionedReadCapacityAutoScalingSettings
- Undocumented member.
$sel:provisionedWriteCapacityAutoScalingSettings:ReplicaGlobalSecondaryIndexAutoScalingDescription'
, replicaGlobalSecondaryIndexAutoScalingDescription_provisionedWriteCapacityAutoScalingSettings
- Undocumented member.
ReplicaGlobalSecondaryIndexAutoScalingUpdate
data ReplicaGlobalSecondaryIndexAutoScalingUpdate Source #
Represents the auto scaling settings of a global secondary index for a replica that will be modified.
See: newReplicaGlobalSecondaryIndexAutoScalingUpdate
smart constructor.
Constructors
ReplicaGlobalSecondaryIndexAutoScalingUpdate' (Maybe Text) (Maybe AutoScalingSettingsUpdate) |
Instances
newReplicaGlobalSecondaryIndexAutoScalingUpdate :: ReplicaGlobalSecondaryIndexAutoScalingUpdate Source #
Create a value of ReplicaGlobalSecondaryIndexAutoScalingUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:ReplicaGlobalSecondaryIndexAutoScalingUpdate'
, replicaGlobalSecondaryIndexAutoScalingUpdate_indexName
- The name of the global secondary index.
$sel:provisionedReadCapacityAutoScalingUpdate:ReplicaGlobalSecondaryIndexAutoScalingUpdate'
, replicaGlobalSecondaryIndexAutoScalingUpdate_provisionedReadCapacityAutoScalingUpdate
- Undocumented member.
ReplicaGlobalSecondaryIndexDescription
data ReplicaGlobalSecondaryIndexDescription Source #
Represents the properties of a replica global secondary index.
See: newReplicaGlobalSecondaryIndexDescription
smart constructor.
Constructors
ReplicaGlobalSecondaryIndexDescription' (Maybe Text) (Maybe ProvisionedThroughputOverride) |
Instances
newReplicaGlobalSecondaryIndexDescription :: ReplicaGlobalSecondaryIndexDescription Source #
Create a value of ReplicaGlobalSecondaryIndexDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:ReplicaGlobalSecondaryIndexDescription'
, replicaGlobalSecondaryIndexDescription_indexName
- The name of the global secondary index.
$sel:provisionedThroughputOverride:ReplicaGlobalSecondaryIndexDescription'
, replicaGlobalSecondaryIndexDescription_provisionedThroughputOverride
- If not described, uses the source table GSI's read capacity settings.
ReplicaGlobalSecondaryIndexSettingsDescription
data ReplicaGlobalSecondaryIndexSettingsDescription Source #
Represents the properties of a global secondary index.
See: newReplicaGlobalSecondaryIndexSettingsDescription
smart constructor.
Constructors
ReplicaGlobalSecondaryIndexSettingsDescription' (Maybe IndexStatus) (Maybe AutoScalingSettingsDescription) (Maybe Natural) (Maybe AutoScalingSettingsDescription) (Maybe Natural) Text |
Instances
newReplicaGlobalSecondaryIndexSettingsDescription Source #
Arguments
:: Text |
|
-> ReplicaGlobalSecondaryIndexSettingsDescription |
Create a value of ReplicaGlobalSecondaryIndexSettingsDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexStatus:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_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.
$sel:provisionedReadCapacityAutoScalingSettings:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityAutoScalingSettings
- Auto scaling settings for a global secondary index replica's read
capacity units.
$sel:provisionedReadCapacityUnits:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityUnits
- The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException
.
$sel:provisionedWriteCapacityAutoScalingSettings:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityAutoScalingSettings
- Auto scaling settings for a global secondary index replica's write
capacity units.
$sel:provisionedWriteCapacityUnits:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityUnits
- The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException
.
$sel:indexName:ReplicaGlobalSecondaryIndexSettingsDescription'
, replicaGlobalSecondaryIndexSettingsDescription_indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.
ReplicaGlobalSecondaryIndexSettingsUpdate
data ReplicaGlobalSecondaryIndexSettingsUpdate Source #
Represents the settings of a global secondary index for a global table that will be modified.
See: newReplicaGlobalSecondaryIndexSettingsUpdate
smart constructor.
Constructors
ReplicaGlobalSecondaryIndexSettingsUpdate' (Maybe AutoScalingSettingsUpdate) (Maybe Natural) Text |
Instances
newReplicaGlobalSecondaryIndexSettingsUpdate Source #
Arguments
:: Text | |
-> ReplicaGlobalSecondaryIndexSettingsUpdate |
Create a value of ReplicaGlobalSecondaryIndexSettingsUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:provisionedReadCapacityAutoScalingSettingsUpdate:ReplicaGlobalSecondaryIndexSettingsUpdate'
, replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityAutoScalingSettingsUpdate
- Auto scaling settings for managing a global secondary index replica's
read capacity units.
$sel:provisionedReadCapacityUnits:ReplicaGlobalSecondaryIndexSettingsUpdate'
, replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityUnits
- The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException
.
$sel:indexName:ReplicaGlobalSecondaryIndexSettingsUpdate'
, replicaGlobalSecondaryIndexSettingsUpdate_indexName
- The name of the global secondary index. The name must be unique among
all other indexes on this table.
ReplicaSettingsDescription
data ReplicaSettingsDescription Source #
Represents the properties of a replica.
See: newReplicaSettingsDescription
smart constructor.
Constructors
Instances
newReplicaSettingsDescription Source #
Create a value of ReplicaSettingsDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaBillingModeSummary:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaBillingModeSummary
- The read/write capacity mode of the replica.
$sel:replicaGlobalSecondaryIndexSettings:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaGlobalSecondaryIndexSettings
- Replica global secondary index settings for the global table.
$sel:replicaProvisionedReadCapacityAutoScalingSettings:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaProvisionedReadCapacityAutoScalingSettings
- Auto scaling settings for a global table replica's read capacity units.
$sel:replicaProvisionedReadCapacityUnits:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaProvisionedReadCapacityUnits
- 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.
$sel:replicaProvisionedWriteCapacityAutoScalingSettings:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaProvisionedWriteCapacityAutoScalingSettings
- Auto scaling settings for a global table replica's write capacity
units.
$sel:replicaProvisionedWriteCapacityUnits:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaProvisionedWriteCapacityUnits
- 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.
$sel:replicaStatus:ReplicaSettingsDescription'
, replicaSettingsDescription_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.
$sel:replicaTableClassSummary:ReplicaSettingsDescription'
, replicaSettingsDescription_replicaTableClassSummary
- Undocumented member.
$sel:regionName:ReplicaSettingsDescription'
, replicaSettingsDescription_regionName
- The Region name of the replica.
ReplicaSettingsUpdate
data ReplicaSettingsUpdate Source #
Represents the settings for a global table in a Region that will be modified.
See: newReplicaSettingsUpdate
smart constructor.
Constructors
ReplicaSettingsUpdate' (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate)) (Maybe AutoScalingSettingsUpdate) (Maybe Natural) (Maybe TableClass) Text |
Instances
newReplicaSettingsUpdate Source #
Create a value of ReplicaSettingsUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaGlobalSecondaryIndexSettingsUpdate:ReplicaSettingsUpdate'
, replicaSettingsUpdate_replicaGlobalSecondaryIndexSettingsUpdate
- Represents the settings of a global secondary index for a global table
that will be modified.
$sel:replicaProvisionedReadCapacityAutoScalingSettingsUpdate:ReplicaSettingsUpdate'
, replicaSettingsUpdate_replicaProvisionedReadCapacityAutoScalingSettingsUpdate
- Auto scaling settings for managing a global table replica's read
capacity units.
$sel:replicaProvisionedReadCapacityUnits:ReplicaSettingsUpdate'
, replicaSettingsUpdate_replicaProvisionedReadCapacityUnits
- 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.
$sel:replicaTableClass:ReplicaSettingsUpdate'
, replicaSettingsUpdate_replicaTableClass
- Replica-specific table class. If not specified, uses the source table's
table class.
$sel:regionName:ReplicaSettingsUpdate'
, replicaSettingsUpdate_regionName
- The Region of the replica to be added.
ReplicaUpdate
data ReplicaUpdate Source #
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: newReplicaUpdate
smart constructor.
Constructors
ReplicaUpdate' (Maybe CreateReplicaAction) (Maybe DeleteReplicaAction) |
Instances
newReplicaUpdate :: ReplicaUpdate Source #
Create a value of ReplicaUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:create:ReplicaUpdate'
, replicaUpdate_create
- The parameters required for creating a replica on an existing global
table.
$sel:delete':ReplicaUpdate'
, replicaUpdate_delete
- The name of the existing replica to be removed.
ReplicationGroupUpdate
data ReplicationGroupUpdate Source #
Represents one of the following:
- A new replica to be added to an existing regional table or global
table. This request invokes the
CreateTableReplica
action in the destination Region. - New parameters for an existing replica. This request invokes the
UpdateTable
action in the destination Region. - An existing replica to be deleted. The request invokes the
DeleteTableReplica
action in the destination Region, deleting the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.
See: newReplicationGroupUpdate
smart constructor.
Constructors
ReplicationGroupUpdate' (Maybe CreateReplicationGroupMemberAction) (Maybe DeleteReplicationGroupMemberAction) (Maybe UpdateReplicationGroupMemberAction) |
Instances
newReplicationGroupUpdate :: ReplicationGroupUpdate Source #
Create a value of ReplicationGroupUpdate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:create:ReplicationGroupUpdate'
, replicationGroupUpdate_create
- The parameters required for creating a replica for the table.
$sel:delete':ReplicationGroupUpdate'
, replicationGroupUpdate_delete
- The parameters required for deleting a replica for the table.
$sel:update:ReplicationGroupUpdate'
, replicationGroupUpdate_update
- The parameters required for updating a replica for the table.
RestoreSummary
data RestoreSummary Source #
Contains details for the restore.
See: newRestoreSummary
smart constructor.
Instances
Arguments
:: UTCTime | |
-> Bool | |
-> RestoreSummary |
Create a value of RestoreSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceBackupArn:RestoreSummary'
, restoreSummary_sourceBackupArn
- The Amazon Resource Name (ARN) of the backup from which the table was
restored.
$sel:sourceTableArn:RestoreSummary'
, restoreSummary_sourceTableArn
- The ARN of the source table of the backup that is being restored.
$sel:restoreDateTime:RestoreSummary'
, restoreSummary_restoreDateTime
- Point in time or source backup time.
$sel:restoreInProgress:RestoreSummary'
, restoreSummary_restoreInProgress
- Indicates if a restore is in progress or not.
S3BucketSource
data S3BucketSource Source #
The S3 bucket that is being imported from.
See: newS3BucketSource
smart constructor.
Instances
Arguments
:: Text | |
-> S3BucketSource |
Create a value of S3BucketSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3BucketOwner:S3BucketSource'
, s3BucketSource_s3BucketOwner
- The account number of the S3 bucket that is being imported from. If the
bucket is owned by the requester this is optional.
$sel:s3KeyPrefix:S3BucketSource'
, s3BucketSource_s3KeyPrefix
- The key prefix shared by all S3 Objects that are being imported.
$sel:s3Bucket:S3BucketSource'
, s3BucketSource_s3Bucket
- The S3 bucket that is being imported from.
SSEDescription
data SSEDescription Source #
The description of the server-side encryption status on the specified table.
See: newSSEDescription
smart constructor.
Instances
newSSEDescription :: SSEDescription Source #
Create a value of SSEDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:inaccessibleEncryptionDateTime:SSEDescription'
, sSEDescription_inaccessibleEncryptionDateTime
- Indicates the time, in UNIX epoch date format, when DynamoDB detected
that the table's KMS key was inaccessible. This attribute will
automatically be cleared when DynamoDB detects that the table's KMS key
is accessible again. DynamoDB will initiate the table archival process
when table's KMS key remains inaccessible for more than seven days from
this date.
$sel:kmsMasterKeyArn:SSEDescription'
, sSEDescription_kmsMasterKeyArn
- The KMS key ARN used for the KMS encryption.
$sel:sSEType:SSEDescription'
, sSEDescription_sSEType
- Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
$sel:status:SSEDescription'
, sSEDescription_status
- Represents the current state of server-side encryption. The only
supported values are:
ENABLED
- Server-side encryption is enabled.UPDATING
- Server-side encryption is being updated.
SSESpecification
data SSESpecification Source #
Represents the settings used to enable server-side encryption.
See: newSSESpecification
smart constructor.
Instances
newSSESpecification :: SSESpecification Source #
Create a value of SSESpecification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SSESpecification'
, sSESpecification_enabled
- Indicates whether server-side encryption is done using an Amazon Web
Services managed key or an Amazon Web Services owned key. If enabled
(true), server-side encryption type is set to KMS
and an Amazon Web
Services managed key is used (KMS charges apply). If disabled (false) or
not specified, server-side encryption is set to Amazon Web Services
owned key.
$sel:kmsMasterKeyId:SSESpecification'
, sSESpecification_kmsMasterKeyId
- The KMS key that should be used for the KMS encryption. To specify a
key, use its key ID, Amazon Resource Name (ARN), alias name, or alias
ARN. Note that you should only provide this parameter if the key is
different from the default DynamoDB key alias/aws/dynamodb
.
$sel:sSEType:SSESpecification'
, sSESpecification_sSEType
- Server-side encryption type. The only supported value is:
KMS
- Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
SourceTableDetails
data SourceTableDetails Source #
Contains the details of the table when the backup was created.
See: newSourceTableDetails
smart constructor.
Constructors
SourceTableDetails' (Maybe BillingMode) (Maybe Natural) (Maybe Text) (Maybe Integer) Text Text (NonEmpty KeySchemaElement) POSIX ProvisionedThroughput |
Instances
newSourceTableDetails Source #
Arguments
:: Text | |
-> Text | |
-> NonEmpty KeySchemaElement | |
-> UTCTime | |
-> ProvisionedThroughput | |
-> SourceTableDetails |
Create a value of SourceTableDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billingMode:SourceTableDetails'
, sourceTableDetails_billingMode
- Controls how you are charged for read and write throughput and how you
manage capacity. This setting can be changed later.
PROVISIONED
- Sets the read/write capacity mode toPROVISIONED
. We recommend usingPROVISIONED
for predictable workloads.PAY_PER_REQUEST
- Sets the read/write capacity mode toPAY_PER_REQUEST
. We recommend usingPAY_PER_REQUEST
for unpredictable workloads.
$sel:itemCount:SourceTableDetails'
, sourceTableDetails_itemCount
- Number of items in the table. Note that this is an approximate value.
$sel:tableArn:SourceTableDetails'
, sourceTableDetails_tableArn
- ARN of the table for which backup was created.
$sel:tableSizeBytes:SourceTableDetails'
, sourceTableDetails_tableSizeBytes
- Size of the table in bytes. Note that this is an approximate value.
$sel:tableName:SourceTableDetails'
, sourceTableDetails_tableName
- The name of the table for which the backup was created.
$sel:tableId:SourceTableDetails'
, sourceTableDetails_tableId
- Unique identifier for the table for which the backup was created.
$sel:keySchema:SourceTableDetails'
, sourceTableDetails_keySchema
- Schema of the table.
$sel:tableCreationDateTime:SourceTableDetails'
, sourceTableDetails_tableCreationDateTime
- Time when the source table was created.
$sel:provisionedThroughput:SourceTableDetails'
, sourceTableDetails_provisionedThroughput
- Read IOPs and Write IOPS on the table when the backup was created.
SourceTableFeatureDetails
data SourceTableFeatureDetails Source #
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
See: newSourceTableFeatureDetails
smart constructor.
Constructors
SourceTableFeatureDetails' (Maybe [GlobalSecondaryIndexInfo]) (Maybe [LocalSecondaryIndexInfo]) (Maybe SSEDescription) (Maybe StreamSpecification) (Maybe TimeToLiveDescription) |
Instances
newSourceTableFeatureDetails :: SourceTableFeatureDetails Source #
Create a value of SourceTableFeatureDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexes:SourceTableFeatureDetails'
, sourceTableFeatureDetails_globalSecondaryIndexes
- 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.
$sel:localSecondaryIndexes:SourceTableFeatureDetails'
, sourceTableFeatureDetails_localSecondaryIndexes
- 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.
$sel:sSEDescription:SourceTableFeatureDetails'
, sourceTableFeatureDetails_sSEDescription
- The description of the server-side encryption status on the table when
the backup was created.
$sel:streamDescription:SourceTableFeatureDetails'
, sourceTableFeatureDetails_streamDescription
- Stream settings on the table when the backup was created.
$sel:timeToLiveDescription:SourceTableFeatureDetails'
, sourceTableFeatureDetails_timeToLiveDescription
- Time to Live settings on the table when the backup was created.
StreamSpecification
data StreamSpecification Source #
Represents the DynamoDB Streams configuration for a table in DynamoDB.
See: newStreamSpecification
smart constructor.
Constructors
StreamSpecification' (Maybe StreamViewType) Bool |
Instances
newStreamSpecification Source #
Create a value of StreamSpecification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:streamViewType:StreamSpecification'
, streamSpecification_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.
$sel:streamEnabled:StreamSpecification'
, streamSpecification_streamEnabled
- Indicates whether DynamoDB Streams is enabled (true) or disabled (false)
on the table.
TableAutoScalingDescription
data TableAutoScalingDescription Source #
Represents the auto scaling configuration for a global table.
See: newTableAutoScalingDescription
smart constructor.
Constructors
TableAutoScalingDescription' (Maybe [ReplicaAutoScalingDescription]) (Maybe Text) (Maybe TableStatus) |
Instances
newTableAutoScalingDescription :: TableAutoScalingDescription Source #
Create a value of TableAutoScalingDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicas:TableAutoScalingDescription'
, tableAutoScalingDescription_replicas
- Represents replicas of the global table.
$sel:tableName:TableAutoScalingDescription'
, tableAutoScalingDescription_tableName
- The name of the table.
$sel:tableStatus:TableAutoScalingDescription'
, tableAutoScalingDescription_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.
TableClassSummary
data TableClassSummary Source #
Contains details of the table class.
See: newTableClassSummary
smart constructor.
Constructors
TableClassSummary' (Maybe POSIX) (Maybe TableClass) |
Instances
newTableClassSummary :: TableClassSummary Source #
Create a value of TableClassSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdateDateTime:TableClassSummary'
, tableClassSummary_lastUpdateDateTime
- The date and time at which the table class was last updated.
$sel:tableClass:TableClassSummary'
, tableClassSummary_tableClass
- The table class of the specified table. Valid values are STANDARD
and
STANDARD_INFREQUENT_ACCESS
.
TableCreationParameters
data TableCreationParameters Source #
The parameters for the table created as part of the import operation.
See: newTableCreationParameters
smart constructor.
Constructors
TableCreationParameters' (Maybe BillingMode) (Maybe [GlobalSecondaryIndex]) (Maybe ProvisionedThroughput) (Maybe SSESpecification) Text [AttributeDefinition] (NonEmpty KeySchemaElement) |
Instances
newTableCreationParameters Source #
Arguments
:: Text | |
-> NonEmpty KeySchemaElement | |
-> TableCreationParameters |
Create a value of TableCreationParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:billingMode:TableCreationParameters'
, tableCreationParameters_billingMode
- The billing mode for provisioning the table created as part of the
import operation.
$sel:globalSecondaryIndexes:TableCreationParameters'
, tableCreationParameters_globalSecondaryIndexes
- The Global Secondary Indexes (GSI) of the table to be created as part of
the import operation.
TableCreationParameters
, tableCreationParameters_provisionedThroughput
- Undocumented member.
$sel:sSESpecification:TableCreationParameters'
, tableCreationParameters_sSESpecification
- Undocumented member.
$sel:tableName:TableCreationParameters'
, tableCreationParameters_tableName
- The name of the table created as part of the import operation.
$sel:attributeDefinitions:TableCreationParameters'
, tableCreationParameters_attributeDefinitions
- The attributes of the table created as part of the import operation.
TableCreationParameters
, tableCreationParameters_keySchema
- The primary key and option sort key of the table created as part of the
import operation.
TableDescription
data TableDescription Source #
Represents the properties of a table.
See: newTableDescription
smart constructor.
Constructors
Instances
newTableDescription :: TableDescription Source #
Create a value of TableDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:archivalSummary:TableDescription'
, tableDescription_archivalSummary
- Contains information about the table archive.
$sel:attributeDefinitions:TableDescription'
, tableDescription_attributeDefinitions
- 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.
$sel:billingModeSummary:TableDescription'
, tableDescription_billingModeSummary
- Contains the details for the read/write capacity mode.
$sel:creationDateTime:TableDescription'
, tableDescription_creationDateTime
- The date and time when the table was created, in
UNIX epoch time format.
TableDescription
, tableDescription_globalSecondaryIndexes
- 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 aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
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
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify.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 100. 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.
$sel:globalTableVersion:TableDescription'
, tableDescription_globalTableVersion
- Represents the version of
global tables
in use, if the table is replicated across Amazon Web Services Regions.
TableDescription
, tableDescription_itemCount
- 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.
TableDescription
, tableDescription_keySchema
- 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 keyRANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
$sel:latestStreamArn:TableDescription'
, tableDescription_latestStreamArn
- The Amazon Resource Name (ARN) that uniquely identifies the latest
stream for this table.
$sel:latestStreamLabel:TableDescription'
, tableDescription_latestStreamLabel
- 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:
- Amazon Web Services customer ID
- Table name
StreamLabel
$sel:localSecondaryIndexes:TableDescription'
, tableDescription_localSecondaryIndexes
- 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 is 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 100. 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.
TableDescription
, tableDescription_provisionedThroughput
- The provisioned throughput settings for the table, consisting of read
and write capacity units, along with data about increases and decreases.
$sel:replicas:TableDescription'
, tableDescription_replicas
- Represents replicas of the table.
$sel:restoreSummary:TableDescription'
, tableDescription_restoreSummary
- Contains details for the restore.
$sel:sSEDescription:TableDescription'
, tableDescription_sSEDescription
- The description of the server-side encryption status on the specified
table.
$sel:streamSpecification:TableDescription'
, tableDescription_streamSpecification
- The current DynamoDB Streams configuration for the table.
$sel:tableArn:TableDescription'
, tableDescription_tableArn
- The Amazon Resource Name (ARN) that uniquely identifies the table.
$sel:tableClassSummary:TableDescription'
, tableDescription_tableClassSummary
- Contains details of the table class.
$sel:tableId:TableDescription'
, tableDescription_tableId
- Unique identifier for the table for which the backup was created.
$sel:tableName:TableDescription'
, tableDescription_tableName
- The name of the table.
$sel:tableSizeBytes:TableDescription'
, tableDescription_tableSizeBytes
- 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.
$sel:tableStatus:TableDescription'
, tableDescription_tableStatus
- The current state of the table:
CREATING
- The table is being created.UPDATING
- The table/index configuration is being updated. The table/index remains available for data operations whenUPDATING
.DELETING
- The table is being deleted.ACTIVE
- The table is ready for use.INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete.ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
Tag
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
Amazon Web Services-assigned tag names and values are automatically
assigned the aws:
prefix, which the user cannot assign. Amazon Web
Services-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: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.DynamoDB.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.DynamoDB.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.DynamoDB.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.DynamoDB.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.DynamoDB.Types.Tag" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- 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.
$sel:value:Tag'
, tag_value
- The value of the tag. Tag values are case-sensitive and can be null.
TimeToLiveDescription
data TimeToLiveDescription Source #
The description of the Time to Live (TTL) status on the specified table.
See: newTimeToLiveDescription
smart constructor.
Constructors
TimeToLiveDescription' (Maybe Text) (Maybe TimeToLiveStatus) |
Instances
newTimeToLiveDescription :: TimeToLiveDescription Source #
Create a value of TimeToLiveDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:TimeToLiveDescription'
, timeToLiveDescription_attributeName
- The name of the TTL attribute for items in the table.
$sel:timeToLiveStatus:TimeToLiveDescription'
, timeToLiveDescription_timeToLiveStatus
- The TTL status for the table.
TimeToLiveSpecification
data TimeToLiveSpecification Source #
Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
See: newTimeToLiveSpecification
smart constructor.
Constructors
TimeToLiveSpecification' Bool Text |
Instances
newTimeToLiveSpecification Source #
Arguments
:: Bool | |
-> Text | |
-> TimeToLiveSpecification |
Create a value of TimeToLiveSpecification
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:TimeToLiveSpecification'
, timeToLiveSpecification_enabled
- Indicates whether TTL is to be enabled (true) or disabled (false) on the
table.
$sel:attributeName:TimeToLiveSpecification'
, timeToLiveSpecification_attributeName
- The name of the TTL attribute used to store the expiration time for
items in the table.
TransactGetItem
data TransactGetItem Source #
Specifies an item to be retrieved as part of the transaction.
See: newTransactGetItem
smart constructor.
Constructors
TransactGetItem' Get |
Instances
Arguments
:: Get | |
-> TransactGetItem |
Create a value of TransactGetItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:get':TransactGetItem'
, transactGetItem_get
- Contains the primary key that identifies the item to get, together with
the name of the table that contains the item, and optionally the
specific attributes of the item to retrieve.
TransactWriteItem
data TransactWriteItem Source #
A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.
See: newTransactWriteItem
smart constructor.
Constructors
TransactWriteItem' (Maybe ConditionCheck) (Maybe Delete) (Maybe Put) (Maybe Update) |
Instances
newTransactWriteItem :: TransactWriteItem Source #
Create a value of TransactWriteItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionCheck:TransactWriteItem'
, transactWriteItem_conditionCheck
- A request to perform a check item operation.
$sel:delete':TransactWriteItem'
, transactWriteItem_delete
- A request to perform a DeleteItem
operation.
$sel:put:TransactWriteItem'
, transactWriteItem_put
- A request to perform a PutItem
operation.
$sel:update:TransactWriteItem'
, transactWriteItem_update
- A request to perform an UpdateItem
operation.
Update
Represents a request to perform an UpdateItem
operation.
See: newUpdate
smart constructor.
Constructors
Update' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text AttributeValue)) (Maybe ReturnValuesOnConditionCheckFailure) (HashMap Text AttributeValue) Text Text |
Instances
Create a value of Update
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionExpression:Update'
, update_conditionExpression
- A condition that must be satisfied in order for a conditional update to
succeed.
$sel:expressionAttributeNames:Update'
, update_expressionAttributeNames
- One or more substitution tokens for attribute names in an expression.
$sel:expressionAttributeValues:Update'
, update_expressionAttributeValues
- One or more values that can be substituted in an expression.
$sel:returnValuesOnConditionCheckFailure:Update'
, update_returnValuesOnConditionCheckFailure
- Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Update
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
$sel:key:Update'
, update_key
- The primary key of the item to be updated. Each element consists of an
attribute name and a value for that attribute.
$sel:updateExpression:Update'
, update_updateExpression
- An expression that defines one or more attributes to be updated, the
action to be performed on them, and new value(s) for them.
$sel:tableName:Update'
, update_tableName
- Name of the table for the UpdateItem
request.
UpdateGlobalSecondaryIndexAction
data UpdateGlobalSecondaryIndexAction Source #
Represents the new provisioned throughput settings to be applied to a global secondary index.
See: newUpdateGlobalSecondaryIndexAction
smart constructor.
Instances
newUpdateGlobalSecondaryIndexAction Source #
Arguments
:: Text | |
-> ProvisionedThroughput |
|
-> UpdateGlobalSecondaryIndexAction |
Create a value of UpdateGlobalSecondaryIndexAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:indexName:UpdateGlobalSecondaryIndexAction'
, updateGlobalSecondaryIndexAction_indexName
- The name of the global secondary index to be updated.
$sel:provisionedThroughput:UpdateGlobalSecondaryIndexAction'
, updateGlobalSecondaryIndexAction_provisionedThroughput
- Represents the provisioned throughput settings for the specified global
secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
UpdateReplicationGroupMemberAction
data UpdateReplicationGroupMemberAction Source #
Represents a replica to be modified.
See: newUpdateReplicationGroupMemberAction
smart constructor.
Constructors
UpdateReplicationGroupMemberAction' (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) (Maybe Text) (Maybe ProvisionedThroughputOverride) (Maybe TableClass) Text |
Instances
newUpdateReplicationGroupMemberAction Source #
Arguments
:: Text | |
-> UpdateReplicationGroupMemberAction |
Create a value of UpdateReplicationGroupMemberAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSecondaryIndexes:UpdateReplicationGroupMemberAction'
, updateReplicationGroupMemberAction_globalSecondaryIndexes
- Replica-specific global secondary index settings.
$sel:kmsMasterKeyId:UpdateReplicationGroupMemberAction'
, updateReplicationGroupMemberAction_kmsMasterKeyId
- The KMS key of the replica that should be used for KMS encryption. To
specify a key, use its key ID, Amazon Resource Name (ARN), alias name,
or alias ARN. Note that you should only provide this parameter if the
key is different from the default DynamoDB KMS key
alias/aws/dynamodb
.
UpdateReplicationGroupMemberAction
, updateReplicationGroupMemberAction_provisionedThroughputOverride
- Replica-specific provisioned throughput. If not specified, uses the
source table's provisioned throughput settings.
$sel:tableClassOverride:UpdateReplicationGroupMemberAction'
, updateReplicationGroupMemberAction_tableClassOverride
- Replica-specific table class. If not specified, uses the source table's
table class.
$sel:regionName:UpdateReplicationGroupMemberAction'
, updateReplicationGroupMemberAction_regionName
- The Region where the replica exists.