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 |
- Service Configuration
- Errors
- Re-exported Types
- 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
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
- 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' {}
- newArchivalSummary :: ArchivalSummary
- archivalSummary_archivalBackupArn :: Lens' ArchivalSummary (Maybe Text)
- archivalSummary_archivalDateTime :: Lens' ArchivalSummary (Maybe UTCTime)
- archivalSummary_archivalReason :: Lens' ArchivalSummary (Maybe Text)
- data AttributeDefinition = AttributeDefinition' {}
- newAttributeDefinition :: Text -> ScalarAttributeType -> AttributeDefinition
- attributeDefinition_attributeName :: Lens' AttributeDefinition Text
- attributeDefinition_attributeType :: Lens' AttributeDefinition ScalarAttributeType
- data AttributeValueUpdate = AttributeValueUpdate' {}
- newAttributeValueUpdate :: AttributeValueUpdate
- attributeValueUpdate_action :: Lens' AttributeValueUpdate (Maybe AttributeAction)
- attributeValueUpdate_value :: Lens' AttributeValueUpdate (Maybe AttributeValue)
- data AutoScalingPolicyDescription = AutoScalingPolicyDescription' {}
- newAutoScalingPolicyDescription :: AutoScalingPolicyDescription
- autoScalingPolicyDescription_policyName :: Lens' AutoScalingPolicyDescription (Maybe Text)
- autoScalingPolicyDescription_targetTrackingScalingPolicyConfiguration :: Lens' AutoScalingPolicyDescription (Maybe AutoScalingTargetTrackingScalingPolicyConfigurationDescription)
- data AutoScalingPolicyUpdate = AutoScalingPolicyUpdate' {}
- newAutoScalingPolicyUpdate :: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate -> AutoScalingPolicyUpdate
- autoScalingPolicyUpdate_policyName :: Lens' AutoScalingPolicyUpdate (Maybe Text)
- autoScalingPolicyUpdate_targetTrackingScalingPolicyConfiguration :: Lens' AutoScalingPolicyUpdate AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
- data AutoScalingSettingsDescription = AutoScalingSettingsDescription' {}
- newAutoScalingSettingsDescription :: AutoScalingSettingsDescription
- autoScalingSettingsDescription_autoScalingDisabled :: Lens' AutoScalingSettingsDescription (Maybe Bool)
- autoScalingSettingsDescription_autoScalingRoleArn :: Lens' AutoScalingSettingsDescription (Maybe Text)
- autoScalingSettingsDescription_maximumUnits :: Lens' AutoScalingSettingsDescription (Maybe Natural)
- autoScalingSettingsDescription_minimumUnits :: Lens' AutoScalingSettingsDescription (Maybe Natural)
- autoScalingSettingsDescription_scalingPolicies :: Lens' AutoScalingSettingsDescription (Maybe [AutoScalingPolicyDescription])
- data AutoScalingSettingsUpdate = AutoScalingSettingsUpdate' {}
- newAutoScalingSettingsUpdate :: AutoScalingSettingsUpdate
- autoScalingSettingsUpdate_autoScalingDisabled :: Lens' AutoScalingSettingsUpdate (Maybe Bool)
- autoScalingSettingsUpdate_autoScalingRoleArn :: Lens' AutoScalingSettingsUpdate (Maybe Text)
- autoScalingSettingsUpdate_maximumUnits :: Lens' AutoScalingSettingsUpdate (Maybe Natural)
- autoScalingSettingsUpdate_minimumUnits :: Lens' AutoScalingSettingsUpdate (Maybe Natural)
- autoScalingSettingsUpdate_scalingPolicyUpdate :: Lens' AutoScalingSettingsUpdate (Maybe AutoScalingPolicyUpdate)
- data AutoScalingTargetTrackingScalingPolicyConfigurationDescription = AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {}
- newAutoScalingTargetTrackingScalingPolicyConfigurationDescription :: Double -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
- autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Bool)
- autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Int)
- autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Int)
- autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription Double
- data AutoScalingTargetTrackingScalingPolicyConfigurationUpdate = AutoScalingTargetTrackingScalingPolicyConfigurationUpdate' {}
- newAutoScalingTargetTrackingScalingPolicyConfigurationUpdate :: Double -> AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
- autoScalingTargetTrackingScalingPolicyConfigurationUpdate_disableScaleIn :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Bool)
- autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleInCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Int)
- autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleOutCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Int)
- autoScalingTargetTrackingScalingPolicyConfigurationUpdate_targetValue :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate Double
- data BackupDescription = BackupDescription' {}
- newBackupDescription :: BackupDescription
- backupDescription_backupDetails :: Lens' BackupDescription (Maybe BackupDetails)
- backupDescription_sourceTableDetails :: Lens' BackupDescription (Maybe SourceTableDetails)
- backupDescription_sourceTableFeatureDetails :: Lens' BackupDescription (Maybe SourceTableFeatureDetails)
- data BackupDetails = BackupDetails' {}
- newBackupDetails :: Text -> Text -> BackupStatus -> BackupType -> UTCTime -> BackupDetails
- backupDetails_backupExpiryDateTime :: Lens' BackupDetails (Maybe UTCTime)
- backupDetails_backupSizeBytes :: Lens' BackupDetails (Maybe Natural)
- backupDetails_backupArn :: Lens' BackupDetails Text
- backupDetails_backupName :: Lens' BackupDetails Text
- backupDetails_backupStatus :: Lens' BackupDetails BackupStatus
- backupDetails_backupType :: Lens' BackupDetails BackupType
- backupDetails_backupCreationDateTime :: Lens' BackupDetails UTCTime
- data BackupSummary = BackupSummary' {}
- newBackupSummary :: BackupSummary
- backupSummary_backupArn :: Lens' BackupSummary (Maybe Text)
- backupSummary_backupCreationDateTime :: Lens' BackupSummary (Maybe UTCTime)
- backupSummary_backupExpiryDateTime :: Lens' BackupSummary (Maybe UTCTime)
- backupSummary_backupName :: Lens' BackupSummary (Maybe Text)
- backupSummary_backupSizeBytes :: Lens' BackupSummary (Maybe Natural)
- backupSummary_backupStatus :: Lens' BackupSummary (Maybe BackupStatus)
- backupSummary_backupType :: Lens' BackupSummary (Maybe BackupType)
- backupSummary_tableArn :: Lens' BackupSummary (Maybe Text)
- backupSummary_tableId :: Lens' BackupSummary (Maybe Text)
- backupSummary_tableName :: Lens' BackupSummary (Maybe Text)
- data BatchStatementError = BatchStatementError' {}
- newBatchStatementError :: BatchStatementError
- batchStatementError_code :: Lens' BatchStatementError (Maybe BatchStatementErrorCodeEnum)
- batchStatementError_message :: Lens' BatchStatementError (Maybe Text)
- data BatchStatementRequest = BatchStatementRequest' {}
- newBatchStatementRequest :: Text -> BatchStatementRequest
- batchStatementRequest_consistentRead :: Lens' BatchStatementRequest (Maybe Bool)
- batchStatementRequest_parameters :: Lens' BatchStatementRequest (Maybe (NonEmpty AttributeValue))
- batchStatementRequest_statement :: Lens' BatchStatementRequest Text
- data BatchStatementResponse = BatchStatementResponse' {}
- newBatchStatementResponse :: BatchStatementResponse
- batchStatementResponse_error :: Lens' BatchStatementResponse (Maybe BatchStatementError)
- batchStatementResponse_item :: Lens' BatchStatementResponse (Maybe (HashMap Text AttributeValue))
- batchStatementResponse_tableName :: Lens' BatchStatementResponse (Maybe Text)
- data BillingModeSummary = BillingModeSummary' {}
- newBillingModeSummary :: BillingModeSummary
- billingModeSummary_billingMode :: Lens' BillingModeSummary (Maybe BillingMode)
- billingModeSummary_lastUpdateToPayPerRequestDateTime :: Lens' BillingModeSummary (Maybe UTCTime)
- data Capacity = Capacity' {}
- newCapacity :: Capacity
- capacity_capacityUnits :: Lens' Capacity (Maybe Double)
- capacity_readCapacityUnits :: Lens' Capacity (Maybe Double)
- capacity_writeCapacityUnits :: Lens' Capacity (Maybe Double)
- data Condition = Condition' {}
- newCondition :: ComparisonOperator -> Condition
- condition_attributeValueList :: Lens' Condition (Maybe [AttributeValue])
- condition_comparisonOperator :: Lens' Condition ComparisonOperator
- data ConditionCheck = ConditionCheck' {}
- newConditionCheck :: Text -> Text -> ConditionCheck
- conditionCheck_expressionAttributeNames :: Lens' ConditionCheck (Maybe (HashMap Text Text))
- conditionCheck_expressionAttributeValues :: Lens' ConditionCheck (Maybe (HashMap Text AttributeValue))
- conditionCheck_returnValuesOnConditionCheckFailure :: Lens' ConditionCheck (Maybe ReturnValuesOnConditionCheckFailure)
- conditionCheck_key :: Lens' ConditionCheck (HashMap Text AttributeValue)
- conditionCheck_tableName :: Lens' ConditionCheck Text
- conditionCheck_conditionExpression :: Lens' ConditionCheck Text
- data ConsumedCapacity = ConsumedCapacity' {}
- newConsumedCapacity :: ConsumedCapacity
- consumedCapacity_capacityUnits :: Lens' ConsumedCapacity (Maybe Double)
- consumedCapacity_globalSecondaryIndexes :: Lens' ConsumedCapacity (Maybe (HashMap Text Capacity))
- consumedCapacity_localSecondaryIndexes :: Lens' ConsumedCapacity (Maybe (HashMap Text Capacity))
- consumedCapacity_readCapacityUnits :: Lens' ConsumedCapacity (Maybe Double)
- consumedCapacity_table :: Lens' ConsumedCapacity (Maybe Capacity)
- consumedCapacity_tableName :: Lens' ConsumedCapacity (Maybe Text)
- consumedCapacity_writeCapacityUnits :: Lens' ConsumedCapacity (Maybe Double)
- data ContinuousBackupsDescription = ContinuousBackupsDescription' {}
- newContinuousBackupsDescription :: ContinuousBackupsStatus -> ContinuousBackupsDescription
- continuousBackupsDescription_pointInTimeRecoveryDescription :: Lens' ContinuousBackupsDescription (Maybe PointInTimeRecoveryDescription)
- continuousBackupsDescription_continuousBackupsStatus :: Lens' ContinuousBackupsDescription ContinuousBackupsStatus
- data ContributorInsightsSummary = ContributorInsightsSummary' {}
- newContributorInsightsSummary :: ContributorInsightsSummary
- contributorInsightsSummary_contributorInsightsStatus :: Lens' ContributorInsightsSummary (Maybe ContributorInsightsStatus)
- contributorInsightsSummary_indexName :: Lens' ContributorInsightsSummary (Maybe Text)
- contributorInsightsSummary_tableName :: Lens' ContributorInsightsSummary (Maybe Text)
- data CreateGlobalSecondaryIndexAction = CreateGlobalSecondaryIndexAction' {}
- newCreateGlobalSecondaryIndexAction :: Text -> NonEmpty KeySchemaElement -> Projection -> CreateGlobalSecondaryIndexAction
- createGlobalSecondaryIndexAction_provisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction (Maybe ProvisionedThroughput)
- createGlobalSecondaryIndexAction_indexName :: Lens' CreateGlobalSecondaryIndexAction Text
- createGlobalSecondaryIndexAction_keySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement)
- createGlobalSecondaryIndexAction_projection :: Lens' CreateGlobalSecondaryIndexAction Projection
- data CreateReplicaAction = CreateReplicaAction' {
- regionName :: Text
- newCreateReplicaAction :: Text -> CreateReplicaAction
- createReplicaAction_regionName :: Lens' CreateReplicaAction Text
- data CreateReplicationGroupMemberAction = CreateReplicationGroupMemberAction' {}
- newCreateReplicationGroupMemberAction :: Text -> CreateReplicationGroupMemberAction
- createReplicationGroupMemberAction_globalSecondaryIndexes :: Lens' CreateReplicationGroupMemberAction (Maybe (NonEmpty ReplicaGlobalSecondaryIndex))
- createReplicationGroupMemberAction_kmsMasterKeyId :: Lens' CreateReplicationGroupMemberAction (Maybe Text)
- createReplicationGroupMemberAction_provisionedThroughputOverride :: Lens' CreateReplicationGroupMemberAction (Maybe ProvisionedThroughputOverride)
- createReplicationGroupMemberAction_tableClassOverride :: Lens' CreateReplicationGroupMemberAction (Maybe TableClass)
- createReplicationGroupMemberAction_regionName :: Lens' CreateReplicationGroupMemberAction Text
- data CsvOptions = CsvOptions' {}
- newCsvOptions :: CsvOptions
- csvOptions_delimiter :: Lens' CsvOptions (Maybe Text)
- csvOptions_headerList :: Lens' CsvOptions (Maybe (NonEmpty Text))
- data Delete = Delete' {}
- newDelete :: Text -> Delete
- delete_conditionExpression :: Lens' Delete (Maybe Text)
- delete_expressionAttributeNames :: Lens' Delete (Maybe (HashMap Text Text))
- delete_expressionAttributeValues :: Lens' Delete (Maybe (HashMap Text AttributeValue))
- delete_returnValuesOnConditionCheckFailure :: Lens' Delete (Maybe ReturnValuesOnConditionCheckFailure)
- delete_key :: Lens' Delete (HashMap Text AttributeValue)
- delete_tableName :: Lens' Delete Text
- data DeleteGlobalSecondaryIndexAction = DeleteGlobalSecondaryIndexAction' {}
- newDeleteGlobalSecondaryIndexAction :: Text -> DeleteGlobalSecondaryIndexAction
- deleteGlobalSecondaryIndexAction_indexName :: Lens' DeleteGlobalSecondaryIndexAction Text
- data DeleteReplicaAction = DeleteReplicaAction' {
- regionName :: Text
- newDeleteReplicaAction :: Text -> DeleteReplicaAction
- deleteReplicaAction_regionName :: Lens' DeleteReplicaAction Text
- data DeleteReplicationGroupMemberAction = DeleteReplicationGroupMemberAction' {
- regionName :: Text
- newDeleteReplicationGroupMemberAction :: Text -> DeleteReplicationGroupMemberAction
- deleteReplicationGroupMemberAction_regionName :: Lens' DeleteReplicationGroupMemberAction Text
- data Endpoint = Endpoint' {}
- newEndpoint :: Text -> Integer -> Endpoint
- endpoint_address :: Lens' Endpoint Text
- endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer
- data ExpectedAttributeValue = ExpectedAttributeValue' {}
- newExpectedAttributeValue :: ExpectedAttributeValue
- expectedAttributeValue_attributeValueList :: Lens' ExpectedAttributeValue (Maybe [AttributeValue])
- expectedAttributeValue_comparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator)
- expectedAttributeValue_exists :: Lens' ExpectedAttributeValue (Maybe Bool)
- expectedAttributeValue_value :: Lens' ExpectedAttributeValue (Maybe AttributeValue)
- data ExportDescription = ExportDescription' {
- billedSizeBytes :: Maybe Natural
- clientToken :: Maybe Text
- endTime :: Maybe POSIX
- exportArn :: Maybe Text
- exportFormat :: Maybe ExportFormat
- exportManifest :: Maybe Text
- exportStatus :: Maybe ExportStatus
- exportTime :: Maybe POSIX
- failureCode :: Maybe Text
- failureMessage :: Maybe Text
- itemCount :: Maybe Natural
- s3Bucket :: Maybe Text
- s3BucketOwner :: Maybe Text
- s3Prefix :: Maybe Text
- s3SseAlgorithm :: Maybe S3SseAlgorithm
- s3SseKmsKeyId :: Maybe Text
- startTime :: Maybe POSIX
- tableArn :: Maybe Text
- tableId :: Maybe Text
- newExportDescription :: ExportDescription
- exportDescription_billedSizeBytes :: Lens' ExportDescription (Maybe Natural)
- exportDescription_clientToken :: Lens' ExportDescription (Maybe Text)
- exportDescription_endTime :: Lens' ExportDescription (Maybe UTCTime)
- exportDescription_exportArn :: Lens' ExportDescription (Maybe Text)
- exportDescription_exportFormat :: Lens' ExportDescription (Maybe ExportFormat)
- exportDescription_exportManifest :: Lens' ExportDescription (Maybe Text)
- exportDescription_exportStatus :: Lens' ExportDescription (Maybe ExportStatus)
- exportDescription_exportTime :: Lens' ExportDescription (Maybe UTCTime)
- exportDescription_failureCode :: Lens' ExportDescription (Maybe Text)
- exportDescription_failureMessage :: Lens' ExportDescription (Maybe Text)
- exportDescription_itemCount :: Lens' ExportDescription (Maybe Natural)
- exportDescription_s3Bucket :: Lens' ExportDescription (Maybe Text)
- exportDescription_s3BucketOwner :: Lens' ExportDescription (Maybe Text)
- exportDescription_s3Prefix :: Lens' ExportDescription (Maybe Text)
- exportDescription_s3SseAlgorithm :: Lens' ExportDescription (Maybe S3SseAlgorithm)
- exportDescription_s3SseKmsKeyId :: Lens' ExportDescription (Maybe Text)
- exportDescription_startTime :: Lens' ExportDescription (Maybe UTCTime)
- exportDescription_tableArn :: Lens' ExportDescription (Maybe Text)
- exportDescription_tableId :: Lens' ExportDescription (Maybe Text)
- data ExportSummary = ExportSummary' {}
- newExportSummary :: ExportSummary
- exportSummary_exportArn :: Lens' ExportSummary (Maybe Text)
- exportSummary_exportStatus :: Lens' ExportSummary (Maybe ExportStatus)
- data FailureException = FailureException' {}
- newFailureException :: FailureException
- failureException_exceptionDescription :: Lens' FailureException (Maybe Text)
- failureException_exceptionName :: Lens' FailureException (Maybe Text)
- data Get = Get' {}
- newGet :: Text -> Get
- get_expressionAttributeNames :: Lens' Get (Maybe (HashMap Text Text))
- get_projectionExpression :: Lens' Get (Maybe Text)
- get_key :: Lens' Get (HashMap Text AttributeValue)
- get_tableName :: Lens' Get Text
- data GlobalSecondaryIndex = GlobalSecondaryIndex' {}
- newGlobalSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> GlobalSecondaryIndex
- globalSecondaryIndex_provisionedThroughput :: Lens' GlobalSecondaryIndex (Maybe ProvisionedThroughput)
- globalSecondaryIndex_indexName :: Lens' GlobalSecondaryIndex Text
- globalSecondaryIndex_keySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement)
- globalSecondaryIndex_projection :: Lens' GlobalSecondaryIndex Projection
- data GlobalSecondaryIndexAutoScalingUpdate = GlobalSecondaryIndexAutoScalingUpdate' {}
- newGlobalSecondaryIndexAutoScalingUpdate :: GlobalSecondaryIndexAutoScalingUpdate
- globalSecondaryIndexAutoScalingUpdate_indexName :: Lens' GlobalSecondaryIndexAutoScalingUpdate (Maybe Text)
- globalSecondaryIndexAutoScalingUpdate_provisionedWriteCapacityAutoScalingUpdate :: Lens' GlobalSecondaryIndexAutoScalingUpdate (Maybe AutoScalingSettingsUpdate)
- data GlobalSecondaryIndexDescription = GlobalSecondaryIndexDescription' {}
- newGlobalSecondaryIndexDescription :: GlobalSecondaryIndexDescription
- globalSecondaryIndexDescription_backfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool)
- globalSecondaryIndexDescription_indexArn :: Lens' GlobalSecondaryIndexDescription (Maybe Text)
- globalSecondaryIndexDescription_indexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text)
- globalSecondaryIndexDescription_indexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- globalSecondaryIndexDescription_indexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus)
- globalSecondaryIndexDescription_itemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer)
- globalSecondaryIndexDescription_keySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement))
- globalSecondaryIndexDescription_projection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection)
- globalSecondaryIndexDescription_provisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription)
- data GlobalSecondaryIndexInfo = GlobalSecondaryIndexInfo' {}
- newGlobalSecondaryIndexInfo :: GlobalSecondaryIndexInfo
- globalSecondaryIndexInfo_indexName :: Lens' GlobalSecondaryIndexInfo (Maybe Text)
- globalSecondaryIndexInfo_keySchema :: Lens' GlobalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement))
- globalSecondaryIndexInfo_projection :: Lens' GlobalSecondaryIndexInfo (Maybe Projection)
- globalSecondaryIndexInfo_provisionedThroughput :: Lens' GlobalSecondaryIndexInfo (Maybe ProvisionedThroughput)
- data GlobalSecondaryIndexUpdate = GlobalSecondaryIndexUpdate' {}
- newGlobalSecondaryIndexUpdate :: GlobalSecondaryIndexUpdate
- globalSecondaryIndexUpdate_create :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction)
- globalSecondaryIndexUpdate_delete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction)
- globalSecondaryIndexUpdate_update :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction)
- data GlobalTable = GlobalTable' {}
- newGlobalTable :: GlobalTable
- globalTable_globalTableName :: Lens' GlobalTable (Maybe Text)
- globalTable_replicationGroup :: Lens' GlobalTable (Maybe [Replica])
- data GlobalTableDescription = GlobalTableDescription' {}
- newGlobalTableDescription :: GlobalTableDescription
- globalTableDescription_creationDateTime :: Lens' GlobalTableDescription (Maybe UTCTime)
- globalTableDescription_globalTableArn :: Lens' GlobalTableDescription (Maybe Text)
- globalTableDescription_globalTableName :: Lens' GlobalTableDescription (Maybe Text)
- globalTableDescription_globalTableStatus :: Lens' GlobalTableDescription (Maybe GlobalTableStatus)
- globalTableDescription_replicationGroup :: Lens' GlobalTableDescription (Maybe [ReplicaDescription])
- data GlobalTableGlobalSecondaryIndexSettingsUpdate = GlobalTableGlobalSecondaryIndexSettingsUpdate' {}
- newGlobalTableGlobalSecondaryIndexSettingsUpdate :: Text -> GlobalTableGlobalSecondaryIndexSettingsUpdate
- globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityAutoScalingSettingsUpdate :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe AutoScalingSettingsUpdate)
- globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityUnits :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe Natural)
- globalTableGlobalSecondaryIndexSettingsUpdate_indexName :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate Text
- data ImportSummary = ImportSummary' {}
- newImportSummary :: ImportSummary
- importSummary_cloudWatchLogGroupArn :: Lens' ImportSummary (Maybe Text)
- importSummary_endTime :: Lens' ImportSummary (Maybe UTCTime)
- importSummary_importArn :: Lens' ImportSummary (Maybe Text)
- importSummary_importStatus :: Lens' ImportSummary (Maybe ImportStatus)
- importSummary_inputFormat :: Lens' ImportSummary (Maybe InputFormat)
- importSummary_s3BucketSource :: Lens' ImportSummary (Maybe S3BucketSource)
- importSummary_startTime :: Lens' ImportSummary (Maybe UTCTime)
- importSummary_tableArn :: Lens' ImportSummary (Maybe Text)
- data ImportTableDescription = ImportTableDescription' {
- clientToken :: Maybe Text
- cloudWatchLogGroupArn :: Maybe Text
- endTime :: Maybe POSIX
- errorCount :: Maybe Natural
- failureCode :: Maybe Text
- failureMessage :: Maybe Text
- importArn :: Maybe Text
- importStatus :: Maybe ImportStatus
- importedItemCount :: Maybe Natural
- inputCompressionType :: Maybe InputCompressionType
- inputFormat :: Maybe InputFormat
- inputFormatOptions :: Maybe InputFormatOptions
- processedItemCount :: Maybe Natural
- processedSizeBytes :: Maybe Integer
- s3BucketSource :: Maybe S3BucketSource
- startTime :: Maybe POSIX
- tableArn :: Maybe Text
- tableCreationParameters :: Maybe TableCreationParameters
- tableId :: Maybe Text
- newImportTableDescription :: ImportTableDescription
- importTableDescription_clientToken :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_cloudWatchLogGroupArn :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_endTime :: Lens' ImportTableDescription (Maybe UTCTime)
- importTableDescription_errorCount :: Lens' ImportTableDescription (Maybe Natural)
- importTableDescription_failureCode :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_failureMessage :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_importArn :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_importStatus :: Lens' ImportTableDescription (Maybe ImportStatus)
- importTableDescription_importedItemCount :: Lens' ImportTableDescription (Maybe Natural)
- importTableDescription_inputCompressionType :: Lens' ImportTableDescription (Maybe InputCompressionType)
- importTableDescription_inputFormat :: Lens' ImportTableDescription (Maybe InputFormat)
- importTableDescription_inputFormatOptions :: Lens' ImportTableDescription (Maybe InputFormatOptions)
- importTableDescription_processedItemCount :: Lens' ImportTableDescription (Maybe Natural)
- importTableDescription_processedSizeBytes :: Lens' ImportTableDescription (Maybe Integer)
- importTableDescription_s3BucketSource :: Lens' ImportTableDescription (Maybe S3BucketSource)
- importTableDescription_startTime :: Lens' ImportTableDescription (Maybe UTCTime)
- importTableDescription_tableArn :: Lens' ImportTableDescription (Maybe Text)
- importTableDescription_tableCreationParameters :: Lens' ImportTableDescription (Maybe TableCreationParameters)
- importTableDescription_tableId :: Lens' ImportTableDescription (Maybe Text)
- data InputFormatOptions = InputFormatOptions' {
- csv :: Maybe CsvOptions
- newInputFormatOptions :: InputFormatOptions
- inputFormatOptions_csv :: Lens' InputFormatOptions (Maybe CsvOptions)
- data ItemCollectionMetrics = ItemCollectionMetrics' {}
- newItemCollectionMetrics :: ItemCollectionMetrics
- itemCollectionMetrics_itemCollectionKey :: Lens' ItemCollectionMetrics (Maybe (HashMap Text AttributeValue))
- itemCollectionMetrics_sizeEstimateRangeGB :: Lens' ItemCollectionMetrics (Maybe [Double])
- data ItemResponse = ItemResponse' {
- item :: Maybe (HashMap Text AttributeValue)
- newItemResponse :: ItemResponse
- itemResponse_item :: Lens' ItemResponse (Maybe (HashMap Text AttributeValue))
- data KeySchemaElement = KeySchemaElement' {
- attributeName :: Text
- keyType :: KeyType
- newKeySchemaElement :: Text -> KeyType -> KeySchemaElement
- keySchemaElement_attributeName :: Lens' KeySchemaElement Text
- keySchemaElement_keyType :: Lens' KeySchemaElement KeyType
- data KeysAndAttributes = KeysAndAttributes' {}
- newKeysAndAttributes :: NonEmpty (HashMap Text AttributeValue) -> KeysAndAttributes
- keysAndAttributes_attributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text))
- keysAndAttributes_consistentRead :: Lens' KeysAndAttributes (Maybe Bool)
- keysAndAttributes_expressionAttributeNames :: Lens' KeysAndAttributes (Maybe (HashMap Text Text))
- keysAndAttributes_projectionExpression :: Lens' KeysAndAttributes (Maybe Text)
- keysAndAttributes_keys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue))
- data KinesisDataStreamDestination = KinesisDataStreamDestination' {}
- newKinesisDataStreamDestination :: KinesisDataStreamDestination
- kinesisDataStreamDestination_destinationStatus :: Lens' KinesisDataStreamDestination (Maybe DestinationStatus)
- kinesisDataStreamDestination_destinationStatusDescription :: Lens' KinesisDataStreamDestination (Maybe Text)
- kinesisDataStreamDestination_streamArn :: Lens' KinesisDataStreamDestination (Maybe Text)
- data KinesisStreamingDestinationInput = KinesisStreamingDestinationInput' {}
- newKinesisStreamingDestinationInput :: Text -> Text -> KinesisStreamingDestinationInput
- kinesisStreamingDestinationInput_tableName :: Lens' KinesisStreamingDestinationInput Text
- kinesisStreamingDestinationInput_streamArn :: Lens' KinesisStreamingDestinationInput Text
- data KinesisStreamingDestinationOutput = KinesisStreamingDestinationOutput' {}
- newKinesisStreamingDestinationOutput :: KinesisStreamingDestinationOutput
- kinesisStreamingDestinationOutput_destinationStatus :: Lens' KinesisStreamingDestinationOutput (Maybe DestinationStatus)
- kinesisStreamingDestinationOutput_streamArn :: Lens' KinesisStreamingDestinationOutput (Maybe Text)
- kinesisStreamingDestinationOutput_tableName :: Lens' KinesisStreamingDestinationOutput (Maybe Text)
- data LocalSecondaryIndex = LocalSecondaryIndex' {}
- newLocalSecondaryIndex :: Text -> NonEmpty KeySchemaElement -> Projection -> LocalSecondaryIndex
- localSecondaryIndex_indexName :: Lens' LocalSecondaryIndex Text
- localSecondaryIndex_keySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement)
- localSecondaryIndex_projection :: Lens' LocalSecondaryIndex Projection
- data LocalSecondaryIndexDescription = LocalSecondaryIndexDescription' {}
- newLocalSecondaryIndexDescription :: LocalSecondaryIndexDescription
- localSecondaryIndexDescription_indexArn :: Lens' LocalSecondaryIndexDescription (Maybe Text)
- localSecondaryIndexDescription_indexName :: Lens' LocalSecondaryIndexDescription (Maybe Text)
- localSecondaryIndexDescription_indexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- localSecondaryIndexDescription_itemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer)
- localSecondaryIndexDescription_keySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement))
- localSecondaryIndexDescription_projection :: Lens' LocalSecondaryIndexDescription (Maybe Projection)
- data LocalSecondaryIndexInfo = LocalSecondaryIndexInfo' {}
- newLocalSecondaryIndexInfo :: LocalSecondaryIndexInfo
- localSecondaryIndexInfo_indexName :: Lens' LocalSecondaryIndexInfo (Maybe Text)
- localSecondaryIndexInfo_keySchema :: Lens' LocalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement))
- localSecondaryIndexInfo_projection :: Lens' LocalSecondaryIndexInfo (Maybe Projection)
- data ParameterizedStatement = ParameterizedStatement' {}
- newParameterizedStatement :: Text -> ParameterizedStatement
- parameterizedStatement_parameters :: Lens' ParameterizedStatement (Maybe (NonEmpty AttributeValue))
- parameterizedStatement_statement :: Lens' ParameterizedStatement Text
- data PointInTimeRecoveryDescription = PointInTimeRecoveryDescription' {}
- newPointInTimeRecoveryDescription :: PointInTimeRecoveryDescription
- pointInTimeRecoveryDescription_earliestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime)
- pointInTimeRecoveryDescription_latestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime)
- pointInTimeRecoveryDescription_pointInTimeRecoveryStatus :: Lens' PointInTimeRecoveryDescription (Maybe PointInTimeRecoveryStatus)
- data PointInTimeRecoverySpecification = PointInTimeRecoverySpecification' {}
- newPointInTimeRecoverySpecification :: Bool -> PointInTimeRecoverySpecification
- pointInTimeRecoverySpecification_pointInTimeRecoveryEnabled :: Lens' PointInTimeRecoverySpecification Bool
- data Projection = Projection' {}
- newProjection :: Projection
- projection_nonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text))
- projection_projectionType :: Lens' Projection (Maybe ProjectionType)
- data ProvisionedThroughput = ProvisionedThroughput' {}
- newProvisionedThroughput :: Natural -> Natural -> ProvisionedThroughput
- provisionedThroughput_readCapacityUnits :: Lens' ProvisionedThroughput Natural
- provisionedThroughput_writeCapacityUnits :: Lens' ProvisionedThroughput Natural
- data ProvisionedThroughputDescription = ProvisionedThroughputDescription' {}
- newProvisionedThroughputDescription :: ProvisionedThroughputDescription
- provisionedThroughputDescription_lastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- provisionedThroughputDescription_lastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime)
- provisionedThroughputDescription_numberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- provisionedThroughputDescription_readCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- provisionedThroughputDescription_writeCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural)
- data ProvisionedThroughputOverride = ProvisionedThroughputOverride' {}
- newProvisionedThroughputOverride :: ProvisionedThroughputOverride
- provisionedThroughputOverride_readCapacityUnits :: Lens' ProvisionedThroughputOverride (Maybe Natural)
- data Put = Put' {}
- newPut :: Text -> Put
- put_conditionExpression :: Lens' Put (Maybe Text)
- put_expressionAttributeNames :: Lens' Put (Maybe (HashMap Text Text))
- put_expressionAttributeValues :: Lens' Put (Maybe (HashMap Text AttributeValue))
- put_returnValuesOnConditionCheckFailure :: Lens' Put (Maybe ReturnValuesOnConditionCheckFailure)
- put_item :: Lens' Put (HashMap Text AttributeValue)
- put_tableName :: Lens' Put Text
- data Replica = Replica' {
- regionName :: Maybe Text
- newReplica :: Replica
- replica_regionName :: Lens' Replica (Maybe Text)
- data ReplicaAutoScalingDescription = ReplicaAutoScalingDescription' {
- globalSecondaryIndexes :: Maybe [ReplicaGlobalSecondaryIndexAutoScalingDescription]
- regionName :: Maybe Text
- replicaProvisionedReadCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- replicaProvisionedWriteCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- replicaStatus :: Maybe ReplicaStatus
- newReplicaAutoScalingDescription :: ReplicaAutoScalingDescription
- replicaAutoScalingDescription_globalSecondaryIndexes :: Lens' ReplicaAutoScalingDescription (Maybe [ReplicaGlobalSecondaryIndexAutoScalingDescription])
- replicaAutoScalingDescription_regionName :: Lens' ReplicaAutoScalingDescription (Maybe Text)
- replicaAutoScalingDescription_replicaProvisionedReadCapacityAutoScalingSettings :: Lens' ReplicaAutoScalingDescription (Maybe AutoScalingSettingsDescription)
- replicaAutoScalingDescription_replicaProvisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaAutoScalingDescription (Maybe AutoScalingSettingsDescription)
- replicaAutoScalingDescription_replicaStatus :: Lens' ReplicaAutoScalingDescription (Maybe ReplicaStatus)
- data ReplicaAutoScalingUpdate = ReplicaAutoScalingUpdate' {}
- newReplicaAutoScalingUpdate :: Text -> ReplicaAutoScalingUpdate
- replicaAutoScalingUpdate_replicaGlobalSecondaryIndexUpdates :: Lens' ReplicaAutoScalingUpdate (Maybe [ReplicaGlobalSecondaryIndexAutoScalingUpdate])
- replicaAutoScalingUpdate_replicaProvisionedReadCapacityAutoScalingUpdate :: Lens' ReplicaAutoScalingUpdate (Maybe AutoScalingSettingsUpdate)
- replicaAutoScalingUpdate_regionName :: Lens' ReplicaAutoScalingUpdate Text
- data ReplicaDescription = ReplicaDescription' {
- globalSecondaryIndexes :: Maybe [ReplicaGlobalSecondaryIndexDescription]
- kmsMasterKeyId :: Maybe Text
- provisionedThroughputOverride :: Maybe ProvisionedThroughputOverride
- regionName :: Maybe Text
- replicaInaccessibleDateTime :: Maybe POSIX
- replicaStatus :: Maybe ReplicaStatus
- replicaStatusDescription :: Maybe Text
- replicaStatusPercentProgress :: Maybe Text
- replicaTableClassSummary :: Maybe TableClassSummary
- newReplicaDescription :: ReplicaDescription
- replicaDescription_globalSecondaryIndexes :: Lens' ReplicaDescription (Maybe [ReplicaGlobalSecondaryIndexDescription])
- replicaDescription_kmsMasterKeyId :: Lens' ReplicaDescription (Maybe Text)
- replicaDescription_provisionedThroughputOverride :: Lens' ReplicaDescription (Maybe ProvisionedThroughputOverride)
- replicaDescription_regionName :: Lens' ReplicaDescription (Maybe Text)
- replicaDescription_replicaInaccessibleDateTime :: Lens' ReplicaDescription (Maybe UTCTime)
- replicaDescription_replicaStatus :: Lens' ReplicaDescription (Maybe ReplicaStatus)
- replicaDescription_replicaStatusDescription :: Lens' ReplicaDescription (Maybe Text)
- replicaDescription_replicaStatusPercentProgress :: Lens' ReplicaDescription (Maybe Text)
- replicaDescription_replicaTableClassSummary :: Lens' ReplicaDescription (Maybe TableClassSummary)
- data ReplicaGlobalSecondaryIndex = ReplicaGlobalSecondaryIndex' {}
- newReplicaGlobalSecondaryIndex :: Text -> ReplicaGlobalSecondaryIndex
- replicaGlobalSecondaryIndex_provisionedThroughputOverride :: Lens' ReplicaGlobalSecondaryIndex (Maybe ProvisionedThroughputOverride)
- replicaGlobalSecondaryIndex_indexName :: Lens' ReplicaGlobalSecondaryIndex Text
- data ReplicaGlobalSecondaryIndexAutoScalingDescription = ReplicaGlobalSecondaryIndexAutoScalingDescription' {}
- newReplicaGlobalSecondaryIndexAutoScalingDescription :: ReplicaGlobalSecondaryIndexAutoScalingDescription
- replicaGlobalSecondaryIndexAutoScalingDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe Text)
- replicaGlobalSecondaryIndexAutoScalingDescription_indexStatus :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe IndexStatus)
- replicaGlobalSecondaryIndexAutoScalingDescription_provisionedReadCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe AutoScalingSettingsDescription)
- replicaGlobalSecondaryIndexAutoScalingDescription_provisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe AutoScalingSettingsDescription)
- data ReplicaGlobalSecondaryIndexAutoScalingUpdate = ReplicaGlobalSecondaryIndexAutoScalingUpdate' {}
- newReplicaGlobalSecondaryIndexAutoScalingUpdate :: ReplicaGlobalSecondaryIndexAutoScalingUpdate
- replicaGlobalSecondaryIndexAutoScalingUpdate_indexName :: Lens' ReplicaGlobalSecondaryIndexAutoScalingUpdate (Maybe Text)
- replicaGlobalSecondaryIndexAutoScalingUpdate_provisionedReadCapacityAutoScalingUpdate :: Lens' ReplicaGlobalSecondaryIndexAutoScalingUpdate (Maybe AutoScalingSettingsUpdate)
- data ReplicaGlobalSecondaryIndexDescription = ReplicaGlobalSecondaryIndexDescription' {}
- newReplicaGlobalSecondaryIndexDescription :: ReplicaGlobalSecondaryIndexDescription
- replicaGlobalSecondaryIndexDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexDescription (Maybe Text)
- replicaGlobalSecondaryIndexDescription_provisionedThroughputOverride :: Lens' ReplicaGlobalSecondaryIndexDescription (Maybe ProvisionedThroughputOverride)
- data ReplicaGlobalSecondaryIndexSettingsDescription = ReplicaGlobalSecondaryIndexSettingsDescription' {
- indexStatus :: Maybe IndexStatus
- provisionedReadCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- provisionedReadCapacityUnits :: Maybe Natural
- provisionedWriteCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- provisionedWriteCapacityUnits :: Maybe Natural
- indexName :: Text
- newReplicaGlobalSecondaryIndexSettingsDescription :: Text -> ReplicaGlobalSecondaryIndexSettingsDescription
- replicaGlobalSecondaryIndexSettingsDescription_indexStatus :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe IndexStatus)
- replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe AutoScalingSettingsDescription)
- replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural)
- replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe AutoScalingSettingsDescription)
- replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural)
- replicaGlobalSecondaryIndexSettingsDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription Text
- data ReplicaGlobalSecondaryIndexSettingsUpdate = ReplicaGlobalSecondaryIndexSettingsUpdate' {}
- newReplicaGlobalSecondaryIndexSettingsUpdate :: Text -> ReplicaGlobalSecondaryIndexSettingsUpdate
- replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityAutoScalingSettingsUpdate :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe AutoScalingSettingsUpdate)
- replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe Natural)
- replicaGlobalSecondaryIndexSettingsUpdate_indexName :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate Text
- data ReplicaSettingsDescription = ReplicaSettingsDescription' {
- replicaBillingModeSummary :: Maybe BillingModeSummary
- replicaGlobalSecondaryIndexSettings :: Maybe [ReplicaGlobalSecondaryIndexSettingsDescription]
- replicaProvisionedReadCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- replicaProvisionedReadCapacityUnits :: Maybe Natural
- replicaProvisionedWriteCapacityAutoScalingSettings :: Maybe AutoScalingSettingsDescription
- replicaProvisionedWriteCapacityUnits :: Maybe Natural
- replicaStatus :: Maybe ReplicaStatus
- replicaTableClassSummary :: Maybe TableClassSummary
- regionName :: Text
- newReplicaSettingsDescription :: Text -> ReplicaSettingsDescription
- replicaSettingsDescription_replicaBillingModeSummary :: Lens' ReplicaSettingsDescription (Maybe BillingModeSummary)
- replicaSettingsDescription_replicaGlobalSecondaryIndexSettings :: Lens' ReplicaSettingsDescription (Maybe [ReplicaGlobalSecondaryIndexSettingsDescription])
- replicaSettingsDescription_replicaProvisionedReadCapacityAutoScalingSettings :: Lens' ReplicaSettingsDescription (Maybe AutoScalingSettingsDescription)
- replicaSettingsDescription_replicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural)
- replicaSettingsDescription_replicaProvisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaSettingsDescription (Maybe AutoScalingSettingsDescription)
- replicaSettingsDescription_replicaProvisionedWriteCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural)
- replicaSettingsDescription_replicaStatus :: Lens' ReplicaSettingsDescription (Maybe ReplicaStatus)
- replicaSettingsDescription_replicaTableClassSummary :: Lens' ReplicaSettingsDescription (Maybe TableClassSummary)
- replicaSettingsDescription_regionName :: Lens' ReplicaSettingsDescription Text
- data ReplicaSettingsUpdate = ReplicaSettingsUpdate' {
- replicaGlobalSecondaryIndexSettingsUpdate :: Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate)
- replicaProvisionedReadCapacityAutoScalingSettingsUpdate :: Maybe AutoScalingSettingsUpdate
- replicaProvisionedReadCapacityUnits :: Maybe Natural
- replicaTableClass :: Maybe TableClass
- regionName :: Text
- newReplicaSettingsUpdate :: Text -> ReplicaSettingsUpdate
- replicaSettingsUpdate_replicaGlobalSecondaryIndexSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate))
- replicaSettingsUpdate_replicaProvisionedReadCapacityAutoScalingSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe AutoScalingSettingsUpdate)
- replicaSettingsUpdate_replicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsUpdate (Maybe Natural)
- replicaSettingsUpdate_replicaTableClass :: Lens' ReplicaSettingsUpdate (Maybe TableClass)
- replicaSettingsUpdate_regionName :: Lens' ReplicaSettingsUpdate Text
- data ReplicaUpdate = ReplicaUpdate' {}
- newReplicaUpdate :: ReplicaUpdate
- replicaUpdate_create :: Lens' ReplicaUpdate (Maybe CreateReplicaAction)
- replicaUpdate_delete :: Lens' ReplicaUpdate (Maybe DeleteReplicaAction)
- data ReplicationGroupUpdate = ReplicationGroupUpdate' {}
- newReplicationGroupUpdate :: ReplicationGroupUpdate
- replicationGroupUpdate_create :: Lens' ReplicationGroupUpdate (Maybe CreateReplicationGroupMemberAction)
- replicationGroupUpdate_delete :: Lens' ReplicationGroupUpdate (Maybe DeleteReplicationGroupMemberAction)
- replicationGroupUpdate_update :: Lens' ReplicationGroupUpdate (Maybe UpdateReplicationGroupMemberAction)
- data RestoreSummary = RestoreSummary' {}
- newRestoreSummary :: UTCTime -> Bool -> RestoreSummary
- restoreSummary_sourceBackupArn :: Lens' RestoreSummary (Maybe Text)
- restoreSummary_sourceTableArn :: Lens' RestoreSummary (Maybe Text)
- restoreSummary_restoreDateTime :: Lens' RestoreSummary UTCTime
- restoreSummary_restoreInProgress :: Lens' RestoreSummary Bool
- data S3BucketSource = S3BucketSource' {
- s3BucketOwner :: Maybe Text
- s3KeyPrefix :: Maybe Text
- s3Bucket :: Text
- newS3BucketSource :: Text -> S3BucketSource
- s3BucketSource_s3BucketOwner :: Lens' S3BucketSource (Maybe Text)
- s3BucketSource_s3KeyPrefix :: Lens' S3BucketSource (Maybe Text)
- s3BucketSource_s3Bucket :: Lens' S3BucketSource Text
- data SSEDescription = SSEDescription' {}
- newSSEDescription :: SSEDescription
- sSEDescription_inaccessibleEncryptionDateTime :: Lens' SSEDescription (Maybe UTCTime)
- sSEDescription_kmsMasterKeyArn :: Lens' SSEDescription (Maybe Text)
- sSEDescription_sSEType :: Lens' SSEDescription (Maybe SSEType)
- sSEDescription_status :: Lens' SSEDescription (Maybe SSEStatus)
- data SSESpecification = SSESpecification' {}
- newSSESpecification :: SSESpecification
- sSESpecification_enabled :: Lens' SSESpecification (Maybe Bool)
- sSESpecification_kmsMasterKeyId :: Lens' SSESpecification (Maybe Text)
- sSESpecification_sSEType :: Lens' SSESpecification (Maybe SSEType)
- data SourceTableDetails = SourceTableDetails' {}
- newSourceTableDetails :: Text -> Text -> NonEmpty KeySchemaElement -> UTCTime -> ProvisionedThroughput -> SourceTableDetails
- sourceTableDetails_billingMode :: Lens' SourceTableDetails (Maybe BillingMode)
- sourceTableDetails_itemCount :: Lens' SourceTableDetails (Maybe Natural)
- sourceTableDetails_tableArn :: Lens' SourceTableDetails (Maybe Text)
- sourceTableDetails_tableSizeBytes :: Lens' SourceTableDetails (Maybe Integer)
- sourceTableDetails_tableName :: Lens' SourceTableDetails Text
- sourceTableDetails_tableId :: Lens' SourceTableDetails Text
- sourceTableDetails_keySchema :: Lens' SourceTableDetails (NonEmpty KeySchemaElement)
- sourceTableDetails_tableCreationDateTime :: Lens' SourceTableDetails UTCTime
- sourceTableDetails_provisionedThroughput :: Lens' SourceTableDetails ProvisionedThroughput
- data SourceTableFeatureDetails = SourceTableFeatureDetails' {}
- newSourceTableFeatureDetails :: SourceTableFeatureDetails
- sourceTableFeatureDetails_globalSecondaryIndexes :: Lens' SourceTableFeatureDetails (Maybe [GlobalSecondaryIndexInfo])
- sourceTableFeatureDetails_localSecondaryIndexes :: Lens' SourceTableFeatureDetails (Maybe [LocalSecondaryIndexInfo])
- sourceTableFeatureDetails_sSEDescription :: Lens' SourceTableFeatureDetails (Maybe SSEDescription)
- sourceTableFeatureDetails_streamDescription :: Lens' SourceTableFeatureDetails (Maybe StreamSpecification)
- sourceTableFeatureDetails_timeToLiveDescription :: Lens' SourceTableFeatureDetails (Maybe TimeToLiveDescription)
- data StreamSpecification = StreamSpecification' {}
- newStreamSpecification :: Bool -> StreamSpecification
- streamSpecification_streamViewType :: Lens' StreamSpecification (Maybe StreamViewType)
- streamSpecification_streamEnabled :: Lens' StreamSpecification Bool
- data TableAutoScalingDescription = TableAutoScalingDescription' {}
- newTableAutoScalingDescription :: TableAutoScalingDescription
- tableAutoScalingDescription_replicas :: Lens' TableAutoScalingDescription (Maybe [ReplicaAutoScalingDescription])
- tableAutoScalingDescription_tableName :: Lens' TableAutoScalingDescription (Maybe Text)
- tableAutoScalingDescription_tableStatus :: Lens' TableAutoScalingDescription (Maybe TableStatus)
- data TableClassSummary = TableClassSummary' {}
- newTableClassSummary :: TableClassSummary
- tableClassSummary_lastUpdateDateTime :: Lens' TableClassSummary (Maybe UTCTime)
- tableClassSummary_tableClass :: Lens' TableClassSummary (Maybe TableClass)
- data TableCreationParameters = TableCreationParameters' {}
- newTableCreationParameters :: Text -> NonEmpty KeySchemaElement -> TableCreationParameters
- tableCreationParameters_billingMode :: Lens' TableCreationParameters (Maybe BillingMode)
- tableCreationParameters_globalSecondaryIndexes :: Lens' TableCreationParameters (Maybe [GlobalSecondaryIndex])
- tableCreationParameters_provisionedThroughput :: Lens' TableCreationParameters (Maybe ProvisionedThroughput)
- tableCreationParameters_sSESpecification :: Lens' TableCreationParameters (Maybe SSESpecification)
- tableCreationParameters_tableName :: Lens' TableCreationParameters Text
- tableCreationParameters_attributeDefinitions :: Lens' TableCreationParameters [AttributeDefinition]
- tableCreationParameters_keySchema :: Lens' TableCreationParameters (NonEmpty KeySchemaElement)
- data TableDescription = TableDescription' {
- archivalSummary :: Maybe ArchivalSummary
- attributeDefinitions :: Maybe [AttributeDefinition]
- billingModeSummary :: Maybe BillingModeSummary
- creationDateTime :: Maybe POSIX
- globalSecondaryIndexes :: Maybe [GlobalSecondaryIndexDescription]
- globalTableVersion :: Maybe Text
- itemCount :: Maybe Integer
- keySchema :: Maybe (NonEmpty KeySchemaElement)
- latestStreamArn :: Maybe Text
- latestStreamLabel :: Maybe Text
- localSecondaryIndexes :: Maybe [LocalSecondaryIndexDescription]
- provisionedThroughput :: Maybe ProvisionedThroughputDescription
- replicas :: Maybe [ReplicaDescription]
- restoreSummary :: Maybe RestoreSummary
- sSEDescription :: Maybe SSEDescription
- streamSpecification :: Maybe StreamSpecification
- tableArn :: Maybe Text
- tableClassSummary :: Maybe TableClassSummary
- tableId :: Maybe Text
- tableName :: Maybe Text
- tableSizeBytes :: Maybe Integer
- tableStatus :: Maybe TableStatus
- newTableDescription :: TableDescription
- tableDescription_archivalSummary :: Lens' TableDescription (Maybe ArchivalSummary)
- tableDescription_attributeDefinitions :: Lens' TableDescription (Maybe [AttributeDefinition])
- tableDescription_billingModeSummary :: Lens' TableDescription (Maybe BillingModeSummary)
- tableDescription_creationDateTime :: Lens' TableDescription (Maybe UTCTime)
- tableDescription_globalSecondaryIndexes :: Lens' TableDescription (Maybe [GlobalSecondaryIndexDescription])
- tableDescription_globalTableVersion :: Lens' TableDescription (Maybe Text)
- tableDescription_itemCount :: Lens' TableDescription (Maybe Integer)
- tableDescription_keySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement))
- tableDescription_latestStreamArn :: Lens' TableDescription (Maybe Text)
- tableDescription_latestStreamLabel :: Lens' TableDescription (Maybe Text)
- tableDescription_localSecondaryIndexes :: Lens' TableDescription (Maybe [LocalSecondaryIndexDescription])
- tableDescription_provisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription)
- tableDescription_replicas :: Lens' TableDescription (Maybe [ReplicaDescription])
- tableDescription_restoreSummary :: Lens' TableDescription (Maybe RestoreSummary)
- tableDescription_sSEDescription :: Lens' TableDescription (Maybe SSEDescription)
- tableDescription_streamSpecification :: Lens' TableDescription (Maybe StreamSpecification)
- tableDescription_tableArn :: Lens' TableDescription (Maybe Text)
- tableDescription_tableClassSummary :: Lens' TableDescription (Maybe TableClassSummary)
- tableDescription_tableId :: Lens' TableDescription (Maybe Text)
- tableDescription_tableName :: Lens' TableDescription (Maybe Text)
- tableDescription_tableSizeBytes :: Lens' TableDescription (Maybe Integer)
- tableDescription_tableStatus :: Lens' TableDescription (Maybe TableStatus)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TimeToLiveDescription = TimeToLiveDescription' {}
- newTimeToLiveDescription :: TimeToLiveDescription
- timeToLiveDescription_attributeName :: Lens' TimeToLiveDescription (Maybe Text)
- timeToLiveDescription_timeToLiveStatus :: Lens' TimeToLiveDescription (Maybe TimeToLiveStatus)
- data TimeToLiveSpecification = TimeToLiveSpecification' {
- enabled :: Bool
- attributeName :: Text
- newTimeToLiveSpecification :: Bool -> Text -> TimeToLiveSpecification
- timeToLiveSpecification_enabled :: Lens' TimeToLiveSpecification Bool
- timeToLiveSpecification_attributeName :: Lens' TimeToLiveSpecification Text
- data TransactGetItem = TransactGetItem' {}
- newTransactGetItem :: Get -> TransactGetItem
- transactGetItem_get :: Lens' TransactGetItem Get
- data TransactWriteItem = TransactWriteItem' {}
- newTransactWriteItem :: TransactWriteItem
- transactWriteItem_conditionCheck :: Lens' TransactWriteItem (Maybe ConditionCheck)
- transactWriteItem_delete :: Lens' TransactWriteItem (Maybe Delete)
- transactWriteItem_put :: Lens' TransactWriteItem (Maybe Put)
- transactWriteItem_update :: Lens' TransactWriteItem (Maybe Update)
- data Update = Update' {
- conditionExpression :: Maybe Text
- expressionAttributeNames :: Maybe (HashMap Text Text)
- expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
- returnValuesOnConditionCheckFailure :: Maybe ReturnValuesOnConditionCheckFailure
- key :: HashMap Text AttributeValue
- updateExpression :: Text
- tableName :: Text
- newUpdate :: Text -> Text -> Update
- update_conditionExpression :: Lens' Update (Maybe Text)
- update_expressionAttributeNames :: Lens' Update (Maybe (HashMap Text Text))
- update_expressionAttributeValues :: Lens' Update (Maybe (HashMap Text AttributeValue))
- update_returnValuesOnConditionCheckFailure :: Lens' Update (Maybe ReturnValuesOnConditionCheckFailure)
- update_key :: Lens' Update (HashMap Text AttributeValue)
- update_updateExpression :: Lens' Update Text
- update_tableName :: Lens' Update Text
- data UpdateGlobalSecondaryIndexAction = UpdateGlobalSecondaryIndexAction' {}
- newUpdateGlobalSecondaryIndexAction :: Text -> ProvisionedThroughput -> UpdateGlobalSecondaryIndexAction
- updateGlobalSecondaryIndexAction_indexName :: Lens' UpdateGlobalSecondaryIndexAction Text
- updateGlobalSecondaryIndexAction_provisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput
- data UpdateReplicationGroupMemberAction = UpdateReplicationGroupMemberAction' {}
- newUpdateReplicationGroupMemberAction :: Text -> UpdateReplicationGroupMemberAction
- updateReplicationGroupMemberAction_globalSecondaryIndexes :: Lens' UpdateReplicationGroupMemberAction (Maybe (NonEmpty ReplicaGlobalSecondaryIndex))
- updateReplicationGroupMemberAction_kmsMasterKeyId :: Lens' UpdateReplicationGroupMemberAction (Maybe Text)
- updateReplicationGroupMemberAction_provisionedThroughputOverride :: Lens' UpdateReplicationGroupMemberAction (Maybe ProvisionedThroughputOverride)
- updateReplicationGroupMemberAction_tableClassOverride :: Lens' UpdateReplicationGroupMemberAction (Maybe TableClass)
- updateReplicationGroupMemberAction_regionName :: Lens' UpdateReplicationGroupMemberAction Text
Service Configuration
defaultService :: Service Source #
API version 2012-08-10
of the Amazon DynamoDB SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
Backup not found for the given BackupARN.
_ConditionalCheckFailedException :: AsError a => Fold a ServiceError Source #
A condition specified in the operation could not be evaluated.
_ContinuousBackupsUnavailableException :: AsError a => Fold a ServiceError Source #
Backups have not yet been enabled for this table.
_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 :: AsError a => Fold a ServiceError Source #
There was a conflict when writing to the specified S3 bucket.
_ExportNotFoundException :: AsError a => Fold a ServiceError Source #
The specified export was not found.
_GlobalTableAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified global table already exists.
_GlobalTableNotFoundException :: AsError a => Fold a ServiceError Source #
The specified global table does not exist.
_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 :: 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 :: AsError a => Fold a ServiceError Source #
The specified import was not found.
_IndexNotFoundException :: AsError a => Fold a ServiceError Source #
The operation tried to access a nonexistent index.
_InternalServerError :: AsError a => Fold a ServiceError Source #
An error occurred on the server side.
_InvalidExportTimeException :: AsError a => Fold a ServiceError Source #
The specified ExportTime
is outside of the point in time recovery
window.
_InvalidRestoreTimeException :: AsError a => Fold a ServiceError Source #
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
_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 :: 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 :: AsError a => Fold a ServiceError Source #
Point in time recovery has not yet been enabled for this source table.
_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 :: AsError a => Fold a ServiceError Source #
The specified replica is already part of the global table.
_ReplicaNotFoundException :: AsError a => Fold a ServiceError Source #
The specified replica is no longer part of the global table.
_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 :: 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 :: 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 :: AsError a => Fold a ServiceError Source #
A target table with the specified name already exists.
_TableInUseException :: AsError a => Fold a ServiceError Source #
A target table with the specified name is either being created or deleted.
_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 :: 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 :: AsError a => Fold a ServiceError Source #
Operation was rejected because there is an ongoing transaction for the item.
_TransactionInProgressException :: AsError a => Fold a ServiceError Source #
The transaction with the given request token is already in progress.
Re-exported Types
AttributeAction
newtype AttributeAction Source #
pattern AttributeAction_ADD :: AttributeAction | |
pattern AttributeAction_DELETE :: AttributeAction | |
pattern AttributeAction_PUT :: AttributeAction |
Instances
BackupStatus
newtype BackupStatus Source #
pattern BackupStatus_AVAILABLE :: BackupStatus | |
pattern BackupStatus_CREATING :: BackupStatus | |
pattern BackupStatus_DELETED :: BackupStatus |
Instances
BackupType
newtype BackupType Source #
pattern BackupType_AWS_BACKUP :: BackupType | |
pattern BackupType_SYSTEM :: BackupType | |
pattern BackupType_USER :: BackupType |
Instances
BackupTypeFilter
newtype BackupTypeFilter Source #
pattern BackupTypeFilter_ALL :: BackupTypeFilter | |
pattern BackupTypeFilter_AWS_BACKUP :: BackupTypeFilter | |
pattern BackupTypeFilter_SYSTEM :: BackupTypeFilter | |
pattern BackupTypeFilter_USER :: BackupTypeFilter |
Instances
BatchStatementErrorCodeEnum
newtype BatchStatementErrorCodeEnum Source #
Instances
BillingMode
newtype BillingMode Source #
pattern BillingMode_PAY_PER_REQUEST :: BillingMode | |
pattern BillingMode_PROVISIONED :: BillingMode |
Instances
ComparisonOperator
newtype ComparisonOperator Source #
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 #
pattern ConditionalOperator_AND :: ConditionalOperator | |
pattern ConditionalOperator_OR :: ConditionalOperator |
Instances
ContinuousBackupsStatus
newtype ContinuousBackupsStatus Source #
pattern ContinuousBackupsStatus_DISABLED :: ContinuousBackupsStatus | |
pattern ContinuousBackupsStatus_ENABLED :: ContinuousBackupsStatus |
Instances
ContributorInsightsAction
newtype ContributorInsightsAction Source #
pattern ContributorInsightsAction_DISABLE :: ContributorInsightsAction | |
pattern ContributorInsightsAction_ENABLE :: ContributorInsightsAction |
Instances
ContributorInsightsStatus
newtype ContributorInsightsStatus Source #
Instances
DestinationStatus
newtype DestinationStatus Source #
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 #
pattern ExportFormat_DYNAMODB_JSON :: ExportFormat | |
pattern ExportFormat_ION :: ExportFormat |
Instances
ExportStatus
newtype ExportStatus Source #
pattern ExportStatus_COMPLETED :: ExportStatus | |
pattern ExportStatus_FAILED :: ExportStatus | |
pattern ExportStatus_IN_PROGRESS :: ExportStatus |
Instances
GlobalTableStatus
newtype GlobalTableStatus Source #
pattern GlobalTableStatus_ACTIVE :: GlobalTableStatus | |
pattern GlobalTableStatus_CREATING :: GlobalTableStatus | |
pattern GlobalTableStatus_DELETING :: GlobalTableStatus | |
pattern GlobalTableStatus_UPDATING :: GlobalTableStatus |
Instances
ImportStatus
newtype ImportStatus Source #
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 #
pattern IndexStatus_ACTIVE :: IndexStatus | |
pattern IndexStatus_CREATING :: IndexStatus | |
pattern IndexStatus_DELETING :: IndexStatus | |
pattern IndexStatus_UPDATING :: IndexStatus |
Instances
InputCompressionType
newtype InputCompressionType Source #
pattern InputCompressionType_GZIP :: InputCompressionType | |
pattern InputCompressionType_NONE :: InputCompressionType | |
pattern InputCompressionType_ZSTD :: InputCompressionType |
Instances
InputFormat
newtype InputFormat Source #
pattern InputFormat_CSV :: InputFormat | |
pattern InputFormat_DYNAMODB_JSON :: InputFormat | |
pattern InputFormat_ION :: InputFormat |
Instances
KeyType
pattern KeyType_HASH :: KeyType | |
pattern KeyType_RANGE :: KeyType |
Instances
PointInTimeRecoveryStatus
newtype PointInTimeRecoveryStatus Source #
pattern PointInTimeRecoveryStatus_DISABLED :: PointInTimeRecoveryStatus | |
pattern PointInTimeRecoveryStatus_ENABLED :: PointInTimeRecoveryStatus |
Instances
ProjectionType
newtype ProjectionType Source #
pattern ProjectionType_ALL :: ProjectionType | |
pattern ProjectionType_INCLUDE :: ProjectionType | |
pattern ProjectionType_KEYS_ONLY :: ProjectionType |
Instances
ReplicaStatus
newtype ReplicaStatus Source #
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.
pattern ReturnConsumedCapacity_INDEXES :: ReturnConsumedCapacity | |
pattern ReturnConsumedCapacity_NONE :: ReturnConsumedCapacity | |
pattern ReturnConsumedCapacity_TOTAL :: ReturnConsumedCapacity |
Instances
ReturnItemCollectionMetrics
newtype ReturnItemCollectionMetrics Source #
pattern ReturnItemCollectionMetrics_NONE :: ReturnItemCollectionMetrics | |
pattern ReturnItemCollectionMetrics_SIZE :: ReturnItemCollectionMetrics |
Instances
ReturnValue
newtype ReturnValue Source #
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 #
pattern ReturnValuesOnConditionCheckFailure_ALL_OLD :: ReturnValuesOnConditionCheckFailure | |
pattern ReturnValuesOnConditionCheckFailure_NONE :: ReturnValuesOnConditionCheckFailure |
Instances
S3SseAlgorithm
newtype S3SseAlgorithm Source #
pattern S3SseAlgorithm_AES256 :: S3SseAlgorithm | |
pattern S3SseAlgorithm_KMS :: S3SseAlgorithm |
Instances
SSEStatus
pattern SSEStatus_DISABLED :: SSEStatus | |
pattern SSEStatus_DISABLING :: SSEStatus | |
pattern SSEStatus_ENABLED :: SSEStatus | |
pattern SSEStatus_ENABLING :: SSEStatus | |
pattern SSEStatus_UPDATING :: SSEStatus |
Instances
SSEType
pattern SSEType_AES256 :: SSEType | |
pattern SSEType_KMS :: SSEType |
Instances
ScalarAttributeType
newtype ScalarAttributeType Source #
pattern ScalarAttributeType_B :: ScalarAttributeType | |
pattern ScalarAttributeType_N :: ScalarAttributeType | |
pattern ScalarAttributeType_S :: ScalarAttributeType |
Instances
Select
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 #
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 #
pattern TableClass_STANDARD :: TableClass | |
pattern TableClass_STANDARD_INFREQUENT_ACCESS :: TableClass |
Instances
TableStatus
newtype TableStatus Source #
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 #
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.
ArchivalSummary' | |
|
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.
archivalSummary_archivalBackupArn :: Lens' ArchivalSummary (Maybe Text) Source #
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.
archivalSummary_archivalDateTime :: Lens' ArchivalSummary (Maybe UTCTime) Source #
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
archivalSummary_archivalReason :: Lens' ArchivalSummary (Maybe Text) Source #
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.
AttributeDefinition' | |
|
Instances
newAttributeDefinition Source #
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
attributeDefinition_attributeName :: Lens' AttributeDefinition Text Source #
A name for the attribute.
attributeDefinition_attributeType :: Lens' AttributeDefinition ScalarAttributeType Source #
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.
AttributeValueUpdate' | |
|
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.
attributeValueUpdate_action :: Lens' AttributeValueUpdate (Maybe AttributeAction) Source #
Specifies how to perform the update. Valid values are PUT
(default),
DELETE
, and ADD
. The behavior depends on whether the specified
primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT
- Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.DELETE
- If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set
[a,b,c]
and 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.
attributeValueUpdate_value :: Lens' AttributeValueUpdate (Maybe AttributeValue) Source #
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.
AutoScalingPolicyDescription' | |
|
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.
autoScalingPolicyDescription_policyName :: Lens' AutoScalingPolicyDescription (Maybe Text) Source #
The name of the scaling policy.
autoScalingPolicyDescription_targetTrackingScalingPolicyConfiguration :: Lens' AutoScalingPolicyDescription (Maybe AutoScalingTargetTrackingScalingPolicyConfigurationDescription) Source #
Represents a target tracking scaling policy configuration.
AutoScalingPolicyUpdate
data AutoScalingPolicyUpdate Source #
Represents the auto scaling policy to be modified.
See: newAutoScalingPolicyUpdate
smart constructor.
AutoScalingPolicyUpdate' | |
|
Instances
newAutoScalingPolicyUpdate Source #
:: 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.
autoScalingPolicyUpdate_policyName :: Lens' AutoScalingPolicyUpdate (Maybe Text) Source #
The name of the scaling policy.
autoScalingPolicyUpdate_targetTrackingScalingPolicyConfiguration :: Lens' AutoScalingPolicyUpdate AutoScalingTargetTrackingScalingPolicyConfigurationUpdate Source #
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.
AutoScalingSettingsDescription' | |
|
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.
autoScalingSettingsDescription_autoScalingDisabled :: Lens' AutoScalingSettingsDescription (Maybe Bool) Source #
Disabled auto scaling for this global table or global secondary index.
autoScalingSettingsDescription_autoScalingRoleArn :: Lens' AutoScalingSettingsDescription (Maybe Text) Source #
Role ARN used for configuring the auto scaling policy.
autoScalingSettingsDescription_maximumUnits :: Lens' AutoScalingSettingsDescription (Maybe Natural) Source #
The maximum capacity units that a global table or global secondary index should be scaled up to.
autoScalingSettingsDescription_minimumUnits :: Lens' AutoScalingSettingsDescription (Maybe Natural) Source #
The minimum capacity units that a global table or global secondary index should be scaled down to.
autoScalingSettingsDescription_scalingPolicies :: Lens' AutoScalingSettingsDescription (Maybe [AutoScalingPolicyDescription]) Source #
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.
AutoScalingSettingsUpdate' | |
|
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.
autoScalingSettingsUpdate_autoScalingDisabled :: Lens' AutoScalingSettingsUpdate (Maybe Bool) Source #
Disabled auto scaling for this global table or global secondary index.
autoScalingSettingsUpdate_autoScalingRoleArn :: Lens' AutoScalingSettingsUpdate (Maybe Text) Source #
Role ARN used for configuring auto scaling policy.
autoScalingSettingsUpdate_maximumUnits :: Lens' AutoScalingSettingsUpdate (Maybe Natural) Source #
The maximum capacity units that a global table or global secondary index should be scaled up to.
autoScalingSettingsUpdate_minimumUnits :: Lens' AutoScalingSettingsUpdate (Maybe Natural) Source #
The minimum capacity units that a global table or global secondary index should be scaled down to.
autoScalingSettingsUpdate_scalingPolicyUpdate :: Lens' AutoScalingSettingsUpdate (Maybe AutoScalingPolicyUpdate) Source #
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.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription' | |
|
Instances
newAutoScalingTargetTrackingScalingPolicyConfigurationDescription Source #
:: 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).
autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Bool) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Int) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Maybe Int) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription Double Source #
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.
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate' | |
|
Instances
newAutoScalingTargetTrackingScalingPolicyConfigurationUpdate Source #
:: 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).
autoScalingTargetTrackingScalingPolicyConfigurationUpdate_disableScaleIn :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Bool) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleInCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Int) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationUpdate_scaleOutCooldown :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate (Maybe Int) Source #
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.
autoScalingTargetTrackingScalingPolicyConfigurationUpdate_targetValue :: Lens' AutoScalingTargetTrackingScalingPolicyConfigurationUpdate Double Source #
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.
BackupDescription' | |
|
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.
backupDescription_backupDetails :: Lens' BackupDescription (Maybe BackupDetails) Source #
Contains the details of the backup created for the table.
backupDescription_sourceTableDetails :: Lens' BackupDescription (Maybe SourceTableDetails) Source #
Contains the details of the table when the backup was created.
backupDescription_sourceTableFeatureDetails :: Lens' BackupDescription (Maybe SourceTableFeatureDetails) Source #
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.
BackupDetails' | |
|
Instances
:: 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.
backupDetails_backupExpiryDateTime :: Lens' BackupDetails (Maybe UTCTime) Source #
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.
backupDetails_backupSizeBytes :: Lens' BackupDetails (Maybe Natural) Source #
Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
backupDetails_backupArn :: Lens' BackupDetails Text Source #
ARN associated with the backup.
backupDetails_backupName :: Lens' BackupDetails Text Source #
Name of the requested backup.
backupDetails_backupStatus :: Lens' BackupDetails BackupStatus Source #
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
backupDetails_backupType :: Lens' BackupDetails BackupType Source #
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.
backupDetails_backupCreationDateTime :: Lens' BackupDetails UTCTime Source #
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.
BackupSummary' | |
|
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.
backupSummary_backupArn :: Lens' BackupSummary (Maybe Text) Source #
ARN associated with the backup.
backupSummary_backupCreationDateTime :: Lens' BackupSummary (Maybe UTCTime) Source #
Time at which the backup was created.
backupSummary_backupExpiryDateTime :: Lens' BackupSummary (Maybe UTCTime) Source #
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.
backupSummary_backupName :: Lens' BackupSummary (Maybe Text) Source #
Name of the specified backup.
backupSummary_backupSizeBytes :: Lens' BackupSummary (Maybe Natural) Source #
Size of the backup in bytes.
backupSummary_backupStatus :: Lens' BackupSummary (Maybe BackupStatus) Source #
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
backupSummary_backupType :: Lens' BackupSummary (Maybe BackupType) Source #
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.
backupSummary_tableArn :: Lens' BackupSummary (Maybe Text) Source #
ARN associated with the table.
backupSummary_tableId :: Lens' BackupSummary (Maybe Text) Source #
Unique identifier for the table.
backupSummary_tableName :: Lens' BackupSummary (Maybe Text) Source #
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.
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.
batchStatementError_code :: Lens' BatchStatementError (Maybe BatchStatementErrorCodeEnum) Source #
The error code associated with the failed PartiQL batch statement.
batchStatementError_message :: Lens' BatchStatementError (Maybe Text) Source #
The error message associated with the PartiQL batch response.
BatchStatementRequest
data BatchStatementRequest Source #
A PartiQL batch statement request.
See: newBatchStatementRequest
smart constructor.
BatchStatementRequest' | |
|
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.
batchStatementRequest_consistentRead :: Lens' BatchStatementRequest (Maybe Bool) Source #
The read consistency of the PartiQL batch request.
batchStatementRequest_parameters :: Lens' BatchStatementRequest (Maybe (NonEmpty AttributeValue)) Source #
The parameters associated with a PartiQL statement in the batch request.
batchStatementRequest_statement :: Lens' BatchStatementRequest Text Source #
A valid PartiQL statement.
BatchStatementResponse
data BatchStatementResponse Source #
A PartiQL batch statement response..
See: newBatchStatementResponse
smart constructor.
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.
batchStatementResponse_error :: Lens' BatchStatementResponse (Maybe BatchStatementError) Source #
The error associated with a failed PartiQL batch statement.
batchStatementResponse_item :: Lens' BatchStatementResponse (Maybe (HashMap Text AttributeValue)) Source #
A DynamoDB item associated with a BatchStatementResponse
batchStatementResponse_tableName :: Lens' BatchStatementResponse (Maybe Text) Source #
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.
BillingModeSummary' | |
|
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.
billingModeSummary_billingMode :: Lens' BillingModeSummary (Maybe BillingMode) Source #
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.
billingModeSummary_lastUpdateToPayPerRequestDateTime :: Lens' BillingModeSummary (Maybe UTCTime) Source #
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.
Capacity' | |
|
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.
capacity_capacityUnits :: Lens' Capacity (Maybe Double) Source #
The total number of capacity units consumed on a table or an index.
capacity_readCapacityUnits :: Lens' Capacity (Maybe Double) Source #
The total number of read capacity units consumed on a table or an index.
capacity_writeCapacityUnits :: Lens' Capacity (Maybe Double) Source #
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.
Condition' | |
|
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.
condition_attributeValueList :: Lens' Condition (Maybe [AttributeValue]) Source #
One or more values to evaluate against the supplied attribute. The
number of values in the list depends on the ComparisonOperator
being
used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is greater than
A
, and 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.
condition_comparisonOperator :: Lens' Condition ComparisonOperator Source #
A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.EQ
is supported for all 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.
ConditionCheck' | |
|
Instances
:: 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.
conditionCheck_expressionAttributeNames :: Lens' ConditionCheck (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in an expression.
conditionCheck_expressionAttributeValues :: Lens' ConditionCheck (Maybe (HashMap Text AttributeValue)) Source #
One or more values that can be substituted in an expression.
conditionCheck_returnValuesOnConditionCheckFailure :: Lens' ConditionCheck (Maybe ReturnValuesOnConditionCheckFailure) Source #
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the ConditionCheck
condition fails. For
ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and
ALL_OLD.
conditionCheck_key :: Lens' ConditionCheck (HashMap Text AttributeValue) Source #
The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
conditionCheck_tableName :: Lens' ConditionCheck Text Source #
Name of the table for the check item request.
conditionCheck_conditionExpression :: Lens' ConditionCheck Text Source #
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.
ConsumedCapacity' | |
|
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.
consumedCapacity_capacityUnits :: Lens' ConsumedCapacity (Maybe Double) Source #
The total number of capacity units consumed by the operation.
consumedCapacity_globalSecondaryIndexes :: Lens' ConsumedCapacity (Maybe (HashMap Text Capacity)) Source #
The amount of throughput consumed on each global index affected by the operation.
consumedCapacity_localSecondaryIndexes :: Lens' ConsumedCapacity (Maybe (HashMap Text Capacity)) Source #
The amount of throughput consumed on each local index affected by the operation.
consumedCapacity_readCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) Source #
The total number of read capacity units consumed by the operation.
consumedCapacity_table :: Lens' ConsumedCapacity (Maybe Capacity) Source #
The amount of throughput consumed on the table affected by the operation.
consumedCapacity_tableName :: Lens' ConsumedCapacity (Maybe Text) Source #
The name of the table that was affected by the operation.
consumedCapacity_writeCapacityUnits :: Lens' ConsumedCapacity (Maybe Double) Source #
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.
ContinuousBackupsDescription' | |
|
Instances
newContinuousBackupsDescription Source #
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
continuousBackupsDescription_pointInTimeRecoveryDescription :: Lens' ContinuousBackupsDescription (Maybe PointInTimeRecoveryDescription) Source #
The description of the point in time recovery settings applied to the table.
continuousBackupsDescription_continuousBackupsStatus :: Lens' ContinuousBackupsDescription ContinuousBackupsStatus Source #
ContinuousBackupsStatus
can be one of the following states: ENABLED,
DISABLED
ContributorInsightsSummary
data ContributorInsightsSummary Source #
Represents a Contributor Insights summary entry.
See: newContributorInsightsSummary
smart constructor.
ContributorInsightsSummary' | |
|
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.
contributorInsightsSummary_contributorInsightsStatus :: Lens' ContributorInsightsSummary (Maybe ContributorInsightsStatus) Source #
Describes the current status for contributor insights for the given table and index, if applicable.
contributorInsightsSummary_indexName :: Lens' ContributorInsightsSummary (Maybe Text) Source #
Name of the index associated with the summary, if any.
contributorInsightsSummary_tableName :: Lens' ContributorInsightsSummary (Maybe Text) Source #
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.
CreateGlobalSecondaryIndexAction' | |
|
Instances
newCreateGlobalSecondaryIndexAction Source #
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.
createGlobalSecondaryIndexAction_provisionedThroughput :: Lens' CreateGlobalSecondaryIndexAction (Maybe ProvisionedThroughput) Source #
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.
createGlobalSecondaryIndexAction_indexName :: Lens' CreateGlobalSecondaryIndexAction Text Source #
The name of the global secondary index to be created.
createGlobalSecondaryIndexAction_keySchema :: Lens' CreateGlobalSecondaryIndexAction (NonEmpty KeySchemaElement) Source #
The key schema for the global secondary index.
createGlobalSecondaryIndexAction_projection :: Lens' CreateGlobalSecondaryIndexAction 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.
CreateReplicaAction
data CreateReplicaAction Source #
Represents a replica to be added.
See: newCreateReplicaAction
smart constructor.
CreateReplicaAction' | |
|
Instances
newCreateReplicaAction Source #
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.
createReplicaAction_regionName :: Lens' CreateReplicaAction Text Source #
The Region of the replica to be added.
CreateReplicationGroupMemberAction
data CreateReplicationGroupMemberAction Source #
Represents a replica to be created.
See: newCreateReplicationGroupMemberAction
smart constructor.
CreateReplicationGroupMemberAction' | |
|
Instances
newCreateReplicationGroupMemberAction Source #
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.
createReplicationGroupMemberAction_globalSecondaryIndexes :: Lens' CreateReplicationGroupMemberAction (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) Source #
Replica-specific global secondary index settings.
createReplicationGroupMemberAction_kmsMasterKeyId :: Lens' CreateReplicationGroupMemberAction (Maybe Text) Source #
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_provisionedThroughputOverride :: Lens' CreateReplicationGroupMemberAction (Maybe ProvisionedThroughputOverride) Source #
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
createReplicationGroupMemberAction_tableClassOverride :: Lens' CreateReplicationGroupMemberAction (Maybe TableClass) Source #
Replica-specific table class. If not specified, uses the source table's table class.
createReplicationGroupMemberAction_regionName :: Lens' CreateReplicationGroupMemberAction Text Source #
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.
CsvOptions' | |
|
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.
csvOptions_delimiter :: Lens' CsvOptions (Maybe Text) Source #
The delimiter used for separating items in the CSV file being imported.
csvOptions_headerList :: Lens' CsvOptions (Maybe (NonEmpty Text)) Source #
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.
Delete' | |
|
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.
delete_conditionExpression :: Lens' Delete (Maybe Text) Source #
A condition that must be satisfied in order for a conditional delete to succeed.
delete_expressionAttributeNames :: Lens' Delete (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in an expression.
delete_expressionAttributeValues :: Lens' Delete (Maybe (HashMap Text AttributeValue)) Source #
One or more values that can be substituted in an expression.
delete_returnValuesOnConditionCheckFailure :: Lens' Delete (Maybe ReturnValuesOnConditionCheckFailure) Source #
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Delete
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE and ALL_OLD.
delete_key :: Lens' Delete (HashMap Text AttributeValue) Source #
The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.
delete_tableName :: Lens' Delete Text Source #
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.
Instances
ToJSON DeleteGlobalSecondaryIndexAction Source # | |
Generic DeleteGlobalSecondaryIndexAction Source # | |
Read DeleteGlobalSecondaryIndexAction Source # | |
Show DeleteGlobalSecondaryIndexAction Source # | |
NFData DeleteGlobalSecondaryIndexAction Source # | |
Defined in Amazonka.DynamoDB.Types.DeleteGlobalSecondaryIndexAction rnf :: DeleteGlobalSecondaryIndexAction -> () # | |
Eq DeleteGlobalSecondaryIndexAction Source # | |
Hashable DeleteGlobalSecondaryIndexAction Source # | |
type Rep DeleteGlobalSecondaryIndexAction Source # | |
Defined in Amazonka.DynamoDB.Types.DeleteGlobalSecondaryIndexAction type Rep DeleteGlobalSecondaryIndexAction = D1 ('MetaData "DeleteGlobalSecondaryIndexAction" "Amazonka.DynamoDB.Types.DeleteGlobalSecondaryIndexAction" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteGlobalSecondaryIndexAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
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.
deleteGlobalSecondaryIndexAction_indexName :: Lens' DeleteGlobalSecondaryIndexAction Text Source #
The name of the global secondary index to be deleted.
DeleteReplicaAction
data DeleteReplicaAction Source #
Represents a replica to be removed.
See: newDeleteReplicaAction
smart constructor.
DeleteReplicaAction' | |
|
Instances
newDeleteReplicaAction Source #
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.
deleteReplicaAction_regionName :: Lens' DeleteReplicaAction Text Source #
The Region of the replica to be removed.
DeleteReplicationGroupMemberAction
data DeleteReplicationGroupMemberAction Source #
Represents a replica to be deleted.
See: newDeleteReplicationGroupMemberAction
smart constructor.
DeleteReplicationGroupMemberAction' | |
|
Instances
ToJSON DeleteReplicationGroupMemberAction Source # | |
Generic DeleteReplicationGroupMemberAction Source # | |
Defined in Amazonka.DynamoDB.Types.DeleteReplicationGroupMemberAction type Rep DeleteReplicationGroupMemberAction :: Type -> Type # | |
Read DeleteReplicationGroupMemberAction Source # | |
Show DeleteReplicationGroupMemberAction Source # | |
NFData DeleteReplicationGroupMemberAction Source # | |
Eq DeleteReplicationGroupMemberAction Source # | |
Hashable DeleteReplicationGroupMemberAction Source # | |
type Rep DeleteReplicationGroupMemberAction Source # | |
Defined in Amazonka.DynamoDB.Types.DeleteReplicationGroupMemberAction type Rep DeleteReplicationGroupMemberAction = D1 ('MetaData "DeleteReplicationGroupMemberAction" "Amazonka.DynamoDB.Types.DeleteReplicationGroupMemberAction" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DeleteReplicationGroupMemberAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "regionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newDeleteReplicationGroupMemberAction Source #
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.
deleteReplicationGroupMemberAction_regionName :: Lens' DeleteReplicationGroupMemberAction Text Source #
The Region where the replica exists.
Endpoint
An endpoint information details.
See: newEndpoint
smart constructor.
Endpoint' | |
|
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.
endpoint_cachePeriodInMinutes :: Lens' Endpoint Integer Source #
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.
ExpectedAttributeValue' | |
|
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.
expectedAttributeValue_attributeValueList :: Lens' ExpectedAttributeValue (Maybe [AttributeValue]) Source #
One or more values to evaluate against the supplied attribute. The
number of values in the list depends on the ComparisonOperator
being
used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a
is greater than
A
, and 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.
expectedAttributeValue_comparisonOperator :: Lens' ExpectedAttributeValue (Maybe ComparisonOperator) Source #
A comparator for evaluating attributes in the AttributeValueList
. For
example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal.EQ
is supported for all 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"]}
expectedAttributeValue_exists :: Lens' ExpectedAttributeValue (Maybe Bool) Source #
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.)
expectedAttributeValue_value :: Lens' ExpectedAttributeValue (Maybe AttributeValue) Source #
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.
ExportDescription' | |
|
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.
exportDescription_billedSizeBytes :: Lens' ExportDescription (Maybe Natural) Source #
The billable size of the table export.
exportDescription_clientToken :: Lens' ExportDescription (Maybe Text) Source #
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.
exportDescription_endTime :: Lens' ExportDescription (Maybe UTCTime) Source #
The time at which the export task completed.
exportDescription_exportArn :: Lens' ExportDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the table export.
exportDescription_exportFormat :: Lens' ExportDescription (Maybe ExportFormat) Source #
The format of the exported data. Valid values for ExportFormat
are
DYNAMODB_JSON
or ION
.
exportDescription_exportManifest :: Lens' ExportDescription (Maybe Text) Source #
The name of the manifest file for the export task.
exportDescription_exportStatus :: Lens' ExportDescription (Maybe ExportStatus) Source #
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
exportDescription_exportTime :: Lens' ExportDescription (Maybe UTCTime) Source #
Point in time from which table data was exported.
exportDescription_failureCode :: Lens' ExportDescription (Maybe Text) Source #
Status code for the result of the failed export.
exportDescription_failureMessage :: Lens' ExportDescription (Maybe Text) Source #
Export failure reason description.
exportDescription_itemCount :: Lens' ExportDescription (Maybe Natural) Source #
The number of items exported.
exportDescription_s3Bucket :: Lens' ExportDescription (Maybe Text) Source #
The name of the Amazon S3 bucket containing the export.
exportDescription_s3BucketOwner :: Lens' ExportDescription (Maybe Text) Source #
The ID of the Amazon Web Services account that owns the bucket containing the export.
exportDescription_s3Prefix :: Lens' ExportDescription (Maybe Text) Source #
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
exportDescription_s3SseAlgorithm :: Lens' ExportDescription (Maybe S3SseAlgorithm) Source #
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
exportDescription_s3SseKmsKeyId :: Lens' ExportDescription (Maybe Text) Source #
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
exportDescription_startTime :: Lens' ExportDescription (Maybe UTCTime) Source #
The time at which the export task began.
exportDescription_tableArn :: Lens' ExportDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) of the table that was exported.
exportDescription_tableId :: Lens' ExportDescription (Maybe Text) Source #
Unique ID of the table that was exported.
ExportSummary
data ExportSummary Source #
Summary information about an export task.
See: newExportSummary
smart constructor.
ExportSummary' | |
|
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.
exportSummary_exportArn :: Lens' ExportSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the export.
exportSummary_exportStatus :: Lens' ExportSummary (Maybe ExportStatus) Source #
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.
FailureException' | |
|
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.
failureException_exceptionDescription :: Lens' FailureException (Maybe Text) Source #
Description of the failure.
failureException_exceptionName :: Lens' FailureException (Maybe Text) Source #
Exception name.
Get
Specifies an item and related attribute values to retrieve in a
TransactGetItem
object.
See: newGet
smart constructor.
Get' | |
|
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.
get_expressionAttributeNames :: Lens' Get (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in the ProjectionExpression parameter.
get_projectionExpression :: Lens' Get (Maybe Text) Source #
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.
get_key :: Lens' Get (HashMap Text AttributeValue) Source #
A map of attribute names to AttributeValue
objects that specifies the
primary key of the item to retrieve.
get_tableName :: Lens' Get Text Source #
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.
GlobalSecondaryIndex' | |
|
Instances
newGlobalSecondaryIndex Source #
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.
globalSecondaryIndex_provisionedThroughput :: Lens' GlobalSecondaryIndex (Maybe ProvisionedThroughput) Source #
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.
globalSecondaryIndex_indexName :: Lens' GlobalSecondaryIndex Text Source #
The name of the global secondary index. The name must be unique among all other indexes on this table.
globalSecondaryIndex_keySchema :: Lens' GlobalSecondaryIndex (NonEmpty KeySchemaElement) Source #
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- 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.
globalSecondaryIndex_projection :: Lens' GlobalSecondaryIndex Projection Source #
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.
GlobalSecondaryIndexAutoScalingUpdate' | |
|
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.
globalSecondaryIndexAutoScalingUpdate_indexName :: Lens' GlobalSecondaryIndexAutoScalingUpdate (Maybe Text) Source #
The name of the global secondary index.
globalSecondaryIndexAutoScalingUpdate_provisionedWriteCapacityAutoScalingUpdate :: Lens' GlobalSecondaryIndexAutoScalingUpdate (Maybe AutoScalingSettingsUpdate) Source #
Undocumented member.
GlobalSecondaryIndexDescription
data GlobalSecondaryIndexDescription Source #
Represents the properties of a global secondary index.
See: newGlobalSecondaryIndexDescription
smart constructor.
GlobalSecondaryIndexDescription' | |
|
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.
globalSecondaryIndexDescription_backfilling :: Lens' GlobalSecondaryIndexDescription (Maybe Bool) Source #
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.
globalSecondaryIndexDescription_indexArn :: Lens' GlobalSecondaryIndexDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) that uniquely identifies the index.
globalSecondaryIndexDescription_indexName :: Lens' GlobalSecondaryIndexDescription (Maybe Text) Source #
The name of the global secondary index.
globalSecondaryIndexDescription_indexSizeBytes :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) Source #
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
globalSecondaryIndexDescription_indexStatus :: Lens' GlobalSecondaryIndexDescription (Maybe IndexStatus) Source #
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.
globalSecondaryIndexDescription_itemCount :: Lens' GlobalSecondaryIndexDescription (Maybe Integer) Source #
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
globalSecondaryIndexDescription_keySchema :: Lens' GlobalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) Source #
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- 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.
globalSecondaryIndexDescription_projection :: Lens' GlobalSecondaryIndexDescription (Maybe Projection) Source #
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.
globalSecondaryIndexDescription_provisionedThroughput :: Lens' GlobalSecondaryIndexDescription (Maybe ProvisionedThroughputDescription) Source #
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.
GlobalSecondaryIndexInfo' | |
|
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.
globalSecondaryIndexInfo_indexName :: Lens' GlobalSecondaryIndexInfo (Maybe Text) Source #
The name of the global secondary index.
globalSecondaryIndexInfo_keySchema :: Lens' GlobalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement)) Source #
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH
- 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.
globalSecondaryIndexInfo_projection :: Lens' GlobalSecondaryIndexInfo (Maybe Projection) Source #
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.
globalSecondaryIndexInfo_provisionedThroughput :: Lens' GlobalSecondaryIndexInfo (Maybe ProvisionedThroughput) Source #
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.
GlobalSecondaryIndexUpdate' | |
|
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.
globalSecondaryIndexUpdate_create :: Lens' GlobalSecondaryIndexUpdate (Maybe CreateGlobalSecondaryIndexAction) Source #
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
globalSecondaryIndexUpdate_delete :: Lens' GlobalSecondaryIndexUpdate (Maybe DeleteGlobalSecondaryIndexAction) Source #
The name of an existing global secondary index to be removed.
globalSecondaryIndexUpdate_update :: Lens' GlobalSecondaryIndexUpdate (Maybe UpdateGlobalSecondaryIndexAction) Source #
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.
GlobalTable' | |
|
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.
globalTable_globalTableName :: Lens' GlobalTable (Maybe Text) Source #
The global table name.
globalTable_replicationGroup :: Lens' GlobalTable (Maybe [Replica]) Source #
The Regions where the global table has replicas.
GlobalTableDescription
data GlobalTableDescription Source #
Contains details about the global table.
See: newGlobalTableDescription
smart constructor.
GlobalTableDescription' | |
|
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.
globalTableDescription_creationDateTime :: Lens' GlobalTableDescription (Maybe UTCTime) Source #
The creation time of the global table.
globalTableDescription_globalTableArn :: Lens' GlobalTableDescription (Maybe Text) Source #
The unique identifier of the global table.
globalTableDescription_globalTableName :: Lens' GlobalTableDescription (Maybe Text) Source #
The global table name.
globalTableDescription_globalTableStatus :: Lens' GlobalTableDescription (Maybe GlobalTableStatus) Source #
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.
globalTableDescription_replicationGroup :: Lens' GlobalTableDescription (Maybe [ReplicaDescription]) Source #
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.
GlobalTableGlobalSecondaryIndexSettingsUpdate' | |
|
Instances
newGlobalTableGlobalSecondaryIndexSettingsUpdate Source #
:: 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.
globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityAutoScalingSettingsUpdate :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe AutoScalingSettingsUpdate) Source #
Auto scaling settings for managing a global secondary index's write capacity units.
globalTableGlobalSecondaryIndexSettingsUpdate_provisionedWriteCapacityUnits :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate (Maybe Natural) Source #
The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException.
globalTableGlobalSecondaryIndexSettingsUpdate_indexName :: Lens' GlobalTableGlobalSecondaryIndexSettingsUpdate Text Source #
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.
ImportSummary' | |
|
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.
importSummary_cloudWatchLogGroupArn :: Lens' ImportSummary (Maybe Text) Source #
The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.
importSummary_endTime :: Lens' ImportSummary (Maybe UTCTime) Source #
The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?)
importSummary_importArn :: Lens' ImportSummary (Maybe Text) Source #
The Amazon Resource Number (ARN) corresponding to the import request.
importSummary_importStatus :: Lens' ImportSummary (Maybe ImportStatus) Source #
The status of the import operation.
importSummary_inputFormat :: Lens' ImportSummary (Maybe InputFormat) Source #
The format of the source data. Valid values are CSV
, DYNAMODB_JSON
or ION
.
importSummary_s3BucketSource :: Lens' ImportSummary (Maybe S3BucketSource) Source #
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).
importSummary_startTime :: Lens' ImportSummary (Maybe UTCTime) Source #
The time at which this import task began.
importSummary_tableArn :: Lens' ImportSummary (Maybe Text) Source #
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.
ImportTableDescription' | |
|
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.
importTableDescription_clientToken :: Lens' ImportTableDescription (Maybe Text) Source #
The client token that was provided for the import task. Reusing the
client token on retry makes a call to ImportTable
idempotent.
importTableDescription_cloudWatchLogGroupArn :: Lens' ImportTableDescription (Maybe Text) Source #
The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.
importTableDescription_endTime :: Lens' ImportTableDescription (Maybe UTCTime) Source #
The time at which the creation of the table associated with this import task completed.
importTableDescription_errorCount :: Lens' ImportTableDescription (Maybe Natural) Source #
The number of errors occurred on importing the source file into the target table.
importTableDescription_failureCode :: Lens' ImportTableDescription (Maybe Text) Source #
The error code corresponding to the failure that the import job ran into during execution.
importTableDescription_failureMessage :: Lens' ImportTableDescription (Maybe Text) Source #
The error message corresponding to the failure that the import job ran into during execution.
importTableDescription_importArn :: Lens' ImportTableDescription (Maybe Text) Source #
The Amazon Resource Number (ARN) corresponding to the import request.
importTableDescription_importStatus :: Lens' ImportTableDescription (Maybe ImportStatus) Source #
The status of the import.
importTableDescription_importedItemCount :: Lens' ImportTableDescription (Maybe Natural) Source #
The number of items successfully imported into the new table.
importTableDescription_inputCompressionType :: Lens' ImportTableDescription (Maybe InputCompressionType) Source #
The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
importTableDescription_inputFormat :: Lens' ImportTableDescription (Maybe InputFormat) Source #
The format of the source data going into the target table.
importTableDescription_inputFormatOptions :: Lens' ImportTableDescription (Maybe InputFormatOptions) Source #
The format options for the data that was imported into the target table. There is one value, CsvOption.
importTableDescription_processedItemCount :: Lens' ImportTableDescription (Maybe Natural) Source #
The total number of items processed from the source file.
importTableDescription_processedSizeBytes :: Lens' ImportTableDescription (Maybe Integer) Source #
The total size of data processed from the source file, in Bytes.
importTableDescription_s3BucketSource :: Lens' ImportTableDescription (Maybe S3BucketSource) Source #
Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).
importTableDescription_startTime :: Lens' ImportTableDescription (Maybe UTCTime) Source #
The time when this import task started.
importTableDescription_tableArn :: Lens' ImportTableDescription (Maybe Text) Source #
The Amazon Resource Number (ARN) of the table being imported into.
importTableDescription_tableCreationParameters :: Lens' ImportTableDescription (Maybe TableCreationParameters) Source #
The parameters for the new table that is being imported into.
importTableDescription_tableId :: Lens' ImportTableDescription (Maybe Text) Source #
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.
InputFormatOptions' | |
|
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.
inputFormatOptions_csv :: Lens' InputFormatOptions (Maybe CsvOptions) Source #
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.
ItemCollectionMetrics' | |
|
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.
itemCollectionMetrics_itemCollectionKey :: Lens' ItemCollectionMetrics (Maybe (HashMap Text AttributeValue)) Source #
The partition key value of the item collection. This value is the same as the partition key value of the item.
itemCollectionMetrics_sizeEstimateRangeGB :: Lens' ItemCollectionMetrics (Maybe [Double]) Source #
An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
ItemResponse
data ItemResponse Source #
Details for the requested item.
See: newItemResponse
smart constructor.
ItemResponse' | |
|
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.
itemResponse_item :: Lens' ItemResponse (Maybe (HashMap Text AttributeValue)) Source #
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.
KeySchemaElement' | |
|
Instances
:: 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.
keySchemaElement_attributeName :: Lens' KeySchemaElement Text Source #
The name of a key attribute.
keySchemaElement_keyType :: Lens' KeySchemaElement KeyType Source #
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.
KeysAndAttributes' | |
|
Instances
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.
keysAndAttributes_attributesToGet :: Lens' KeysAndAttributes (Maybe (NonEmpty Text)) Source #
This is a legacy parameter. Use ProjectionExpression
instead. For more
information, see
Legacy Conditional Parameters
in the Amazon DynamoDB Developer Guide.
keysAndAttributes_consistentRead :: Lens' KeysAndAttributes (Maybe Bool) Source #
The consistency of a read operation. If set to true
, then a strongly
consistent read is used; otherwise, an eventually consistent read is
used.
keysAndAttributes_expressionAttributeNames :: Lens' KeysAndAttributes (Maybe (HashMap Text Text)) Source #
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.
keysAndAttributes_projectionExpression :: Lens' KeysAndAttributes (Maybe Text) Source #
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.
keysAndAttributes_keys :: Lens' KeysAndAttributes (NonEmpty (HashMap Text AttributeValue)) Source #
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.
KinesisDataStreamDestination' | |
|
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.
kinesisDataStreamDestination_destinationStatus :: Lens' KinesisDataStreamDestination (Maybe DestinationStatus) Source #
The current status of replication.
kinesisDataStreamDestination_destinationStatusDescription :: Lens' KinesisDataStreamDestination (Maybe Text) Source #
The human-readable string that corresponds to the replica status.
kinesisDataStreamDestination_streamArn :: Lens' KinesisDataStreamDestination (Maybe Text) Source #
The ARN for a specific Kinesis data stream.
KinesisStreamingDestinationInput
data KinesisStreamingDestinationInput Source #
See: newKinesisStreamingDestinationInput
smart constructor.
Instances
newKinesisStreamingDestinationInput Source #
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.
kinesisStreamingDestinationInput_tableName :: Lens' KinesisStreamingDestinationInput Text Source #
The name of the DynamoDB table.
kinesisStreamingDestinationInput_streamArn :: Lens' KinesisStreamingDestinationInput Text Source #
The ARN for a Kinesis data stream.
KinesisStreamingDestinationOutput
data KinesisStreamingDestinationOutput Source #
See: newKinesisStreamingDestinationOutput
smart constructor.
KinesisStreamingDestinationOutput' | |
|
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.
kinesisStreamingDestinationOutput_destinationStatus :: Lens' KinesisStreamingDestinationOutput (Maybe DestinationStatus) Source #
The current status of the replication.
kinesisStreamingDestinationOutput_streamArn :: Lens' KinesisStreamingDestinationOutput (Maybe Text) Source #
The ARN for the specific Kinesis data stream.
kinesisStreamingDestinationOutput_tableName :: Lens' KinesisStreamingDestinationOutput (Maybe Text) Source #
The name of the table being modified.
LocalSecondaryIndex
data LocalSecondaryIndex Source #
Represents the properties of a local secondary index.
See: newLocalSecondaryIndex
smart constructor.
LocalSecondaryIndex' | |
|
Instances
newLocalSecondaryIndex Source #
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.
localSecondaryIndex_indexName :: Lens' LocalSecondaryIndex Text Source #
The name of the local secondary index. The name must be unique among all other indexes on this table.
localSecondaryIndex_keySchema :: Lens' LocalSecondaryIndex (NonEmpty KeySchemaElement) Source #
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH
- 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.
localSecondaryIndex_projection :: Lens' LocalSecondaryIndex Projection Source #
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.
LocalSecondaryIndexDescription' | |
|
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.
localSecondaryIndexDescription_indexArn :: Lens' LocalSecondaryIndexDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) that uniquely identifies the index.
localSecondaryIndexDescription_indexName :: Lens' LocalSecondaryIndexDescription (Maybe Text) Source #
Represents the name of the local secondary index.
localSecondaryIndexDescription_indexSizeBytes :: Lens' LocalSecondaryIndexDescription (Maybe Integer) Source #
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
localSecondaryIndexDescription_itemCount :: Lens' LocalSecondaryIndexDescription (Maybe Integer) Source #
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
localSecondaryIndexDescription_keySchema :: Lens' LocalSecondaryIndexDescription (Maybe (NonEmpty KeySchemaElement)) Source #
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH
- 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.
localSecondaryIndexDescription_projection :: Lens' LocalSecondaryIndexDescription (Maybe Projection) Source #
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.
LocalSecondaryIndexInfo' | |
|
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.
localSecondaryIndexInfo_indexName :: Lens' LocalSecondaryIndexInfo (Maybe Text) Source #
Represents the name of the local secondary index.
localSecondaryIndexInfo_keySchema :: Lens' LocalSecondaryIndexInfo (Maybe (NonEmpty KeySchemaElement)) Source #
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.
localSecondaryIndexInfo_projection :: Lens' LocalSecondaryIndexInfo (Maybe Projection) Source #
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.
ParameterizedStatement' | |
|
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.
parameterizedStatement_parameters :: Lens' ParameterizedStatement (Maybe (NonEmpty AttributeValue)) Source #
The parameter values.
parameterizedStatement_statement :: Lens' ParameterizedStatement Text Source #
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.
PointInTimeRecoveryDescription' | |
|
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.
pointInTimeRecoveryDescription_earliestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime) Source #
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.
pointInTimeRecoveryDescription_latestRestorableDateTime :: Lens' PointInTimeRecoveryDescription (Maybe UTCTime) Source #
LatestRestorableDateTime
is typically 5 minutes before the current
time.
pointInTimeRecoveryDescription_pointInTimeRecoveryStatus :: Lens' PointInTimeRecoveryDescription (Maybe PointInTimeRecoveryStatus) Source #
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.
PointInTimeRecoverySpecification' | |
|
Instances
ToJSON PointInTimeRecoverySpecification Source # | |
Generic PointInTimeRecoverySpecification Source # | |
Read PointInTimeRecoverySpecification Source # | |
Show PointInTimeRecoverySpecification Source # | |
NFData PointInTimeRecoverySpecification Source # | |
Defined in Amazonka.DynamoDB.Types.PointInTimeRecoverySpecification rnf :: PointInTimeRecoverySpecification -> () # | |
Eq PointInTimeRecoverySpecification Source # | |
Hashable PointInTimeRecoverySpecification Source # | |
type Rep PointInTimeRecoverySpecification Source # | |
Defined in Amazonka.DynamoDB.Types.PointInTimeRecoverySpecification type Rep PointInTimeRecoverySpecification = D1 ('MetaData "PointInTimeRecoverySpecification" "Amazonka.DynamoDB.Types.PointInTimeRecoverySpecification" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "PointInTimeRecoverySpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pointInTimeRecoveryEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))) |
newPointInTimeRecoverySpecification Source #
:: 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.
pointInTimeRecoverySpecification_pointInTimeRecoveryEnabled :: Lens' PointInTimeRecoverySpecification Bool Source #
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.
Projection' | |
|
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.
projection_nonKeyAttributes :: Lens' Projection (Maybe (NonEmpty Text)) Source #
Represents the non-key attribute names which will be projected into the index.
For local secondary indexes, the total count of NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 100.
If you project the same attribute into two different indexes, this
counts as two distinct attributes when determining the total.
projection_projectionType :: Lens' Projection (Maybe ProjectionType) Source #
The set of attributes that are projected into the index:
KEYS_ONLY
- Only the index and primary keys are projected into the index.INCLUDE
- 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.
ProvisionedThroughput' | |
|
Instances
newProvisionedThroughput Source #
:: 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.
provisionedThroughput_readCapacityUnits :: Lens' ProvisionedThroughput Natural Source #
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.
provisionedThroughput_writeCapacityUnits :: Lens' ProvisionedThroughput Natural Source #
The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException
. For more information, see
Specifying Read and Write Requirements
in the Amazon DynamoDB Developer Guide.
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.
ProvisionedThroughputDescription' | |
|
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
.
provisionedThroughputDescription_lastDecreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) Source #
The date and time of the last provisioned throughput decrease for this table.
provisionedThroughputDescription_lastIncreaseDateTime :: Lens' ProvisionedThroughputDescription (Maybe UTCTime) Source #
The date and time of the last provisioned throughput increase for this table.
provisionedThroughputDescription_numberOfDecreasesToday :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source #
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
provisionedThroughputDescription_readCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source #
The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException
. Eventually consistent
reads require less effort than strongly consistent reads, so a setting
of 50 ReadCapacityUnits
per second provides 100 eventually consistent
ReadCapacityUnits
per second.
provisionedThroughputDescription_writeCapacityUnits :: Lens' ProvisionedThroughputDescription (Maybe Natural) Source #
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.
ProvisionedThroughputOverride' | |
|
Instances
FromJSON ProvisionedThroughputOverride Source # | |
ToJSON ProvisionedThroughputOverride Source # | |
Generic ProvisionedThroughputOverride Source # | |
Read ProvisionedThroughputOverride Source # | |
Show ProvisionedThroughputOverride Source # | |
NFData ProvisionedThroughputOverride Source # | |
Defined in Amazonka.DynamoDB.Types.ProvisionedThroughputOverride rnf :: ProvisionedThroughputOverride -> () # | |
Eq ProvisionedThroughputOverride Source # | |
Hashable ProvisionedThroughputOverride Source # | |
type Rep ProvisionedThroughputOverride Source # | |
Defined in Amazonka.DynamoDB.Types.ProvisionedThroughputOverride type Rep ProvisionedThroughputOverride = D1 ('MetaData "ProvisionedThroughputOverride" "Amazonka.DynamoDB.Types.ProvisionedThroughputOverride" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ProvisionedThroughputOverride'" 'PrefixI 'True) (S1 ('MetaSel ('Just "readCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) |
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.
provisionedThroughputOverride_readCapacityUnits :: Lens' ProvisionedThroughputOverride (Maybe Natural) Source #
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.
Put' | |
|
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.
put_conditionExpression :: Lens' Put (Maybe Text) Source #
A condition that must be satisfied in order for a conditional update to succeed.
put_expressionAttributeNames :: Lens' Put (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in an expression.
put_expressionAttributeValues :: Lens' Put (Maybe (HashMap Text AttributeValue)) Source #
One or more values that can be substituted in an expression.
put_returnValuesOnConditionCheckFailure :: Lens' Put (Maybe ReturnValuesOnConditionCheckFailure) Source #
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if
the Put
condition fails. For ReturnValuesOnConditionCheckFailure
,
the valid values are: NONE and ALL_OLD.
put_item :: Lens' Put (HashMap Text AttributeValue) Source #
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.
Replica
Represents the properties of a replica.
See: newReplica
smart constructor.
Replica' | |
|
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.
replica_regionName :: Lens' Replica (Maybe Text) Source #
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.
ReplicaAutoScalingDescription' | |
|
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.
replicaAutoScalingDescription_globalSecondaryIndexes :: Lens' ReplicaAutoScalingDescription (Maybe [ReplicaGlobalSecondaryIndexAutoScalingDescription]) Source #
Replica-specific global secondary index auto scaling settings.
replicaAutoScalingDescription_regionName :: Lens' ReplicaAutoScalingDescription (Maybe Text) Source #
The Region where the replica exists.
replicaAutoScalingDescription_replicaProvisionedReadCapacityAutoScalingSettings :: Lens' ReplicaAutoScalingDescription (Maybe AutoScalingSettingsDescription) Source #
Undocumented member.
replicaAutoScalingDescription_replicaProvisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaAutoScalingDescription (Maybe AutoScalingSettingsDescription) Source #
Undocumented member.
replicaAutoScalingDescription_replicaStatus :: Lens' ReplicaAutoScalingDescription (Maybe ReplicaStatus) Source #
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.
ReplicaAutoScalingUpdate' | |
|
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.
replicaAutoScalingUpdate_replicaGlobalSecondaryIndexUpdates :: Lens' ReplicaAutoScalingUpdate (Maybe [ReplicaGlobalSecondaryIndexAutoScalingUpdate]) Source #
Represents the auto scaling settings of global secondary indexes that will be modified.
replicaAutoScalingUpdate_replicaProvisionedReadCapacityAutoScalingUpdate :: Lens' ReplicaAutoScalingUpdate (Maybe AutoScalingSettingsUpdate) Source #
Undocumented member.
replicaAutoScalingUpdate_regionName :: Lens' ReplicaAutoScalingUpdate Text Source #
The Region where the replica exists.
ReplicaDescription
data ReplicaDescription Source #
Contains the details of the replica.
See: newReplicaDescription
smart constructor.
ReplicaDescription' | |
|
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.
replicaDescription_globalSecondaryIndexes :: Lens' ReplicaDescription (Maybe [ReplicaGlobalSecondaryIndexDescription]) Source #
Replica-specific global secondary index settings.
replicaDescription_kmsMasterKeyId :: Lens' ReplicaDescription (Maybe Text) Source #
The KMS key of the replica that will be used for KMS encryption.
replicaDescription_provisionedThroughputOverride :: Lens' ReplicaDescription (Maybe ProvisionedThroughputOverride) Source #
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
replicaDescription_regionName :: Lens' ReplicaDescription (Maybe Text) Source #
The name of the Region.
replicaDescription_replicaInaccessibleDateTime :: Lens' ReplicaDescription (Maybe UTCTime) Source #
The time at which the replica was first detected as inaccessible. To
determine cause of inaccessibility check the ReplicaStatus
property.
replicaDescription_replicaStatus :: Lens' ReplicaDescription (Maybe ReplicaStatus) Source #
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.
replicaDescription_replicaStatusDescription :: Lens' ReplicaDescription (Maybe Text) Source #
Detailed information about the replica status.
replicaDescription_replicaStatusPercentProgress :: Lens' ReplicaDescription (Maybe Text) Source #
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
replicaDescription_replicaTableClassSummary :: Lens' ReplicaDescription (Maybe TableClassSummary) Source #
Undocumented member.
ReplicaGlobalSecondaryIndex
data ReplicaGlobalSecondaryIndex Source #
Represents the properties of a replica global secondary index.
See: newReplicaGlobalSecondaryIndex
smart constructor.
ReplicaGlobalSecondaryIndex' | |
|
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.
replicaGlobalSecondaryIndex_provisionedThroughputOverride :: Lens' ReplicaGlobalSecondaryIndex (Maybe ProvisionedThroughputOverride) Source #
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
replicaGlobalSecondaryIndex_indexName :: Lens' ReplicaGlobalSecondaryIndex Text Source #
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.
ReplicaGlobalSecondaryIndexAutoScalingDescription' | |
|
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.
replicaGlobalSecondaryIndexAutoScalingDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe Text) Source #
The name of the global secondary index.
replicaGlobalSecondaryIndexAutoScalingDescription_indexStatus :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe IndexStatus) Source #
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.
replicaGlobalSecondaryIndexAutoScalingDescription_provisionedReadCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe AutoScalingSettingsDescription) Source #
Undocumented member.
replicaGlobalSecondaryIndexAutoScalingDescription_provisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexAutoScalingDescription (Maybe AutoScalingSettingsDescription) Source #
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.
ReplicaGlobalSecondaryIndexAutoScalingUpdate' | |
|
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.
replicaGlobalSecondaryIndexAutoScalingUpdate_indexName :: Lens' ReplicaGlobalSecondaryIndexAutoScalingUpdate (Maybe Text) Source #
The name of the global secondary index.
replicaGlobalSecondaryIndexAutoScalingUpdate_provisionedReadCapacityAutoScalingUpdate :: Lens' ReplicaGlobalSecondaryIndexAutoScalingUpdate (Maybe AutoScalingSettingsUpdate) Source #
Undocumented member.
ReplicaGlobalSecondaryIndexDescription
data ReplicaGlobalSecondaryIndexDescription Source #
Represents the properties of a replica global secondary index.
See: newReplicaGlobalSecondaryIndexDescription
smart constructor.
ReplicaGlobalSecondaryIndexDescription' | |
|
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.
replicaGlobalSecondaryIndexDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexDescription (Maybe Text) Source #
The name of the global secondary index.
replicaGlobalSecondaryIndexDescription_provisionedThroughputOverride :: Lens' ReplicaGlobalSecondaryIndexDescription (Maybe ProvisionedThroughputOverride) Source #
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.
ReplicaGlobalSecondaryIndexSettingsDescription' | |
|
Instances
newReplicaGlobalSecondaryIndexSettingsDescription Source #
:: 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.
replicaGlobalSecondaryIndexSettingsDescription_indexStatus :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe IndexStatus) Source #
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.
replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe AutoScalingSettingsDescription) Source #
Auto scaling settings for a global secondary index replica's read capacity units.
replicaGlobalSecondaryIndexSettingsDescription_provisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural) Source #
The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException
.
replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe AutoScalingSettingsDescription) Source #
Auto scaling settings for a global secondary index replica's write capacity units.
replicaGlobalSecondaryIndexSettingsDescription_provisionedWriteCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription (Maybe Natural) Source #
The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException
.
replicaGlobalSecondaryIndexSettingsDescription_indexName :: Lens' ReplicaGlobalSecondaryIndexSettingsDescription Text Source #
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.
ReplicaGlobalSecondaryIndexSettingsUpdate' | |
|
Instances
newReplicaGlobalSecondaryIndexSettingsUpdate Source #
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.
replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityAutoScalingSettingsUpdate :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe AutoScalingSettingsUpdate) Source #
Auto scaling settings for managing a global secondary index replica's read capacity units.
replicaGlobalSecondaryIndexSettingsUpdate_provisionedReadCapacityUnits :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate (Maybe Natural) Source #
The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException
.
replicaGlobalSecondaryIndexSettingsUpdate_indexName :: Lens' ReplicaGlobalSecondaryIndexSettingsUpdate Text Source #
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.
ReplicaSettingsDescription' | |
|
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.
replicaSettingsDescription_replicaBillingModeSummary :: Lens' ReplicaSettingsDescription (Maybe BillingModeSummary) Source #
The read/write capacity mode of the replica.
replicaSettingsDescription_replicaGlobalSecondaryIndexSettings :: Lens' ReplicaSettingsDescription (Maybe [ReplicaGlobalSecondaryIndexSettingsDescription]) Source #
Replica global secondary index settings for the global table.
replicaSettingsDescription_replicaProvisionedReadCapacityAutoScalingSettings :: Lens' ReplicaSettingsDescription (Maybe AutoScalingSettingsDescription) Source #
Auto scaling settings for a global table replica's read capacity units.
replicaSettingsDescription_replicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural) Source #
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.
replicaSettingsDescription_replicaProvisionedWriteCapacityAutoScalingSettings :: Lens' ReplicaSettingsDescription (Maybe AutoScalingSettingsDescription) Source #
Auto scaling settings for a global table replica's write capacity units.
replicaSettingsDescription_replicaProvisionedWriteCapacityUnits :: Lens' ReplicaSettingsDescription (Maybe Natural) Source #
The maximum number of writes consumed per second before DynamoDB returns
a ThrottlingException
. For more information, see
Specifying Read and Write Requirements
in the Amazon DynamoDB Developer Guide.
replicaSettingsDescription_replicaStatus :: Lens' ReplicaSettingsDescription (Maybe ReplicaStatus) Source #
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.
replicaSettingsDescription_replicaTableClassSummary :: Lens' ReplicaSettingsDescription (Maybe TableClassSummary) Source #
Undocumented member.
replicaSettingsDescription_regionName :: Lens' ReplicaSettingsDescription Text Source #
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.
ReplicaSettingsUpdate' | |
|
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.
replicaSettingsUpdate_replicaGlobalSecondaryIndexSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe (NonEmpty ReplicaGlobalSecondaryIndexSettingsUpdate)) Source #
Represents the settings of a global secondary index for a global table that will be modified.
replicaSettingsUpdate_replicaProvisionedReadCapacityAutoScalingSettingsUpdate :: Lens' ReplicaSettingsUpdate (Maybe AutoScalingSettingsUpdate) Source #
Auto scaling settings for managing a global table replica's read capacity units.
replicaSettingsUpdate_replicaProvisionedReadCapacityUnits :: Lens' ReplicaSettingsUpdate (Maybe Natural) Source #
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.
replicaSettingsUpdate_replicaTableClass :: Lens' ReplicaSettingsUpdate (Maybe TableClass) Source #
Replica-specific table class. If not specified, uses the source table's table class.
replicaSettingsUpdate_regionName :: Lens' ReplicaSettingsUpdate Text Source #
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.
ReplicaUpdate' | |
|
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.
replicaUpdate_create :: Lens' ReplicaUpdate (Maybe CreateReplicaAction) Source #
The parameters required for creating a replica on an existing global table.
replicaUpdate_delete :: Lens' ReplicaUpdate (Maybe DeleteReplicaAction) Source #
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.
ReplicationGroupUpdate' | |
|
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.
replicationGroupUpdate_create :: Lens' ReplicationGroupUpdate (Maybe CreateReplicationGroupMemberAction) Source #
The parameters required for creating a replica for the table.
replicationGroupUpdate_delete :: Lens' ReplicationGroupUpdate (Maybe DeleteReplicationGroupMemberAction) Source #
The parameters required for deleting a replica for the table.
replicationGroupUpdate_update :: Lens' ReplicationGroupUpdate (Maybe UpdateReplicationGroupMemberAction) Source #
The parameters required for updating a replica for the table.
RestoreSummary
data RestoreSummary Source #
Contains details for the restore.
See: newRestoreSummary
smart constructor.
RestoreSummary' | |
|
Instances
:: 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.
restoreSummary_sourceBackupArn :: Lens' RestoreSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the backup from which the table was restored.
restoreSummary_sourceTableArn :: Lens' RestoreSummary (Maybe Text) Source #
The ARN of the source table of the backup that is being restored.
restoreSummary_restoreDateTime :: Lens' RestoreSummary UTCTime Source #
Point in time or source backup time.
restoreSummary_restoreInProgress :: Lens' RestoreSummary Bool Source #
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.
S3BucketSource' | |
|
Instances
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.
s3BucketSource_s3BucketOwner :: Lens' S3BucketSource (Maybe Text) Source #
The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
s3BucketSource_s3KeyPrefix :: Lens' S3BucketSource (Maybe Text) Source #
The key prefix shared by all S3 Objects that are being imported.
s3BucketSource_s3Bucket :: Lens' S3BucketSource Text Source #
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.
SSEDescription' | |
|
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.
sSEDescription_inaccessibleEncryptionDateTime :: Lens' SSEDescription (Maybe UTCTime) Source #
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.
sSEDescription_kmsMasterKeyArn :: Lens' SSEDescription (Maybe Text) Source #
The KMS key ARN used for the KMS encryption.
sSEDescription_sSEType :: Lens' SSEDescription (Maybe SSEType) Source #
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).
sSEDescription_status :: Lens' SSEDescription (Maybe SSEStatus) Source #
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.
SSESpecification' | |
|
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).
sSESpecification_enabled :: Lens' SSESpecification (Maybe Bool) Source #
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.
sSESpecification_kmsMasterKeyId :: Lens' SSESpecification (Maybe Text) Source #
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
.
sSESpecification_sSEType :: Lens' SSESpecification (Maybe SSEType) Source #
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.
SourceTableDetails' | |
|
Instances
newSourceTableDetails Source #
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.
sourceTableDetails_billingMode :: Lens' SourceTableDetails (Maybe BillingMode) Source #
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.
sourceTableDetails_itemCount :: Lens' SourceTableDetails (Maybe Natural) Source #
Number of items in the table. Note that this is an approximate value.
sourceTableDetails_tableArn :: Lens' SourceTableDetails (Maybe Text) Source #
ARN of the table for which backup was created.
sourceTableDetails_tableSizeBytes :: Lens' SourceTableDetails (Maybe Integer) Source #
Size of the table in bytes. Note that this is an approximate value.
sourceTableDetails_tableName :: Lens' SourceTableDetails Text Source #
The name of the table for which the backup was created.
sourceTableDetails_tableId :: Lens' SourceTableDetails Text Source #
Unique identifier for the table for which the backup was created.
sourceTableDetails_keySchema :: Lens' SourceTableDetails (NonEmpty KeySchemaElement) Source #
Schema of the table.
sourceTableDetails_tableCreationDateTime :: Lens' SourceTableDetails UTCTime Source #
Time when the source table was created.
sourceTableDetails_provisionedThroughput :: Lens' SourceTableDetails ProvisionedThroughput Source #
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.
SourceTableFeatureDetails' | |
|
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.
sourceTableFeatureDetails_globalSecondaryIndexes :: Lens' SourceTableFeatureDetails (Maybe [GlobalSecondaryIndexInfo]) Source #
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.
sourceTableFeatureDetails_localSecondaryIndexes :: Lens' SourceTableFeatureDetails (Maybe [LocalSecondaryIndexInfo]) Source #
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.
sourceTableFeatureDetails_sSEDescription :: Lens' SourceTableFeatureDetails (Maybe SSEDescription) Source #
The description of the server-side encryption status on the table when the backup was created.
sourceTableFeatureDetails_streamDescription :: Lens' SourceTableFeatureDetails (Maybe StreamSpecification) Source #
Stream settings on the table when the backup was created.
sourceTableFeatureDetails_timeToLiveDescription :: Lens' SourceTableFeatureDetails (Maybe TimeToLiveDescription) Source #
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.
StreamSpecification' | |
|
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.
streamSpecification_streamViewType :: Lens' StreamSpecification (Maybe StreamViewType) Source #
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.
streamSpecification_streamEnabled :: Lens' StreamSpecification Bool Source #
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.
TableAutoScalingDescription' | |
|
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.
tableAutoScalingDescription_replicas :: Lens' TableAutoScalingDescription (Maybe [ReplicaAutoScalingDescription]) Source #
Represents replicas of the global table.
tableAutoScalingDescription_tableName :: Lens' TableAutoScalingDescription (Maybe Text) Source #
The name of the table.
tableAutoScalingDescription_tableStatus :: Lens' TableAutoScalingDescription (Maybe TableStatus) Source #
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.
TableClassSummary' | |
|
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
.
tableClassSummary_lastUpdateDateTime :: Lens' TableClassSummary (Maybe UTCTime) Source #
The date and time at which the table class was last updated.
tableClassSummary_tableClass :: Lens' TableClassSummary (Maybe TableClass) Source #
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.
TableCreationParameters' | |
|
Instances
newTableCreationParameters Source #
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.
tableCreationParameters_billingMode :: Lens' TableCreationParameters (Maybe BillingMode) Source #
The billing mode for provisioning the table created as part of the import operation.
tableCreationParameters_globalSecondaryIndexes :: Lens' TableCreationParameters (Maybe [GlobalSecondaryIndex]) Source #
The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.
tableCreationParameters_provisionedThroughput :: Lens' TableCreationParameters (Maybe ProvisionedThroughput) Source #
Undocumented member.
tableCreationParameters_sSESpecification :: Lens' TableCreationParameters (Maybe SSESpecification) Source #
Undocumented member.
tableCreationParameters_tableName :: Lens' TableCreationParameters Text Source #
The name of the table created as part of the import operation.
tableCreationParameters_attributeDefinitions :: Lens' TableCreationParameters [AttributeDefinition] Source #
The attributes of the table created as part of the import operation.
tableCreationParameters_keySchema :: Lens' TableCreationParameters (NonEmpty KeySchemaElement) Source #
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.
TableDescription' | |
|
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.
tableDescription_archivalSummary :: Lens' TableDescription (Maybe ArchivalSummary) Source #
Contains information about the table archive.
tableDescription_attributeDefinitions :: Lens' TableDescription (Maybe [AttributeDefinition]) Source #
An array of AttributeDefinition
objects. Each of these objects
describes one attribute in the table and index key schema.
Each AttributeDefinition
object in this array is composed of:
AttributeName
- The name of the attribute.AttributeType
- The data type for the attribute.
tableDescription_billingModeSummary :: Lens' TableDescription (Maybe BillingModeSummary) Source #
Contains the details for the read/write capacity mode.
tableDescription_creationDateTime :: Lens' TableDescription (Maybe UTCTime) Source #
The date and time when the table was created, in UNIX epoch time format.
tableDescription_globalSecondaryIndexes :: Lens' TableDescription (Maybe [GlobalSecondaryIndexDescription]) Source #
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.
tableDescription_globalTableVersion :: Lens' TableDescription (Maybe Text) Source #
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
tableDescription_itemCount :: Lens' TableDescription (Maybe Integer) Source #
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
tableDescription_keySchema :: Lens' TableDescription (Maybe (NonEmpty KeySchemaElement)) Source #
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.
tableDescription_latestStreamArn :: Lens' TableDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
tableDescription_latestStreamLabel :: Lens' TableDescription (Maybe Text) Source #
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
tableDescription_localSecondaryIndexes :: Lens' TableDescription (Maybe [LocalSecondaryIndexDescription]) Source #
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_provisionedThroughput :: Lens' TableDescription (Maybe ProvisionedThroughputDescription) Source #
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
tableDescription_replicas :: Lens' TableDescription (Maybe [ReplicaDescription]) Source #
Represents replicas of the table.
tableDescription_restoreSummary :: Lens' TableDescription (Maybe RestoreSummary) Source #
Contains details for the restore.
tableDescription_sSEDescription :: Lens' TableDescription (Maybe SSEDescription) Source #
The description of the server-side encryption status on the specified table.
tableDescription_streamSpecification :: Lens' TableDescription (Maybe StreamSpecification) Source #
The current DynamoDB Streams configuration for the table.
tableDescription_tableArn :: Lens' TableDescription (Maybe Text) Source #
The Amazon Resource Name (ARN) that uniquely identifies the table.
tableDescription_tableClassSummary :: Lens' TableDescription (Maybe TableClassSummary) Source #
Contains details of the table class.
tableDescription_tableId :: Lens' TableDescription (Maybe Text) Source #
Unique identifier for the table for which the backup was created.
tableDescription_tableName :: Lens' TableDescription (Maybe Text) Source #
The name of the table.
tableDescription_tableSizeBytes :: Lens' TableDescription (Maybe Integer) Source #
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
tableDescription_tableStatus :: Lens' TableDescription (Maybe TableStatus) Source #
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.
Tag' | |
|
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.
tag_key :: Lens' Tag Text Source #
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.
tag_value :: Lens' Tag Text Source #
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.
TimeToLiveDescription' | |
|
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.
timeToLiveDescription_attributeName :: Lens' TimeToLiveDescription (Maybe Text) Source #
The name of the TTL attribute for items in the table.
timeToLiveDescription_timeToLiveStatus :: Lens' TimeToLiveDescription (Maybe TimeToLiveStatus) Source #
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.
TimeToLiveSpecification' | |
|
Instances
newTimeToLiveSpecification Source #
:: 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.
timeToLiveSpecification_enabled :: Lens' TimeToLiveSpecification Bool Source #
Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
timeToLiveSpecification_attributeName :: Lens' TimeToLiveSpecification Text Source #
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.
Instances
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.
transactGetItem_get :: Lens' TransactGetItem Get Source #
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.
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.
transactWriteItem_conditionCheck :: Lens' TransactWriteItem (Maybe ConditionCheck) Source #
A request to perform a check item operation.
transactWriteItem_delete :: Lens' TransactWriteItem (Maybe Delete) Source #
A request to perform a DeleteItem
operation.
transactWriteItem_put :: Lens' TransactWriteItem (Maybe Put) Source #
A request to perform a PutItem
operation.
transactWriteItem_update :: Lens' TransactWriteItem (Maybe Update) Source #
A request to perform an UpdateItem
operation.
Update
Represents a request to perform an UpdateItem
operation.
See: newUpdate
smart constructor.
Update' | |
|
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.
update_conditionExpression :: Lens' Update (Maybe Text) Source #
A condition that must be satisfied in order for a conditional update to succeed.
update_expressionAttributeNames :: Lens' Update (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in an expression.
update_expressionAttributeValues :: Lens' Update (Maybe (HashMap Text AttributeValue)) Source #
One or more values that can be substituted in an expression.
update_returnValuesOnConditionCheckFailure :: Lens' Update (Maybe ReturnValuesOnConditionCheckFailure) Source #
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.
update_key :: Lens' Update (HashMap Text AttributeValue) Source #
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
update_updateExpression :: Lens' Update Text Source #
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
UpdateGlobalSecondaryIndexAction
data UpdateGlobalSecondaryIndexAction Source #
Represents the new provisioned throughput settings to be applied to a global secondary index.
See: newUpdateGlobalSecondaryIndexAction
smart constructor.
UpdateGlobalSecondaryIndexAction' | |
|
Instances
newUpdateGlobalSecondaryIndexAction Source #
:: 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.
updateGlobalSecondaryIndexAction_indexName :: Lens' UpdateGlobalSecondaryIndexAction Text Source #
The name of the global secondary index to be updated.
updateGlobalSecondaryIndexAction_provisionedThroughput :: Lens' UpdateGlobalSecondaryIndexAction ProvisionedThroughput Source #
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.
UpdateReplicationGroupMemberAction' | |
|
Instances
newUpdateReplicationGroupMemberAction Source #
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.
updateReplicationGroupMemberAction_globalSecondaryIndexes :: Lens' UpdateReplicationGroupMemberAction (Maybe (NonEmpty ReplicaGlobalSecondaryIndex)) Source #
Replica-specific global secondary index settings.
updateReplicationGroupMemberAction_kmsMasterKeyId :: Lens' UpdateReplicationGroupMemberAction (Maybe Text) Source #
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_provisionedThroughputOverride :: Lens' UpdateReplicationGroupMemberAction (Maybe ProvisionedThroughputOverride) Source #
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
updateReplicationGroupMemberAction_tableClassOverride :: Lens' UpdateReplicationGroupMemberAction (Maybe TableClass) Source #
Replica-specific table class. If not specified, uses the source table's table class.
updateReplicationGroupMemberAction_regionName :: Lens' UpdateReplicationGroupMemberAction Text Source #
The Region where the replica exists.