Typed dictionaries
Auto-generated documentation for DynamoDB type annotations stubs module mypy-boto3-dynamodb.
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ArchivalSummaryTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ArchivalSummaryTableTypeDef
def get_value() -> ArchivalSummaryTableTypeDef:
return {
"ArchivalDateTime": ...,
}
Definition
class ArchivalSummaryTableTypeDef(TypedDict):
ArchivalDateTime: NotRequired[datetime],
ArchivalReason: NotRequired[str],
ArchivalBackupArn: NotRequired[str],
ArchivalSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ArchivalSummaryTypeDef
def get_value() -> ArchivalSummaryTypeDef:
return {
"ArchivalDateTime": ...,
}
Definition
class ArchivalSummaryTypeDef(TypedDict):
ArchivalDateTime: NotRequired[datetime],
ArchivalReason: NotRequired[str],
ArchivalBackupArn: NotRequired[str],
AttributeDefinitionServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeDefinitionServiceResourceTypeDef
def get_value() -> AttributeDefinitionServiceResourceTypeDef:
return {
"AttributeName": ...,
"AttributeType": ...,
}
Definition
class AttributeDefinitionServiceResourceTypeDef(TypedDict):
AttributeName: str,
AttributeType: ScalarAttributeTypeType, # (1)
AttributeDefinitionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeDefinitionTableTypeDef
def get_value() -> AttributeDefinitionTableTypeDef:
return {
"AttributeName": ...,
"AttributeType": ...,
}
Definition
class AttributeDefinitionTableTypeDef(TypedDict):
AttributeName: str,
AttributeType: ScalarAttributeTypeType, # (1)
AttributeDefinitionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeDefinitionTypeDef
def get_value() -> AttributeDefinitionTypeDef:
return {
"AttributeName": ...,
"AttributeType": ...,
}
Definition
class AttributeDefinitionTypeDef(TypedDict):
AttributeName: str,
AttributeType: ScalarAttributeTypeType, # (1)
AttributeValueTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeValueTypeDef
def get_value() -> AttributeValueTypeDef:
return {
"S": ...,
}
Definition
class AttributeValueTypeDef(TypedDict):
S: NotRequired[str],
N: NotRequired[str],
B: NotRequired[bytes],
SS: NotRequired[Sequence[str]],
NS: NotRequired[Sequence[str]],
BS: NotRequired[Sequence[bytes]],
M: NotRequired[Mapping[str, Any]],
L: NotRequired[Sequence[Any]],
NULL: NotRequired[bool],
BOOL: NotRequired[bool],
AttributeValueUpdateTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeValueUpdateTableTypeDef
def get_value() -> AttributeValueUpdateTableTypeDef:
return {
"Value": ...,
}
Definition
class AttributeValueUpdateTableTypeDef(TypedDict):
Value: NotRequired[Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Action: NotRequired[AttributeActionType], # (1)
AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef
def get_value() -> AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef:
return {
"TargetValue": ...,
}
Definition
class AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef(TypedDict):
TargetValue: float,
DisableScaleIn: NotRequired[bool],
ScaleInCooldown: NotRequired[int],
ScaleOutCooldown: NotRequired[int],
AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef
def get_value() -> AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef:
return {
"TargetValue": ...,
}
Definition
class AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef(TypedDict):
TargetValue: float,
DisableScaleIn: NotRequired[bool],
ScaleInCooldown: NotRequired[int],
ScaleOutCooldown: NotRequired[int],
BackupDetailsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BackupDetailsTypeDef
def get_value() -> BackupDetailsTypeDef:
return {
"BackupArn": ...,
"BackupName": ...,
"BackupStatus": ...,
"BackupType": ...,
"BackupCreationDateTime": ...,
}
Definition
class BackupDetailsTypeDef(TypedDict):
BackupArn: str,
BackupName: str,
BackupStatus: BackupStatusType, # (1)
BackupType: BackupTypeType, # (2)
BackupCreationDateTime: datetime,
BackupSizeBytes: NotRequired[int],
BackupExpiryDateTime: NotRequired[datetime],
- See BackupStatusType
- See BackupTypeType
BackupSummaryTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BackupSummaryTableTypeDef
def get_value() -> BackupSummaryTableTypeDef:
return {
"TableName": ...,
}
Definition
class BackupSummaryTableTypeDef(TypedDict):
TableName: NotRequired[str],
TableId: NotRequired[str],
TableArn: NotRequired[str],
BackupArn: NotRequired[str],
BackupName: NotRequired[str],
BackupCreationDateTime: NotRequired[datetime],
BackupExpiryDateTime: NotRequired[datetime],
BackupStatus: NotRequired[BackupStatusType], # (1)
BackupType: NotRequired[BackupTypeType], # (2)
BackupSizeBytes: NotRequired[int],
- See BackupStatusType
- See BackupTypeType
BackupSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BackupSummaryTypeDef
def get_value() -> BackupSummaryTypeDef:
return {
"TableName": ...,
}
Definition
class BackupSummaryTypeDef(TypedDict):
TableName: NotRequired[str],
TableId: NotRequired[str],
TableArn: NotRequired[str],
BackupArn: NotRequired[str],
BackupName: NotRequired[str],
BackupCreationDateTime: NotRequired[datetime],
BackupExpiryDateTime: NotRequired[datetime],
BackupStatus: NotRequired[BackupStatusType], # (1)
BackupType: NotRequired[BackupTypeType], # (2)
BackupSizeBytes: NotRequired[int],
- See BackupStatusType
- See BackupTypeType
KeysAndAttributesServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KeysAndAttributesServiceResourceTypeDef
def get_value() -> KeysAndAttributesServiceResourceTypeDef:
return {
"Keys": ...,
}
Definition
class KeysAndAttributesServiceResourceTypeDef(TypedDict):
Keys: Sequence[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
AttributesToGet: NotRequired[Sequence[str]],
ConsistentRead: NotRequired[bool],
ProjectionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
BatchStatementErrorTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchStatementErrorTypeDef
def get_value() -> BatchStatementErrorTypeDef:
return {
"Code": ...,
}
Definition
class BatchStatementErrorTypeDef(TypedDict):
Code: NotRequired[BatchStatementErrorCodeEnumType], # (1)
Message: NotRequired[str],
ItemCollectionMetricsServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ItemCollectionMetricsServiceResourceTypeDef
def get_value() -> ItemCollectionMetricsServiceResourceTypeDef:
return {
"ItemCollectionKey": ...,
}
Definition
class ItemCollectionMetricsServiceResourceTypeDef(TypedDict):
ItemCollectionKey: NotRequired[Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
SizeEstimateRangeGB: NotRequired[List[float]],
BillingModeSummaryTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BillingModeSummaryTableTypeDef
def get_value() -> BillingModeSummaryTableTypeDef:
return {
"BillingMode": ...,
}
Definition
class BillingModeSummaryTableTypeDef(TypedDict):
BillingMode: NotRequired[BillingModeType], # (1)
LastUpdateToPayPerRequestDateTime: NotRequired[datetime],
- See BillingModeType
BillingModeSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BillingModeSummaryTypeDef
def get_value() -> BillingModeSummaryTypeDef:
return {
"BillingMode": ...,
}
Definition
class BillingModeSummaryTypeDef(TypedDict):
BillingMode: NotRequired[BillingModeType], # (1)
LastUpdateToPayPerRequestDateTime: NotRequired[datetime],
- See BillingModeType
CapacityServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CapacityServiceResourceTypeDef
def get_value() -> CapacityServiceResourceTypeDef:
return {
"ReadCapacityUnits": ...,
}
Definition
class CapacityServiceResourceTypeDef(TypedDict):
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
CapacityUnits: NotRequired[float],
CapacityTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CapacityTableTypeDef
def get_value() -> CapacityTableTypeDef:
return {
"ReadCapacityUnits": ...,
}
Definition
class CapacityTableTypeDef(TypedDict):
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
CapacityUnits: NotRequired[float],
CapacityTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CapacityTypeDef
def get_value() -> CapacityTypeDef:
return {
"ReadCapacityUnits": ...,
}
Definition
class CapacityTypeDef(TypedDict):
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
CapacityUnits: NotRequired[float],
ConditionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConditionTableTypeDef
def get_value() -> ConditionTableTypeDef:
return {
"ComparisonOperator": ...,
}
Definition
class ConditionTableTypeDef(TypedDict):
ComparisonOperator: ComparisonOperatorType, # (1)
AttributeValueList: NotRequired[Sequence[Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
PointInTimeRecoveryDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PointInTimeRecoveryDescriptionTypeDef
def get_value() -> PointInTimeRecoveryDescriptionTypeDef:
return {
"PointInTimeRecoveryStatus": ...,
}
Definition
class PointInTimeRecoveryDescriptionTypeDef(TypedDict):
PointInTimeRecoveryStatus: NotRequired[PointInTimeRecoveryStatusType], # (1)
EarliestRestorableDateTime: NotRequired[datetime],
LatestRestorableDateTime: NotRequired[datetime],
ContributorInsightsSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ContributorInsightsSummaryTypeDef
def get_value() -> ContributorInsightsSummaryTypeDef:
return {
"TableName": ...,
}
Definition
class ContributorInsightsSummaryTypeDef(TypedDict):
TableName: NotRequired[str],
IndexName: NotRequired[str],
ContributorInsightsStatus: NotRequired[ContributorInsightsStatusType], # (1)
CreateBackupInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateBackupInputRequestTypeDef
def get_value() -> CreateBackupInputRequestTypeDef:
return {
"TableName": ...,
"BackupName": ...,
}
KeySchemaElementTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KeySchemaElementTableTypeDef
def get_value() -> KeySchemaElementTableTypeDef:
return {
"AttributeName": ...,
"KeyType": ...,
}
Definition
class KeySchemaElementTableTypeDef(TypedDict):
AttributeName: str,
KeyType: KeyTypeType, # (1)
- See KeyTypeType
ProjectionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProjectionTableTypeDef
def get_value() -> ProjectionTableTypeDef:
return {
"ProjectionType": ...,
}
Definition
class ProjectionTableTypeDef(TypedDict):
ProjectionType: NotRequired[ProjectionTypeType], # (1)
NonKeyAttributes: NotRequired[List[str]],
ProvisionedThroughputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputTableTypeDef
def get_value() -> ProvisionedThroughputTableTypeDef:
return {
"ReadCapacityUnits": ...,
"WriteCapacityUnits": ...,
}
Definition
class ProvisionedThroughputTableTypeDef(TypedDict):
ReadCapacityUnits: int,
WriteCapacityUnits: int,
KeySchemaElementTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KeySchemaElementTypeDef
def get_value() -> KeySchemaElementTypeDef:
return {
"AttributeName": ...,
"KeyType": ...,
}
- See KeyTypeType
ProjectionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProjectionTypeDef
def get_value() -> ProjectionTypeDef:
return {
"ProjectionType": ...,
}
Definition
class ProjectionTypeDef(TypedDict):
ProjectionType: NotRequired[ProjectionTypeType], # (1)
NonKeyAttributes: NotRequired[Sequence[str]],
ProvisionedThroughputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputTypeDef
def get_value() -> ProvisionedThroughputTypeDef:
return {
"ReadCapacityUnits": ...,
"WriteCapacityUnits": ...,
}
Definition
class ProvisionedThroughputTypeDef(TypedDict):
ReadCapacityUnits: int,
WriteCapacityUnits: int,
ReplicaTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaTypeDef
def get_value() -> ReplicaTypeDef:
return {
"RegionName": ...,
}
CreateReplicaActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateReplicaActionTypeDef
def get_value() -> CreateReplicaActionTypeDef:
return {
"RegionName": ...,
}
ProvisionedThroughputOverrideTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputOverrideTableTypeDef
def get_value() -> ProvisionedThroughputOverrideTableTypeDef:
return {
"ReadCapacityUnits": ...,
}
Definition
class ProvisionedThroughputOverrideTableTypeDef(TypedDict):
ReadCapacityUnits: NotRequired[int],
ProvisionedThroughputOverrideTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputOverrideTypeDef
def get_value() -> ProvisionedThroughputOverrideTypeDef:
return {
"ReadCapacityUnits": ...,
}
Definition
class ProvisionedThroughputOverrideTypeDef(TypedDict):
ReadCapacityUnits: NotRequired[int],
SSESpecificationTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSESpecificationTypeDef
def get_value() -> SSESpecificationTypeDef:
return {
"Enabled": ...,
}
Definition
class SSESpecificationTypeDef(TypedDict):
Enabled: NotRequired[bool],
SSEType: NotRequired[SSETypeType], # (1)
KMSMasterKeyId: NotRequired[str],
- See SSETypeType
StreamSpecificationTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import StreamSpecificationTypeDef
def get_value() -> StreamSpecificationTypeDef:
return {
"StreamEnabled": ...,
}
Definition
class StreamSpecificationTypeDef(TypedDict):
StreamEnabled: bool,
StreamViewType: NotRequired[StreamViewTypeType], # (1)
TagTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
KeySchemaElementServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KeySchemaElementServiceResourceTypeDef
def get_value() -> KeySchemaElementServiceResourceTypeDef:
return {
"AttributeName": ...,
"KeyType": ...,
}
Definition
class KeySchemaElementServiceResourceTypeDef(TypedDict):
AttributeName: str,
KeyType: KeyTypeType, # (1)
- See KeyTypeType
ProvisionedThroughputServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputServiceResourceTypeDef
def get_value() -> ProvisionedThroughputServiceResourceTypeDef:
return {
"ReadCapacityUnits": ...,
"WriteCapacityUnits": ...,
}
Definition
class ProvisionedThroughputServiceResourceTypeDef(TypedDict):
ReadCapacityUnits: int,
WriteCapacityUnits: int,
SSESpecificationServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSESpecificationServiceResourceTypeDef
def get_value() -> SSESpecificationServiceResourceTypeDef:
return {
"Enabled": ...,
}
Definition
class SSESpecificationServiceResourceTypeDef(TypedDict):
Enabled: NotRequired[bool],
SSEType: NotRequired[SSETypeType], # (1)
KMSMasterKeyId: NotRequired[str],
- See SSETypeType
StreamSpecificationServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import StreamSpecificationServiceResourceTypeDef
def get_value() -> StreamSpecificationServiceResourceTypeDef:
return {
"StreamEnabled": ...,
}
Definition
class StreamSpecificationServiceResourceTypeDef(TypedDict):
StreamEnabled: bool,
StreamViewType: NotRequired[StreamViewTypeType], # (1)
TagServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TagServiceResourceTypeDef
def get_value() -> TagServiceResourceTypeDef:
return {
"Key": ...,
"Value": ...,
}
CsvOptionsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CsvOptionsTypeDef
def get_value() -> CsvOptionsTypeDef:
return {
"Delimiter": ...,
}
Definition
class CsvOptionsTypeDef(TypedDict):
Delimiter: NotRequired[str],
HeaderList: NotRequired[List[str]],
DeleteBackupInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteBackupInputRequestTypeDef
def get_value() -> DeleteBackupInputRequestTypeDef:
return {
"BackupArn": ...,
}
DeleteGlobalSecondaryIndexActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteGlobalSecondaryIndexActionTableTypeDef
def get_value() -> DeleteGlobalSecondaryIndexActionTableTypeDef:
return {
"IndexName": ...,
}
DeleteGlobalSecondaryIndexActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteGlobalSecondaryIndexActionTypeDef
def get_value() -> DeleteGlobalSecondaryIndexActionTypeDef:
return {
"IndexName": ...,
}
ExpectedAttributeValueTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExpectedAttributeValueTableTypeDef
def get_value() -> ExpectedAttributeValueTableTypeDef:
return {
"Value": ...,
}
Definition
class ExpectedAttributeValueTableTypeDef(TypedDict):
Value: NotRequired[Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Exists: NotRequired[bool],
ComparisonOperator: NotRequired[ComparisonOperatorType], # (1)
AttributeValueList: NotRequired[Sequence[Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
ItemCollectionMetricsTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ItemCollectionMetricsTableTypeDef
def get_value() -> ItemCollectionMetricsTableTypeDef:
return {
"ItemCollectionKey": ...,
}
Definition
class ItemCollectionMetricsTableTypeDef(TypedDict):
ItemCollectionKey: NotRequired[Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
SizeEstimateRangeGB: NotRequired[List[float]],
DeleteReplicaActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteReplicaActionTypeDef
def get_value() -> DeleteReplicaActionTypeDef:
return {
"RegionName": ...,
}
DeleteReplicationGroupMemberActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteReplicationGroupMemberActionTableTypeDef
def get_value() -> DeleteReplicationGroupMemberActionTableTypeDef:
return {
"RegionName": ...,
}
DeleteReplicationGroupMemberActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteReplicationGroupMemberActionTypeDef
def get_value() -> DeleteReplicationGroupMemberActionTypeDef:
return {
"RegionName": ...,
}
DeleteRequestServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteRequestServiceResourceTypeDef
def get_value() -> DeleteRequestServiceResourceTypeDef:
return {
"Key": ...,
}
Definition
class DeleteRequestServiceResourceTypeDef(TypedDict):
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
DeleteTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteTableInputRequestTypeDef
def get_value() -> DeleteTableInputRequestTypeDef:
return {
"TableName": ...,
}
DescribeBackupInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeBackupInputRequestTypeDef
def get_value() -> DescribeBackupInputRequestTypeDef:
return {
"BackupArn": ...,
}
DescribeContinuousBackupsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeContinuousBackupsInputRequestTypeDef
def get_value() -> DescribeContinuousBackupsInputRequestTypeDef:
return {
"TableName": ...,
}
DescribeContributorInsightsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeContributorInsightsInputRequestTypeDef
def get_value() -> DescribeContributorInsightsInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class DescribeContributorInsightsInputRequestTypeDef(TypedDict):
TableName: str,
IndexName: NotRequired[str],
FailureExceptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import FailureExceptionTypeDef
def get_value() -> FailureExceptionTypeDef:
return {
"ExceptionName": ...,
}
Definition
class FailureExceptionTypeDef(TypedDict):
ExceptionName: NotRequired[str],
ExceptionDescription: NotRequired[str],
EndpointTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"Address": ...,
"CachePeriodInMinutes": ...,
}
DescribeExportInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeExportInputRequestTypeDef
def get_value() -> DescribeExportInputRequestTypeDef:
return {
"ExportArn": ...,
}
ExportDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExportDescriptionTypeDef
def get_value() -> ExportDescriptionTypeDef:
return {
"ExportArn": ...,
}
Definition
class ExportDescriptionTypeDef(TypedDict):
ExportArn: NotRequired[str],
ExportStatus: NotRequired[ExportStatusType], # (1)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
ExportManifest: NotRequired[str],
TableArn: NotRequired[str],
TableId: NotRequired[str],
ExportTime: NotRequired[datetime],
ClientToken: NotRequired[str],
S3Bucket: NotRequired[str],
S3BucketOwner: NotRequired[str],
S3Prefix: NotRequired[str],
S3SseAlgorithm: NotRequired[S3SseAlgorithmType], # (2)
S3SseKmsKeyId: NotRequired[str],
FailureCode: NotRequired[str],
FailureMessage: NotRequired[str],
ExportFormat: NotRequired[ExportFormatType], # (3)
BilledSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
- See ExportStatusType
- See S3SseAlgorithmType
- See ExportFormatType
DescribeGlobalTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableInputRequestTypeDef
def get_value() -> DescribeGlobalTableInputRequestTypeDef:
return {
"GlobalTableName": ...,
}
DescribeGlobalTableSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableSettingsInputRequestTypeDef
def get_value() -> DescribeGlobalTableSettingsInputRequestTypeDef:
return {
"GlobalTableName": ...,
}
DescribeImportInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeImportInputRequestTypeDef
def get_value() -> DescribeImportInputRequestTypeDef:
return {
"ImportArn": ...,
}
DescribeKinesisStreamingDestinationInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeKinesisStreamingDestinationInputRequestTypeDef
def get_value() -> DescribeKinesisStreamingDestinationInputRequestTypeDef:
return {
"TableName": ...,
}
KinesisDataStreamDestinationTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KinesisDataStreamDestinationTypeDef
def get_value() -> KinesisDataStreamDestinationTypeDef:
return {
"StreamArn": ...,
}
Definition
class KinesisDataStreamDestinationTypeDef(TypedDict):
StreamArn: NotRequired[str],
DestinationStatus: NotRequired[DestinationStatusType], # (1)
DestinationStatusDescription: NotRequired[str],
DescribeTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableInputRequestTypeDef
def get_value() -> DescribeTableInputRequestTypeDef:
return {
"TableName": ...,
}
WaiterConfigTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
Definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeTableReplicaAutoScalingInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableReplicaAutoScalingInputRequestTypeDef
def get_value() -> DescribeTableReplicaAutoScalingInputRequestTypeDef:
return {
"TableName": ...,
}
DescribeTimeToLiveInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTimeToLiveInputRequestTypeDef
def get_value() -> DescribeTimeToLiveInputRequestTypeDef:
return {
"TableName": ...,
}
TimeToLiveDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TimeToLiveDescriptionTypeDef
def get_value() -> TimeToLiveDescriptionTypeDef:
return {
"TimeToLiveStatus": ...,
}
Definition
class TimeToLiveDescriptionTypeDef(TypedDict):
TimeToLiveStatus: NotRequired[TimeToLiveStatusType], # (1)
AttributeName: NotRequired[str],
ExportSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExportSummaryTypeDef
def get_value() -> ExportSummaryTypeDef:
return {
"ExportArn": ...,
}
Definition
class ExportSummaryTypeDef(TypedDict):
ExportArn: NotRequired[str],
ExportStatus: NotRequired[ExportStatusType], # (1)
- See ExportStatusType
ExportTableToPointInTimeInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExportTableToPointInTimeInputRequestTypeDef
def get_value() -> ExportTableToPointInTimeInputRequestTypeDef:
return {
"TableArn": ...,
"S3Bucket": ...,
}
Definition
class ExportTableToPointInTimeInputRequestTypeDef(TypedDict):
TableArn: str,
S3Bucket: str,
ExportTime: NotRequired[Union[datetime, str]],
ClientToken: NotRequired[str],
S3BucketOwner: NotRequired[str],
S3Prefix: NotRequired[str],
S3SseAlgorithm: NotRequired[S3SseAlgorithmType], # (1)
S3SseKmsKeyId: NotRequired[str],
ExportFormat: NotRequired[ExportFormatType], # (2)
- See S3SseAlgorithmType
- See ExportFormatType
GetItemInputTableGetItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GetItemInputTableGetItemTypeDef
def get_value() -> GetItemInputTableGetItemTypeDef:
return {
"Key": ...,
}
Definition
class GetItemInputTableGetItemTypeDef(TypedDict):
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
AttributesToGet: NotRequired[Sequence[str]],
ConsistentRead: NotRequired[bool],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (1)
ProjectionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ProvisionedThroughputDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputDescriptionTableTypeDef
def get_value() -> ProvisionedThroughputDescriptionTableTypeDef:
return {
"LastIncreaseDateTime": ...,
}
Definition
class ProvisionedThroughputDescriptionTableTypeDef(TypedDict):
LastIncreaseDateTime: NotRequired[datetime],
LastDecreaseDateTime: NotRequired[datetime],
NumberOfDecreasesToday: NotRequired[int],
ReadCapacityUnits: NotRequired[int],
WriteCapacityUnits: NotRequired[int],
ProvisionedThroughputDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputDescriptionTypeDef
def get_value() -> ProvisionedThroughputDescriptionTypeDef:
return {
"LastIncreaseDateTime": ...,
}
Definition
class ProvisionedThroughputDescriptionTypeDef(TypedDict):
LastIncreaseDateTime: NotRequired[datetime],
LastDecreaseDateTime: NotRequired[datetime],
NumberOfDecreasesToday: NotRequired[int],
ReadCapacityUnits: NotRequired[int],
WriteCapacityUnits: NotRequired[int],
ProjectionServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProjectionServiceResourceTypeDef
def get_value() -> ProjectionServiceResourceTypeDef:
return {
"ProjectionType": ...,
}
Definition
class ProjectionServiceResourceTypeDef(TypedDict):
ProjectionType: NotRequired[ProjectionTypeType], # (1)
NonKeyAttributes: NotRequired[Sequence[str]],
S3BucketSourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import S3BucketSourceTypeDef
def get_value() -> S3BucketSourceTypeDef:
return {
"S3Bucket": ...,
}
Definition
class S3BucketSourceTypeDef(TypedDict):
S3Bucket: str,
S3BucketOwner: NotRequired[str],
S3KeyPrefix: NotRequired[str],
KinesisStreamingDestinationInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KinesisStreamingDestinationInputRequestTypeDef
def get_value() -> KinesisStreamingDestinationInputRequestTypeDef:
return {
"TableName": ...,
"StreamArn": ...,
}
Definition
class KinesisStreamingDestinationInputRequestTypeDef(TypedDict):
TableName: str,
StreamArn: str,
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBackupsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListBackupsInputRequestTypeDef
def get_value() -> ListBackupsInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class ListBackupsInputRequestTypeDef(TypedDict):
TableName: NotRequired[str],
Limit: NotRequired[int],
TimeRangeLowerBound: NotRequired[Union[datetime, str]],
TimeRangeUpperBound: NotRequired[Union[datetime, str]],
ExclusiveStartBackupArn: NotRequired[str],
BackupType: NotRequired[BackupTypeFilterType], # (1)
ListContributorInsightsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListContributorInsightsInputRequestTypeDef
def get_value() -> ListContributorInsightsInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class ListContributorInsightsInputRequestTypeDef(TypedDict):
TableName: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListExportsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListExportsInputRequestTypeDef
def get_value() -> ListExportsInputRequestTypeDef:
return {
"TableArn": ...,
}
Definition
class ListExportsInputRequestTypeDef(TypedDict):
TableArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListGlobalTablesInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListGlobalTablesInputRequestTypeDef
def get_value() -> ListGlobalTablesInputRequestTypeDef:
return {
"ExclusiveStartGlobalTableName": ...,
}
Definition
class ListGlobalTablesInputRequestTypeDef(TypedDict):
ExclusiveStartGlobalTableName: NotRequired[str],
Limit: NotRequired[int],
RegionName: NotRequired[str],
ListImportsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListImportsInputRequestTypeDef
def get_value() -> ListImportsInputRequestTypeDef:
return {
"TableArn": ...,
}
Definition
class ListImportsInputRequestTypeDef(TypedDict):
TableArn: NotRequired[str],
PageSize: NotRequired[int],
NextToken: NotRequired[str],
ListTablesInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTablesInputRequestTypeDef
def get_value() -> ListTablesInputRequestTypeDef:
return {
"ExclusiveStartTableName": ...,
}
Definition
class ListTablesInputRequestTypeDef(TypedDict):
ExclusiveStartTableName: NotRequired[str],
Limit: NotRequired[int],
ListTagsOfResourceInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTagsOfResourceInputRequestTypeDef
def get_value() -> ListTagsOfResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListTagsOfResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
NextToken: NotRequired[str],
TagTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TagTableTypeDef
def get_value() -> TagTableTypeDef:
return {
"Key": ...,
"Value": ...,
}
PointInTimeRecoverySpecificationTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PointInTimeRecoverySpecificationTypeDef
def get_value() -> PointInTimeRecoverySpecificationTypeDef:
return {
"PointInTimeRecoveryEnabled": ...,
}
Definition
class PointInTimeRecoverySpecificationTypeDef(TypedDict):
PointInTimeRecoveryEnabled: bool,
PutRequestServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutRequestServiceResourceTypeDef
def get_value() -> PutRequestServiceResourceTypeDef:
return {
"Item": ...,
}
Definition
class PutRequestServiceResourceTypeDef(TypedDict):
Item: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
TableClassSummaryTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableClassSummaryTableTypeDef
def get_value() -> TableClassSummaryTableTypeDef:
return {
"TableClass": ...,
}
Definition
class TableClassSummaryTableTypeDef(TypedDict):
TableClass: NotRequired[TableClassType], # (1)
LastUpdateDateTime: NotRequired[datetime],
- See TableClassType
TableClassSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableClassSummaryTypeDef
def get_value() -> TableClassSummaryTypeDef:
return {
"TableClass": ...,
}
Definition
class TableClassSummaryTypeDef(TypedDict):
TableClass: NotRequired[TableClassType], # (1)
LastUpdateDateTime: NotRequired[datetime],
- See TableClassType
RestoreSummaryTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreSummaryTableTypeDef
def get_value() -> RestoreSummaryTableTypeDef:
return {
"RestoreDateTime": ...,
"RestoreInProgress": ...,
}
Definition
class RestoreSummaryTableTypeDef(TypedDict):
RestoreDateTime: datetime,
RestoreInProgress: bool,
SourceBackupArn: NotRequired[str],
SourceTableArn: NotRequired[str],
RestoreSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreSummaryTypeDef
def get_value() -> RestoreSummaryTypeDef:
return {
"RestoreDateTime": ...,
"RestoreInProgress": ...,
}
Definition
class RestoreSummaryTypeDef(TypedDict):
RestoreDateTime: datetime,
RestoreInProgress: bool,
SourceBackupArn: NotRequired[str],
SourceTableArn: NotRequired[str],
SSEDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSEDescriptionTableTypeDef
def get_value() -> SSEDescriptionTableTypeDef:
return {
"Status": ...,
}
Definition
class SSEDescriptionTableTypeDef(TypedDict):
Status: NotRequired[SSEStatusType], # (1)
SSEType: NotRequired[SSETypeType], # (2)
KMSMasterKeyArn: NotRequired[str],
InaccessibleEncryptionDateTime: NotRequired[datetime],
- See SSEStatusType
- See SSETypeType
SSEDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSEDescriptionTypeDef
def get_value() -> SSEDescriptionTypeDef:
return {
"Status": ...,
}
Definition
class SSEDescriptionTypeDef(TypedDict):
Status: NotRequired[SSEStatusType], # (1)
SSEType: NotRequired[SSETypeType], # (2)
KMSMasterKeyArn: NotRequired[str],
InaccessibleEncryptionDateTime: NotRequired[datetime],
- See SSEStatusType
- See SSETypeType
SSESpecificationTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSESpecificationTableTypeDef
def get_value() -> SSESpecificationTableTypeDef:
return {
"Enabled": ...,
}
Definition
class SSESpecificationTableTypeDef(TypedDict):
Enabled: NotRequired[bool],
SSEType: NotRequired[SSETypeType], # (1)
KMSMasterKeyId: NotRequired[str],
- See SSETypeType
ServiceResourceTableRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ServiceResourceTableRequestTypeDef
def get_value() -> ServiceResourceTableRequestTypeDef:
return {
"name": ...,
}
StreamSpecificationTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import StreamSpecificationTableTypeDef
def get_value() -> StreamSpecificationTableTypeDef:
return {
"StreamEnabled": ...,
}
Definition
class StreamSpecificationTableTypeDef(TypedDict):
StreamEnabled: bool,
StreamViewType: NotRequired[StreamViewTypeType], # (1)
TableBatchWriterRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableBatchWriterRequestTypeDef
def get_value() -> TableBatchWriterRequestTypeDef:
return {
"overwrite_by_pkeys": ...,
}
Definition
class TableBatchWriterRequestTypeDef(TypedDict):
overwrite_by_pkeys: NotRequired[List[str]],
TimeToLiveSpecificationTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TimeToLiveSpecificationTypeDef
def get_value() -> TimeToLiveSpecificationTypeDef:
return {
"Enabled": ...,
"AttributeName": ...,
}
UntagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateContributorInsightsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateContributorInsightsInputRequestTypeDef
def get_value() -> UpdateContributorInsightsInputRequestTypeDef:
return {
"TableName": ...,
"ContributorInsightsAction": ...,
}
Definition
class UpdateContributorInsightsInputRequestTypeDef(TypedDict):
TableName: str,
ContributorInsightsAction: ContributorInsightsActionType, # (1)
IndexName: NotRequired[str],
ArchivalSummaryResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ArchivalSummaryResponseMetadataTypeDef
def get_value() -> ArchivalSummaryResponseMetadataTypeDef:
return {
"ArchivalDateTime": ...,
"ArchivalReason": ...,
"ArchivalBackupArn": ...,
"ResponseMetadata": ...,
}
Definition
class ArchivalSummaryResponseMetadataTypeDef(TypedDict):
ArchivalDateTime: datetime,
ArchivalReason: str,
ArchivalBackupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BillingModeSummaryResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BillingModeSummaryResponseMetadataTypeDef
def get_value() -> BillingModeSummaryResponseMetadataTypeDef:
return {
"BillingMode": ...,
"LastUpdateToPayPerRequestDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class BillingModeSummaryResponseMetadataTypeDef(TypedDict):
BillingMode: BillingModeType, # (1)
LastUpdateToPayPerRequestDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeLimitsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeLimitsOutputTypeDef
def get_value() -> DescribeLimitsOutputTypeDef:
return {
"AccountMaxReadCapacityUnits": ...,
"AccountMaxWriteCapacityUnits": ...,
"TableMaxReadCapacityUnits": ...,
"TableMaxWriteCapacityUnits": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeLimitsOutputTypeDef(TypedDict):
AccountMaxReadCapacityUnits: int,
AccountMaxWriteCapacityUnits: int,
TableMaxReadCapacityUnits: int,
TableMaxWriteCapacityUnits: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
KinesisStreamingDestinationOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KinesisStreamingDestinationOutputTypeDef
def get_value() -> KinesisStreamingDestinationOutputTypeDef:
return {
"TableName": ...,
"StreamArn": ...,
"DestinationStatus": ...,
"ResponseMetadata": ...,
}
Definition
class KinesisStreamingDestinationOutputTypeDef(TypedDict):
TableName: str,
StreamArn: str,
DestinationStatus: DestinationStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTablesOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTablesOutputTableTypeDef
def get_value() -> ListTablesOutputTableTypeDef:
return {
"TableNames": ...,
"LastEvaluatedTableName": ...,
"ResponseMetadata": ...,
}
Definition
class ListTablesOutputTableTypeDef(TypedDict):
TableNames: List[str],
LastEvaluatedTableName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTablesOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTablesOutputTypeDef
def get_value() -> ListTablesOutputTypeDef:
return {
"TableNames": ...,
"LastEvaluatedTableName": ...,
"ResponseMetadata": ...,
}
Definition
class ListTablesOutputTypeDef(TypedDict):
TableNames: List[str],
LastEvaluatedTableName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ProvisionedThroughputDescriptionResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ProvisionedThroughputDescriptionResponseMetadataTypeDef
def get_value() -> ProvisionedThroughputDescriptionResponseMetadataTypeDef:
return {
"LastIncreaseDateTime": ...,
"LastDecreaseDateTime": ...,
"NumberOfDecreasesToday": ...,
"ReadCapacityUnits": ...,
"WriteCapacityUnits": ...,
"ResponseMetadata": ...,
}
Definition
class ProvisionedThroughputDescriptionResponseMetadataTypeDef(TypedDict):
LastIncreaseDateTime: datetime,
LastDecreaseDateTime: datetime,
NumberOfDecreasesToday: int,
ReadCapacityUnits: int,
WriteCapacityUnits: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RestoreSummaryResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreSummaryResponseMetadataTypeDef
def get_value() -> RestoreSummaryResponseMetadataTypeDef:
return {
"SourceBackupArn": ...,
"SourceTableArn": ...,
"RestoreDateTime": ...,
"RestoreInProgress": ...,
"ResponseMetadata": ...,
}
Definition
class RestoreSummaryResponseMetadataTypeDef(TypedDict):
SourceBackupArn: str,
SourceTableArn: str,
RestoreDateTime: datetime,
RestoreInProgress: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SSEDescriptionResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SSEDescriptionResponseMetadataTypeDef
def get_value() -> SSEDescriptionResponseMetadataTypeDef:
return {
"Status": ...,
"SSEType": ...,
"KMSMasterKeyArn": ...,
"InaccessibleEncryptionDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class SSEDescriptionResponseMetadataTypeDef(TypedDict):
Status: SSEStatusType, # (1)
SSEType: SSETypeType, # (2)
KMSMasterKeyArn: str,
InaccessibleEncryptionDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See SSEStatusType
- See SSETypeType
- See ResponseMetadataTypeDef
StreamSpecificationResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import StreamSpecificationResponseMetadataTypeDef
def get_value() -> StreamSpecificationResponseMetadataTypeDef:
return {
"StreamEnabled": ...,
"StreamViewType": ...,
"ResponseMetadata": ...,
}
Definition
class StreamSpecificationResponseMetadataTypeDef(TypedDict):
StreamEnabled: bool,
StreamViewType: StreamViewTypeType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TableClassSummaryResponseMetadataTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableClassSummaryResponseMetadataTypeDef
def get_value() -> TableClassSummaryResponseMetadataTypeDef:
return {
"TableClass": ...,
"LastUpdateDateTime": ...,
"ResponseMetadata": ...,
}
Definition
class TableClassSummaryResponseMetadataTypeDef(TypedDict):
TableClass: TableClassType, # (1)
LastUpdateDateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateContributorInsightsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateContributorInsightsOutputTypeDef
def get_value() -> UpdateContributorInsightsOutputTypeDef:
return {
"TableName": ...,
"IndexName": ...,
"ContributorInsightsStatus": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateContributorInsightsOutputTypeDef(TypedDict):
TableName: str,
IndexName: str,
ContributorInsightsStatus: ContributorInsightsStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AttributeValueUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AttributeValueUpdateTypeDef
def get_value() -> AttributeValueUpdateTypeDef:
return {
"Value": ...,
}
Definition
class AttributeValueUpdateTypeDef(TypedDict):
Value: NotRequired[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Action: NotRequired[AttributeActionType], # (2)
BatchStatementRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchStatementRequestTypeDef
def get_value() -> BatchStatementRequestTypeDef:
return {
"Statement": ...,
}
Definition
class BatchStatementRequestTypeDef(TypedDict):
Statement: str,
Parameters: NotRequired[Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ConsistentRead: NotRequired[bool],
ConditionCheckTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConditionCheckTypeDef
def get_value() -> ConditionCheckTypeDef:
return {
"Key": ...,
"TableName": ...,
"ConditionExpression": ...,
}
Definition
class ConditionCheckTypeDef(TypedDict):
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
TableName: str,
ConditionExpression: str,
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ReturnValuesOnConditionCheckFailure: NotRequired[ReturnValuesOnConditionCheckFailureType], # (3)
ConditionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"ComparisonOperator": ...,
}
Definition
class ConditionTypeDef(TypedDict):
ComparisonOperator: ComparisonOperatorType, # (2)
AttributeValueList: NotRequired[Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
DeleteRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteRequestTypeDef
def get_value() -> DeleteRequestTypeDef:
return {
"Key": ...,
}
Definition
class DeleteRequestTypeDef(TypedDict):
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
DeleteTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteTypeDef
def get_value() -> DeleteTypeDef:
return {
"Key": ...,
"TableName": ...,
}
Definition
class DeleteTypeDef(TypedDict):
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
TableName: str,
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ReturnValuesOnConditionCheckFailure: NotRequired[ReturnValuesOnConditionCheckFailureType], # (3)
ExecuteStatementInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExecuteStatementInputRequestTypeDef
def get_value() -> ExecuteStatementInputRequestTypeDef:
return {
"Statement": ...,
}
Definition
class ExecuteStatementInputRequestTypeDef(TypedDict):
Statement: str,
Parameters: NotRequired[Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ConsistentRead: NotRequired[bool],
NextToken: NotRequired[str],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
Limit: NotRequired[int],
ExpectedAttributeValueTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExpectedAttributeValueTypeDef
def get_value() -> ExpectedAttributeValueTypeDef:
return {
"Value": ...,
}
Definition
class ExpectedAttributeValueTypeDef(TypedDict):
Value: NotRequired[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Exists: NotRequired[bool],
ComparisonOperator: NotRequired[ComparisonOperatorType], # (2)
AttributeValueList: NotRequired[Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (3)
GetItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GetItemInputRequestTypeDef
def get_value() -> GetItemInputRequestTypeDef:
return {
"TableName": ...,
"Key": ...,
}
Definition
class GetItemInputRequestTypeDef(TypedDict):
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
AttributesToGet: NotRequired[Sequence[str]],
ConsistentRead: NotRequired[bool],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
ProjectionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
GetTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GetTypeDef
def get_value() -> GetTypeDef:
return {
"Key": ...,
"TableName": ...,
}
Definition
class GetTypeDef(TypedDict):
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
TableName: str,
ProjectionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ItemCollectionMetricsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ItemCollectionMetricsTypeDef
def get_value() -> ItemCollectionMetricsTypeDef:
return {
"ItemCollectionKey": ...,
}
Definition
class ItemCollectionMetricsTypeDef(TypedDict):
ItemCollectionKey: NotRequired[Dict[str, AttributeValueTypeDef]], # (1)
SizeEstimateRangeGB: NotRequired[List[float]],
ItemResponseTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ItemResponseTypeDef
def get_value() -> ItemResponseTypeDef:
return {
"Item": ...,
}
Definition
class ItemResponseTypeDef(TypedDict):
Item: NotRequired[Dict[str, AttributeValueTypeDef]], # (1)
KeysAndAttributesTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import KeysAndAttributesTypeDef
def get_value() -> KeysAndAttributesTypeDef:
return {
"Keys": ...,
}
Definition
class KeysAndAttributesTypeDef(TypedDict):
Keys: Sequence[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
AttributesToGet: NotRequired[Sequence[str]],
ConsistentRead: NotRequired[bool],
ProjectionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ParameterizedStatementTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ParameterizedStatementTypeDef
def get_value() -> ParameterizedStatementTypeDef:
return {
"Statement": ...,
}
Definition
class ParameterizedStatementTypeDef(TypedDict):
Statement: str,
Parameters: NotRequired[Sequence[Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
PutRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutRequestTypeDef
def get_value() -> PutRequestTypeDef:
return {
"Item": ...,
}
Definition
class PutRequestTypeDef(TypedDict):
Item: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
PutTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutTypeDef
def get_value() -> PutTypeDef:
return {
"Item": ...,
"TableName": ...,
}
Definition
class PutTypeDef(TypedDict):
Item: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
TableName: str,
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ReturnValuesOnConditionCheckFailure: NotRequired[ReturnValuesOnConditionCheckFailureType], # (3)
UpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTypeDef
def get_value() -> UpdateTypeDef:
return {
"Key": ...,
"UpdateExpression": ...,
"TableName": ...,
}
Definition
class UpdateTypeDef(TypedDict):
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
UpdateExpression: str,
TableName: str,
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
ReturnValuesOnConditionCheckFailure: NotRequired[ReturnValuesOnConditionCheckFailureType], # (3)
AutoScalingPolicyDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingPolicyDescriptionTypeDef
def get_value() -> AutoScalingPolicyDescriptionTypeDef:
return {
"PolicyName": ...,
}
Definition
class AutoScalingPolicyDescriptionTypeDef(TypedDict):
PolicyName: NotRequired[str],
TargetTrackingScalingPolicyConfiguration: NotRequired[AutoScalingTargetTrackingScalingPolicyConfigurationDescriptionTypeDef], # (1)
AutoScalingPolicyUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingPolicyUpdateTypeDef
def get_value() -> AutoScalingPolicyUpdateTypeDef:
return {
"TargetTrackingScalingPolicyConfiguration": ...,
}
Definition
class AutoScalingPolicyUpdateTypeDef(TypedDict):
TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdateTypeDef, # (1)
PolicyName: NotRequired[str],
CreateBackupOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateBackupOutputTypeDef
def get_value() -> CreateBackupOutputTypeDef:
return {
"BackupDetails": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBackupOutputTypeDef(TypedDict):
BackupDetails: BackupDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupsOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListBackupsOutputTableTypeDef
def get_value() -> ListBackupsOutputTableTypeDef:
return {
"BackupSummaries": ...,
"LastEvaluatedBackupArn": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupsOutputTableTypeDef(TypedDict):
BackupSummaries: List[BackupSummaryTableTypeDef], # (1)
LastEvaluatedBackupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListBackupsOutputTypeDef
def get_value() -> ListBackupsOutputTypeDef:
return {
"BackupSummaries": ...,
"LastEvaluatedBackupArn": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupsOutputTypeDef(TypedDict):
BackupSummaries: List[BackupSummaryTypeDef], # (1)
LastEvaluatedBackupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetItemInputServiceResourceBatchGetItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchGetItemInputServiceResourceBatchGetItemTypeDef
def get_value() -> BatchGetItemInputServiceResourceBatchGetItemTypeDef:
return {
"RequestItems": ...,
}
Definition
class BatchGetItemInputServiceResourceBatchGetItemTypeDef(TypedDict):
RequestItems: Mapping[str, KeysAndAttributesServiceResourceTypeDef], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
BatchStatementResponseTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchStatementResponseTypeDef
def get_value() -> BatchStatementResponseTypeDef:
return {
"Error": ...,
}
Definition
class BatchStatementResponseTypeDef(TypedDict):
Error: NotRequired[BatchStatementErrorTypeDef], # (1)
TableName: NotRequired[str],
Item: NotRequired[Dict[str, AttributeValueTypeDef]], # (2)
ConsumedCapacityServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConsumedCapacityServiceResourceTypeDef
def get_value() -> ConsumedCapacityServiceResourceTypeDef:
return {
"TableName": ...,
}
Definition
class ConsumedCapacityServiceResourceTypeDef(TypedDict):
TableName: NotRequired[str],
CapacityUnits: NotRequired[float],
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
Table: NotRequired[CapacityServiceResourceTypeDef], # (1)
LocalSecondaryIndexes: NotRequired[Dict[str, CapacityServiceResourceTypeDef]], # (2)
GlobalSecondaryIndexes: NotRequired[Dict[str, CapacityServiceResourceTypeDef]], # (2)
- See CapacityServiceResourceTypeDef
- See CapacityServiceResourceTypeDef
- See CapacityServiceResourceTypeDef
ConsumedCapacityTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConsumedCapacityTableTypeDef
def get_value() -> ConsumedCapacityTableTypeDef:
return {
"TableName": ...,
}
Definition
class ConsumedCapacityTableTypeDef(TypedDict):
TableName: NotRequired[str],
CapacityUnits: NotRequired[float],
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
Table: NotRequired[CapacityTableTypeDef], # (1)
LocalSecondaryIndexes: NotRequired[Dict[str, CapacityTableTypeDef]], # (2)
GlobalSecondaryIndexes: NotRequired[Dict[str, CapacityTableTypeDef]], # (2)
ConsumedCapacityTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ConsumedCapacityTypeDef
def get_value() -> ConsumedCapacityTypeDef:
return {
"TableName": ...,
}
Definition
class ConsumedCapacityTypeDef(TypedDict):
TableName: NotRequired[str],
CapacityUnits: NotRequired[float],
ReadCapacityUnits: NotRequired[float],
WriteCapacityUnits: NotRequired[float],
Table: NotRequired[CapacityTypeDef], # (1)
LocalSecondaryIndexes: NotRequired[Dict[str, CapacityTypeDef]], # (2)
GlobalSecondaryIndexes: NotRequired[Dict[str, CapacityTypeDef]], # (2)
- See CapacityTypeDef
- See CapacityTypeDef
- See CapacityTypeDef
QueryInputTableQueryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import QueryInputTableQueryTypeDef
def get_value() -> QueryInputTableQueryTypeDef:
return {
"IndexName": ...,
}
Definition
class QueryInputTableQueryTypeDef(TypedDict):
IndexName: NotRequired[str],
Select: NotRequired[SelectType], # (1)
AttributesToGet: NotRequired[Sequence[str]],
Limit: NotRequired[int],
ConsistentRead: NotRequired[bool],
KeyConditions: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
QueryFilter: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (4)
ScanIndexForward: NotRequired[bool],
ExclusiveStartKey: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (5)
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[Union[str, ConditionBase]],
KeyConditionExpression: NotRequired[Union[str, ConditionBase]],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
- See SelectType
- See ConditionTableTypeDef
- See ConditionTableTypeDef
- See ConditionalOperatorType
- See ReturnConsumedCapacityType
ScanInputTableScanTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ScanInputTableScanTypeDef
def get_value() -> ScanInputTableScanTypeDef:
return {
"IndexName": ...,
}
Definition
class ScanInputTableScanTypeDef(TypedDict):
IndexName: NotRequired[str],
AttributesToGet: NotRequired[Sequence[str]],
Limit: NotRequired[int],
Select: NotRequired[SelectType], # (1)
ScanFilter: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (3)
ExclusiveStartKey: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (4)
TotalSegments: NotRequired[int],
Segment: NotRequired[int],
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[Union[str, ConditionBase]],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
ConsistentRead: NotRequired[bool],
ContinuousBackupsDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ContinuousBackupsDescriptionTypeDef
def get_value() -> ContinuousBackupsDescriptionTypeDef:
return {
"ContinuousBackupsStatus": ...,
}
Definition
class ContinuousBackupsDescriptionTypeDef(TypedDict):
ContinuousBackupsStatus: ContinuousBackupsStatusType, # (1)
PointInTimeRecoveryDescription: NotRequired[PointInTimeRecoveryDescriptionTypeDef], # (2)
ListContributorInsightsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListContributorInsightsOutputTypeDef
def get_value() -> ListContributorInsightsOutputTypeDef:
return {
"ContributorInsightsSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListContributorInsightsOutputTypeDef(TypedDict):
ContributorInsightsSummaries: List[ContributorInsightsSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LocalSecondaryIndexDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import LocalSecondaryIndexDescriptionTableTypeDef
def get_value() -> LocalSecondaryIndexDescriptionTableTypeDef:
return {
"IndexName": ...,
}
Definition
class LocalSecondaryIndexDescriptionTableTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTableTypeDef]], # (1)
Projection: NotRequired[ProjectionTableTypeDef], # (2)
IndexSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
IndexArn: NotRequired[str],
CreateGlobalSecondaryIndexActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateGlobalSecondaryIndexActionTableTypeDef
def get_value() -> CreateGlobalSecondaryIndexActionTableTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class CreateGlobalSecondaryIndexActionTableTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementTableTypeDef], # (1)
Projection: ProjectionTableTypeDef, # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTableTypeDef], # (3)
UpdateGlobalSecondaryIndexActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalSecondaryIndexActionTableTypeDef
def get_value() -> UpdateGlobalSecondaryIndexActionTableTypeDef:
return {
"IndexName": ...,
"ProvisionedThroughput": ...,
}
Definition
class UpdateGlobalSecondaryIndexActionTableTypeDef(TypedDict):
IndexName: str,
ProvisionedThroughput: ProvisionedThroughputTableTypeDef, # (1)
LocalSecondaryIndexDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import LocalSecondaryIndexDescriptionTypeDef
def get_value() -> LocalSecondaryIndexDescriptionTypeDef:
return {
"IndexName": ...,
}
Definition
class LocalSecondaryIndexDescriptionTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTypeDef]], # (1)
Projection: NotRequired[ProjectionTypeDef], # (2)
IndexSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
IndexArn: NotRequired[str],
LocalSecondaryIndexInfoTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import LocalSecondaryIndexInfoTypeDef
def get_value() -> LocalSecondaryIndexInfoTypeDef:
return {
"IndexName": ...,
}
Definition
class LocalSecondaryIndexInfoTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTypeDef]], # (1)
Projection: NotRequired[ProjectionTypeDef], # (2)
LocalSecondaryIndexTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import LocalSecondaryIndexTypeDef
def get_value() -> LocalSecondaryIndexTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class LocalSecondaryIndexTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementTypeDef], # (1)
Projection: ProjectionTypeDef, # (2)
CreateGlobalSecondaryIndexActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateGlobalSecondaryIndexActionTypeDef
def get_value() -> CreateGlobalSecondaryIndexActionTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class CreateGlobalSecondaryIndexActionTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementTypeDef], # (1)
Projection: ProjectionTypeDef, # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (3)
GlobalSecondaryIndexInfoTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexInfoTypeDef
def get_value() -> GlobalSecondaryIndexInfoTypeDef:
return {
"IndexName": ...,
}
Definition
class GlobalSecondaryIndexInfoTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTypeDef]], # (1)
Projection: NotRequired[ProjectionTypeDef], # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (3)
GlobalSecondaryIndexTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexTypeDef
def get_value() -> GlobalSecondaryIndexTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class GlobalSecondaryIndexTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementTypeDef], # (1)
Projection: ProjectionTypeDef, # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (3)
SourceTableDetailsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SourceTableDetailsTypeDef
def get_value() -> SourceTableDetailsTypeDef:
return {
"TableName": ...,
"TableId": ...,
"KeySchema": ...,
"TableCreationDateTime": ...,
"ProvisionedThroughput": ...,
}
Definition
class SourceTableDetailsTypeDef(TypedDict):
TableName: str,
TableId: str,
KeySchema: List[KeySchemaElementTypeDef], # (1)
TableCreationDateTime: datetime,
ProvisionedThroughput: ProvisionedThroughputTypeDef, # (2)
TableArn: NotRequired[str],
TableSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
BillingMode: NotRequired[BillingModeType], # (3)
UpdateGlobalSecondaryIndexActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalSecondaryIndexActionTypeDef
def get_value() -> UpdateGlobalSecondaryIndexActionTypeDef:
return {
"IndexName": ...,
"ProvisionedThroughput": ...,
}
Definition
class UpdateGlobalSecondaryIndexActionTypeDef(TypedDict):
IndexName: str,
ProvisionedThroughput: ProvisionedThroughputTypeDef, # (1)
CreateGlobalTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateGlobalTableInputRequestTypeDef
def get_value() -> CreateGlobalTableInputRequestTypeDef:
return {
"GlobalTableName": ...,
"ReplicationGroup": ...,
}
Definition
class CreateGlobalTableInputRequestTypeDef(TypedDict):
GlobalTableName: str,
ReplicationGroup: Sequence[ReplicaTypeDef], # (1)
- See ReplicaTypeDef
GlobalTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalTableTypeDef
def get_value() -> GlobalTableTypeDef:
return {
"GlobalTableName": ...,
}
Definition
class GlobalTableTypeDef(TypedDict):
GlobalTableName: NotRequired[str],
ReplicationGroup: NotRequired[List[ReplicaTypeDef]], # (1)
- See ReplicaTypeDef
ReplicaGlobalSecondaryIndexDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexDescriptionTableTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexDescriptionTableTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexDescriptionTableTypeDef(TypedDict):
IndexName: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTableTypeDef], # (1)
ReplicaGlobalSecondaryIndexTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexTableTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexTableTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexTableTypeDef(TypedDict):
IndexName: str,
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTableTypeDef], # (1)
ReplicaGlobalSecondaryIndexDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexDescriptionTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexDescriptionTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexDescriptionTypeDef(TypedDict):
IndexName: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTypeDef], # (1)
ReplicaGlobalSecondaryIndexTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexTypeDef(TypedDict):
IndexName: str,
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTypeDef], # (1)
ListTagsOfResourceOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTagsOfResourceOutputTypeDef
def get_value() -> ListTagsOfResourceOutputTypeDef:
return {
"Tags": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsOfResourceOutputTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
InputFormatOptionsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import InputFormatOptionsTypeDef
def get_value() -> InputFormatOptionsTypeDef:
return {
"Csv": ...,
}
DeleteItemInputTableDeleteItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteItemInputTableDeleteItemTypeDef
def get_value() -> DeleteItemInputTableDeleteItemTypeDef:
return {
"Key": ...,
}
Definition
class DeleteItemInputTableDeleteItemTypeDef(TypedDict):
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTableTypeDef]], # (1)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (2)
ReturnValues: NotRequired[ReturnValueType], # (3)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (4)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (5)
ConditionExpression: NotRequired[Union[str, ConditionBase]],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
- See ExpectedAttributeValueTableTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
PutItemInputTablePutItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutItemInputTablePutItemTypeDef
def get_value() -> PutItemInputTablePutItemTypeDef:
return {
"Item": ...,
}
Definition
class PutItemInputTablePutItemTypeDef(TypedDict):
Item: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTableTypeDef]], # (1)
ReturnValues: NotRequired[ReturnValueType], # (2)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (3)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (4)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (5)
ConditionExpression: NotRequired[Union[str, ConditionBase]],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
- See ExpectedAttributeValueTableTypeDef
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See ConditionalOperatorType
UpdateItemInputTableUpdateItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateItemInputTableUpdateItemTypeDef
def get_value() -> UpdateItemInputTableUpdateItemTypeDef:
return {
"Key": ...,
}
Definition
class UpdateItemInputTableUpdateItemTypeDef(TypedDict):
Key: Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
AttributeUpdates: NotRequired[Mapping[str, AttributeValueUpdateTableTypeDef]], # (1)
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTableTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (3)
ReturnValues: NotRequired[ReturnValueType], # (4)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (5)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (6)
UpdateExpression: NotRequired[str],
ConditionExpression: NotRequired[Union[str, ConditionBase]],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
- See AttributeValueUpdateTableTypeDef
- See ExpectedAttributeValueTableTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
ReplicaUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaUpdateTypeDef
def get_value() -> ReplicaUpdateTypeDef:
return {
"Create": ...,
}
Definition
class ReplicaUpdateTypeDef(TypedDict):
Create: NotRequired[CreateReplicaActionTypeDef], # (1)
Delete: NotRequired[DeleteReplicaActionTypeDef], # (2)
DescribeContributorInsightsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeContributorInsightsOutputTypeDef
def get_value() -> DescribeContributorInsightsOutputTypeDef:
return {
"TableName": ...,
"IndexName": ...,
"ContributorInsightsRuleList": ...,
"ContributorInsightsStatus": ...,
"LastUpdateDateTime": ...,
"FailureException": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeContributorInsightsOutputTypeDef(TypedDict):
TableName: str,
IndexName: str,
ContributorInsightsRuleList: List[str],
ContributorInsightsStatus: ContributorInsightsStatusType, # (1)
LastUpdateDateTime: datetime,
FailureException: FailureExceptionTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeEndpointsResponseTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeEndpointsResponseTypeDef
def get_value() -> DescribeEndpointsResponseTypeDef:
return {
"Endpoints": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeEndpointsResponseTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeExportOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeExportOutputTypeDef
def get_value() -> DescribeExportOutputTypeDef:
return {
"ExportDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeExportOutputTypeDef(TypedDict):
ExportDescription: ExportDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ExportTableToPointInTimeOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExportTableToPointInTimeOutputTypeDef
def get_value() -> ExportTableToPointInTimeOutputTypeDef:
return {
"ExportDescription": ...,
"ResponseMetadata": ...,
}
Definition
class ExportTableToPointInTimeOutputTypeDef(TypedDict):
ExportDescription: ExportDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeKinesisStreamingDestinationOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeKinesisStreamingDestinationOutputTypeDef
def get_value() -> DescribeKinesisStreamingDestinationOutputTypeDef:
return {
"TableName": ...,
"KinesisDataStreamDestinations": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeKinesisStreamingDestinationOutputTypeDef(TypedDict):
TableName: str,
KinesisDataStreamDestinations: List[KinesisDataStreamDestinationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTableInputTableExistsWaitTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableInputTableExistsWaitTypeDef
def get_value() -> DescribeTableInputTableExistsWaitTypeDef:
return {
"TableName": ...,
}
Definition
class DescribeTableInputTableExistsWaitTypeDef(TypedDict):
TableName: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeTableInputTableNotExistsWaitTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableInputTableNotExistsWaitTypeDef
def get_value() -> DescribeTableInputTableNotExistsWaitTypeDef:
return {
"TableName": ...,
}
Definition
class DescribeTableInputTableNotExistsWaitTypeDef(TypedDict):
TableName: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeTimeToLiveOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTimeToLiveOutputTypeDef
def get_value() -> DescribeTimeToLiveOutputTypeDef:
return {
"TimeToLiveDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTimeToLiveOutputTypeDef(TypedDict):
TimeToLiveDescription: TimeToLiveDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListExportsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListExportsOutputTypeDef
def get_value() -> ListExportsOutputTypeDef:
return {
"ExportSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListExportsOutputTypeDef(TypedDict):
ExportSummaries: List[ExportSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GlobalSecondaryIndexDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexDescriptionTableTypeDef
def get_value() -> GlobalSecondaryIndexDescriptionTableTypeDef:
return {
"IndexName": ...,
}
Definition
class GlobalSecondaryIndexDescriptionTableTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTableTypeDef]], # (1)
Projection: NotRequired[ProjectionTableTypeDef], # (2)
IndexStatus: NotRequired[IndexStatusType], # (3)
Backfilling: NotRequired[bool],
ProvisionedThroughput: NotRequired[ProvisionedThroughputDescriptionTableTypeDef], # (4)
IndexSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
IndexArn: NotRequired[str],
- See KeySchemaElementTableTypeDef
- See ProjectionTableTypeDef
- See IndexStatusType
- See ProvisionedThroughputDescriptionTableTypeDef
GlobalSecondaryIndexDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexDescriptionTypeDef
def get_value() -> GlobalSecondaryIndexDescriptionTypeDef:
return {
"IndexName": ...,
}
Definition
class GlobalSecondaryIndexDescriptionTypeDef(TypedDict):
IndexName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTypeDef]], # (1)
Projection: NotRequired[ProjectionTypeDef], # (2)
IndexStatus: NotRequired[IndexStatusType], # (3)
Backfilling: NotRequired[bool],
ProvisionedThroughput: NotRequired[ProvisionedThroughputDescriptionTypeDef], # (4)
IndexSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
IndexArn: NotRequired[str],
- See KeySchemaElementTypeDef
- See ProjectionTypeDef
- See IndexStatusType
- See ProvisionedThroughputDescriptionTypeDef
GlobalSecondaryIndexServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexServiceResourceTypeDef
def get_value() -> GlobalSecondaryIndexServiceResourceTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class GlobalSecondaryIndexServiceResourceTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementServiceResourceTypeDef], # (1)
Projection: ProjectionServiceResourceTypeDef, # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputServiceResourceTypeDef], # (3)
- See KeySchemaElementServiceResourceTypeDef
- See ProjectionServiceResourceTypeDef
- See ProvisionedThroughputServiceResourceTypeDef
LocalSecondaryIndexServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import LocalSecondaryIndexServiceResourceTypeDef
def get_value() -> LocalSecondaryIndexServiceResourceTypeDef:
return {
"IndexName": ...,
"KeySchema": ...,
"Projection": ...,
}
Definition
class LocalSecondaryIndexServiceResourceTypeDef(TypedDict):
IndexName: str,
KeySchema: Sequence[KeySchemaElementServiceResourceTypeDef], # (1)
Projection: ProjectionServiceResourceTypeDef, # (2)
ImportSummaryTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ImportSummaryTypeDef
def get_value() -> ImportSummaryTypeDef:
return {
"ImportArn": ...,
}
Definition
class ImportSummaryTypeDef(TypedDict):
ImportArn: NotRequired[str],
ImportStatus: NotRequired[ImportStatusType], # (1)
TableArn: NotRequired[str],
S3BucketSource: NotRequired[S3BucketSourceTypeDef], # (2)
CloudWatchLogGroupArn: NotRequired[str],
InputFormat: NotRequired[InputFormatType], # (3)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
- See ImportStatusType
- See S3BucketSourceTypeDef
- See InputFormatType
ListBackupsInputListBackupsPaginateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListBackupsInputListBackupsPaginateTypeDef
def get_value() -> ListBackupsInputListBackupsPaginateTypeDef:
return {
"TableName": ...,
}
Definition
class ListBackupsInputListBackupsPaginateTypeDef(TypedDict):
TableName: NotRequired[str],
TimeRangeLowerBound: NotRequired[Union[datetime, str]],
TimeRangeUpperBound: NotRequired[Union[datetime, str]],
BackupType: NotRequired[BackupTypeFilterType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListTablesInputListTablesPaginateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTablesInputListTablesPaginateTypeDef
def get_value() -> ListTablesInputListTablesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListTablesInputListTablesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsOfResourceInputListTagsOfResourcePaginateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTagsOfResourceInputListTagsOfResourcePaginateTypeDef
def get_value() -> ListTagsOfResourceInputListTagsOfResourcePaginateTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListTagsOfResourceInputListTagsOfResourcePaginateTypeDef(TypedDict):
ResourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
QueryInputQueryPaginateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import QueryInputQueryPaginateTypeDef
def get_value() -> QueryInputQueryPaginateTypeDef:
return {
"TableName": ...,
}
Definition
class QueryInputQueryPaginateTypeDef(TypedDict):
TableName: str,
IndexName: NotRequired[str],
Select: NotRequired[SelectType], # (1)
AttributesToGet: NotRequired[Sequence[str]],
ConsistentRead: NotRequired[bool],
KeyConditions: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
QueryFilter: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (4)
ScanIndexForward: NotRequired[bool],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (5)
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[str],
KeyConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (6)
- See SelectType
- See ConditionTableTypeDef
- See ConditionTableTypeDef
- See ConditionalOperatorType
- See ReturnConsumedCapacityType
- See PaginatorConfigTypeDef
ScanInputScanPaginateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ScanInputScanPaginateTypeDef
def get_value() -> ScanInputScanPaginateTypeDef:
return {
"TableName": ...,
}
Definition
class ScanInputScanPaginateTypeDef(TypedDict):
TableName: str,
IndexName: NotRequired[str],
AttributesToGet: NotRequired[Sequence[str]],
Select: NotRequired[SelectType], # (1)
ScanFilter: NotRequired[Mapping[str, ConditionTableTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (3)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (4)
TotalSegments: NotRequired[int],
Segment: NotRequired[int],
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
ConsistentRead: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (5)
- See SelectType
- See ConditionTableTypeDef
- See ConditionalOperatorType
- See ReturnConsumedCapacityType
- See PaginatorConfigTypeDef
ListTagsOfResourceOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListTagsOfResourceOutputTableTypeDef
def get_value() -> ListTagsOfResourceOutputTableTypeDef:
return {
"Tags": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsOfResourceOutputTableTypeDef(TypedDict):
Tags: List[TagTableTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateContinuousBackupsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateContinuousBackupsInputRequestTypeDef
def get_value() -> UpdateContinuousBackupsInputRequestTypeDef:
return {
"TableName": ...,
"PointInTimeRecoverySpecification": ...,
}
Definition
class UpdateContinuousBackupsInputRequestTypeDef(TypedDict):
TableName: str,
PointInTimeRecoverySpecification: PointInTimeRecoverySpecificationTypeDef, # (1)
WriteRequestServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import WriteRequestServiceResourceTypeDef
def get_value() -> WriteRequestServiceResourceTypeDef:
return {
"PutRequest": ...,
}
Definition
class WriteRequestServiceResourceTypeDef(TypedDict):
PutRequest: NotRequired[PutRequestServiceResourceTypeDef], # (1)
DeleteRequest: NotRequired[DeleteRequestServiceResourceTypeDef], # (2)
UpdateTimeToLiveInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTimeToLiveInputRequestTypeDef
def get_value() -> UpdateTimeToLiveInputRequestTypeDef:
return {
"TableName": ...,
"TimeToLiveSpecification": ...,
}
Definition
class UpdateTimeToLiveInputRequestTypeDef(TypedDict):
TableName: str,
TimeToLiveSpecification: TimeToLiveSpecificationTypeDef, # (1)
UpdateTimeToLiveOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTimeToLiveOutputTypeDef
def get_value() -> UpdateTimeToLiveOutputTypeDef:
return {
"TimeToLiveSpecification": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTimeToLiveOutputTypeDef(TypedDict):
TimeToLiveSpecification: TimeToLiveSpecificationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchExecuteStatementInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchExecuteStatementInputRequestTypeDef
def get_value() -> BatchExecuteStatementInputRequestTypeDef:
return {
"Statements": ...,
}
Definition
class BatchExecuteStatementInputRequestTypeDef(TypedDict):
Statements: Sequence[BatchStatementRequestTypeDef], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
QueryInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import QueryInputRequestTypeDef
def get_value() -> QueryInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class QueryInputRequestTypeDef(TypedDict):
TableName: str,
IndexName: NotRequired[str],
Select: NotRequired[SelectType], # (1)
AttributesToGet: NotRequired[Sequence[str]],
Limit: NotRequired[int],
ConsistentRead: NotRequired[bool],
KeyConditions: NotRequired[Mapping[str, ConditionTypeDef]], # (2)
QueryFilter: NotRequired[Mapping[str, ConditionTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (4)
ScanIndexForward: NotRequired[bool],
ExclusiveStartKey: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (5)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (6)
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[str],
KeyConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (5)
- See SelectType
- See ConditionTypeDef
- See ConditionTypeDef
- See ConditionalOperatorType
- See AttributeValueTypeDef
- See ReturnConsumedCapacityType
- See AttributeValueTypeDef
ScanInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ScanInputRequestTypeDef
def get_value() -> ScanInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class ScanInputRequestTypeDef(TypedDict):
TableName: str,
IndexName: NotRequired[str],
AttributesToGet: NotRequired[Sequence[str]],
Limit: NotRequired[int],
Select: NotRequired[SelectType], # (1)
ScanFilter: NotRequired[Mapping[str, ConditionTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (3)
ExclusiveStartKey: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (4)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (5)
TotalSegments: NotRequired[int],
Segment: NotRequired[int],
ProjectionExpression: NotRequired[str],
FilterExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (4)
ConsistentRead: NotRequired[bool],
- See SelectType
- See ConditionTypeDef
- See ConditionalOperatorType
- See AttributeValueTypeDef
- See ReturnConsumedCapacityType
- See AttributeValueTypeDef
DeleteItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteItemInputRequestTypeDef
def get_value() -> DeleteItemInputRequestTypeDef:
return {
"TableName": ...,
"Key": ...,
}
Definition
class DeleteItemInputRequestTypeDef(TypedDict):
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTypeDef]], # (2)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (3)
ReturnValues: NotRequired[ReturnValueType], # (4)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (5)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (6)
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
- See AttributeValueTypeDef
- See ExpectedAttributeValueTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See AttributeValueTypeDef
PutItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutItemInputRequestTypeDef
def get_value() -> PutItemInputRequestTypeDef:
return {
"TableName": ...,
"Item": ...,
}
Definition
class PutItemInputRequestTypeDef(TypedDict):
TableName: str,
Item: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTypeDef]], # (2)
ReturnValues: NotRequired[ReturnValueType], # (3)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (4)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (5)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (6)
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
- See AttributeValueTypeDef
- See ExpectedAttributeValueTypeDef
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See ConditionalOperatorType
- See AttributeValueTypeDef
UpdateItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateItemInputRequestTypeDef
def get_value() -> UpdateItemInputRequestTypeDef:
return {
"TableName": ...,
"Key": ...,
}
Definition
class UpdateItemInputRequestTypeDef(TypedDict):
TableName: str,
Key: Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]], # (1)
AttributeUpdates: NotRequired[Mapping[str, AttributeValueUpdateTypeDef]], # (2)
Expected: NotRequired[Mapping[str, ExpectedAttributeValueTypeDef]], # (3)
ConditionalOperator: NotRequired[ConditionalOperatorType], # (4)
ReturnValues: NotRequired[ReturnValueType], # (5)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (6)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (7)
UpdateExpression: NotRequired[str],
ConditionExpression: NotRequired[str],
ExpressionAttributeNames: NotRequired[Mapping[str, str]],
ExpressionAttributeValues: NotRequired[Mapping[str, Union[AttributeValueTypeDef, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]], # (1)
- See AttributeValueTypeDef
- See AttributeValueUpdateTypeDef
- See ExpectedAttributeValueTypeDef
- See ConditionalOperatorType
- See ReturnValueType
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
- See AttributeValueTypeDef
TransactGetItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactGetItemTypeDef
def get_value() -> TransactGetItemTypeDef:
return {
"Get": ...,
}
- See GetTypeDef
BatchGetItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchGetItemInputRequestTypeDef
def get_value() -> BatchGetItemInputRequestTypeDef:
return {
"RequestItems": ...,
}
Definition
class BatchGetItemInputRequestTypeDef(TypedDict):
RequestItems: Mapping[str, KeysAndAttributesTypeDef], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
ExecuteTransactionInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExecuteTransactionInputRequestTypeDef
def get_value() -> ExecuteTransactionInputRequestTypeDef:
return {
"TransactStatements": ...,
}
Definition
class ExecuteTransactionInputRequestTypeDef(TypedDict):
TransactStatements: Sequence[ParameterizedStatementTypeDef], # (1)
ClientRequestToken: NotRequired[str],
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
WriteRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import WriteRequestTypeDef
def get_value() -> WriteRequestTypeDef:
return {
"PutRequest": ...,
}
Definition
class WriteRequestTypeDef(TypedDict):
PutRequest: NotRequired[PutRequestTypeDef], # (1)
DeleteRequest: NotRequired[DeleteRequestTypeDef], # (2)
TransactWriteItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactWriteItemTypeDef
def get_value() -> TransactWriteItemTypeDef:
return {
"ConditionCheck": ...,
}
Definition
class TransactWriteItemTypeDef(TypedDict):
ConditionCheck: NotRequired[ConditionCheckTypeDef], # (1)
Put: NotRequired[PutTypeDef], # (2)
Delete: NotRequired[DeleteTypeDef], # (3)
Update: NotRequired[UpdateTypeDef], # (4)
- See ConditionCheckTypeDef
- See PutTypeDef
- See DeleteTypeDef
- See UpdateTypeDef
AutoScalingSettingsDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingSettingsDescriptionTypeDef
def get_value() -> AutoScalingSettingsDescriptionTypeDef:
return {
"MinimumUnits": ...,
}
Definition
class AutoScalingSettingsDescriptionTypeDef(TypedDict):
MinimumUnits: NotRequired[int],
MaximumUnits: NotRequired[int],
AutoScalingDisabled: NotRequired[bool],
AutoScalingRoleArn: NotRequired[str],
ScalingPolicies: NotRequired[List[AutoScalingPolicyDescriptionTypeDef]], # (1)
AutoScalingSettingsUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import AutoScalingSettingsUpdateTypeDef
def get_value() -> AutoScalingSettingsUpdateTypeDef:
return {
"MinimumUnits": ...,
}
Definition
class AutoScalingSettingsUpdateTypeDef(TypedDict):
MinimumUnits: NotRequired[int],
MaximumUnits: NotRequired[int],
AutoScalingDisabled: NotRequired[bool],
AutoScalingRoleArn: NotRequired[str],
ScalingPolicyUpdate: NotRequired[AutoScalingPolicyUpdateTypeDef], # (1)
BatchGetItemOutputServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchGetItemOutputServiceResourceTypeDef
def get_value() -> BatchGetItemOutputServiceResourceTypeDef:
return {
"Responses": ...,
"UnprocessedKeys": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetItemOutputServiceResourceTypeDef(TypedDict):
Responses: Dict[str, List[Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]]],
UnprocessedKeys: Dict[str, KeysAndAttributesServiceResourceTypeDef], # (1)
ConsumedCapacity: List[ConsumedCapacityServiceResourceTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See KeysAndAttributesServiceResourceTypeDef
- See ConsumedCapacityServiceResourceTypeDef
- See ResponseMetadataTypeDef
DeleteItemOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteItemOutputTableTypeDef
def get_value() -> DeleteItemOutputTableTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteItemOutputTableTypeDef(TypedDict):
Attributes: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ItemCollectionMetrics: ItemCollectionMetricsTableTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetItemOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GetItemOutputTableTypeDef
def get_value() -> GetItemOutputTableTypeDef:
return {
"Item": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class GetItemOutputTableTypeDef(TypedDict):
Item: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutItemOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutItemOutputTableTypeDef
def get_value() -> PutItemOutputTableTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class PutItemOutputTableTypeDef(TypedDict):
Attributes: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ItemCollectionMetrics: ItemCollectionMetricsTableTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
QueryOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import QueryOutputTableTypeDef
def get_value() -> QueryOutputTableTypeDef:
return {
"Items": ...,
"Count": ...,
"ScannedCount": ...,
"LastEvaluatedKey": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class QueryOutputTableTypeDef(TypedDict):
Items: List[Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
Count: int,
ScannedCount: int,
LastEvaluatedKey: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ScanOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ScanOutputTableTypeDef
def get_value() -> ScanOutputTableTypeDef:
return {
"Items": ...,
"Count": ...,
"ScannedCount": ...,
"LastEvaluatedKey": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class ScanOutputTableTypeDef(TypedDict):
Items: List[Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]]],
Count: int,
ScannedCount: int,
LastEvaluatedKey: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateItemOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateItemOutputTableTypeDef
def get_value() -> UpdateItemOutputTableTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateItemOutputTableTypeDef(TypedDict):
Attributes: Dict[str, Union[bytes, bytearray, str, int, Decimal, bool, Set[int], Set[Decimal], Set[str], Set[bytes], Set[bytearray], Sequence[Any], Mapping[str, Any], None]],
ConsumedCapacity: ConsumedCapacityTableTypeDef, # (1)
ItemCollectionMetrics: ItemCollectionMetricsTableTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchExecuteStatementOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchExecuteStatementOutputTypeDef
def get_value() -> BatchExecuteStatementOutputTypeDef:
return {
"Responses": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class BatchExecuteStatementOutputTypeDef(TypedDict):
Responses: List[BatchStatementResponseTypeDef], # (1)
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
BatchGetItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchGetItemOutputTypeDef
def get_value() -> BatchGetItemOutputTypeDef:
return {
"Responses": ...,
"UnprocessedKeys": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class BatchGetItemOutputTypeDef(TypedDict):
Responses: Dict[str, List[Dict[str, AttributeValueTypeDef]]], # (1)
UnprocessedKeys: Dict[str, KeysAndAttributesTypeDef], # (2)
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See KeysAndAttributesTypeDef
- See ConsumedCapacityTypeDef
- See ResponseMetadataTypeDef
DeleteItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteItemOutputTypeDef
def get_value() -> DeleteItemOutputTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteItemOutputTypeDef(TypedDict):
Attributes: Dict[str, AttributeValueTypeDef], # (1)
ConsumedCapacity: ConsumedCapacityTypeDef, # (2)
ItemCollectionMetrics: ItemCollectionMetricsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See ItemCollectionMetricsTypeDef
- See ResponseMetadataTypeDef
ExecuteStatementOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExecuteStatementOutputTypeDef
def get_value() -> ExecuteStatementOutputTypeDef:
return {
"Items": ...,
"NextToken": ...,
"ConsumedCapacity": ...,
"LastEvaluatedKey": ...,
"ResponseMetadata": ...,
}
Definition
class ExecuteStatementOutputTypeDef(TypedDict):
Items: List[Dict[str, AttributeValueTypeDef]], # (1)
NextToken: str,
ConsumedCapacity: ConsumedCapacityTypeDef, # (2)
LastEvaluatedKey: Dict[str, AttributeValueTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See AttributeValueTypeDef
- See ResponseMetadataTypeDef
ExecuteTransactionOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ExecuteTransactionOutputTypeDef
def get_value() -> ExecuteTransactionOutputTypeDef:
return {
"Responses": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class ExecuteTransactionOutputTypeDef(TypedDict):
Responses: List[ItemResponseTypeDef], # (1)
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GetItemOutputTypeDef
def get_value() -> GetItemOutputTypeDef:
return {
"Item": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class GetItemOutputTypeDef(TypedDict):
Item: Dict[str, AttributeValueTypeDef], # (1)
ConsumedCapacity: ConsumedCapacityTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import PutItemOutputTypeDef
def get_value() -> PutItemOutputTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class PutItemOutputTypeDef(TypedDict):
Attributes: Dict[str, AttributeValueTypeDef], # (1)
ConsumedCapacity: ConsumedCapacityTypeDef, # (2)
ItemCollectionMetrics: ItemCollectionMetricsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See ItemCollectionMetricsTypeDef
- See ResponseMetadataTypeDef
QueryOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import QueryOutputTypeDef
def get_value() -> QueryOutputTypeDef:
return {
"Items": ...,
"Count": ...,
"ScannedCount": ...,
"LastEvaluatedKey": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class QueryOutputTypeDef(TypedDict):
Items: List[Dict[str, AttributeValueTypeDef]], # (1)
Count: int,
ScannedCount: int,
LastEvaluatedKey: Dict[str, AttributeValueTypeDef], # (2)
ConsumedCapacity: ConsumedCapacityTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See ResponseMetadataTypeDef
ScanOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ScanOutputTypeDef
def get_value() -> ScanOutputTypeDef:
return {
"Items": ...,
"Count": ...,
"ScannedCount": ...,
"LastEvaluatedKey": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class ScanOutputTypeDef(TypedDict):
Items: List[Dict[str, AttributeValueTypeDef]], # (1)
Count: int,
ScannedCount: int,
LastEvaluatedKey: Dict[str, AttributeValueTypeDef], # (2)
ConsumedCapacity: ConsumedCapacityTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See ResponseMetadataTypeDef
TransactGetItemsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactGetItemsOutputTypeDef
def get_value() -> TransactGetItemsOutputTypeDef:
return {
"ConsumedCapacity": ...,
"Responses": ...,
"ResponseMetadata": ...,
}
Definition
class TransactGetItemsOutputTypeDef(TypedDict):
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (1)
Responses: List[ItemResponseTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
TransactWriteItemsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactWriteItemsOutputTypeDef
def get_value() -> TransactWriteItemsOutputTypeDef:
return {
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class TransactWriteItemsOutputTypeDef(TypedDict):
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (1)
ItemCollectionMetrics: Dict[str, List[ItemCollectionMetricsTypeDef]], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateItemOutputTypeDef
def get_value() -> UpdateItemOutputTypeDef:
return {
"Attributes": ...,
"ConsumedCapacity": ...,
"ItemCollectionMetrics": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateItemOutputTypeDef(TypedDict):
Attributes: Dict[str, AttributeValueTypeDef], # (1)
ConsumedCapacity: ConsumedCapacityTypeDef, # (2)
ItemCollectionMetrics: ItemCollectionMetricsTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AttributeValueTypeDef
- See ConsumedCapacityTypeDef
- See ItemCollectionMetricsTypeDef
- See ResponseMetadataTypeDef
DescribeContinuousBackupsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeContinuousBackupsOutputTypeDef
def get_value() -> DescribeContinuousBackupsOutputTypeDef:
return {
"ContinuousBackupsDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeContinuousBackupsOutputTypeDef(TypedDict):
ContinuousBackupsDescription: ContinuousBackupsDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateContinuousBackupsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateContinuousBackupsOutputTypeDef
def get_value() -> UpdateContinuousBackupsOutputTypeDef:
return {
"ContinuousBackupsDescription": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateContinuousBackupsOutputTypeDef(TypedDict):
ContinuousBackupsDescription: ContinuousBackupsDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GlobalSecondaryIndexUpdateTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexUpdateTableTypeDef
def get_value() -> GlobalSecondaryIndexUpdateTableTypeDef:
return {
"Update": ...,
}
Definition
class GlobalSecondaryIndexUpdateTableTypeDef(TypedDict):
Update: NotRequired[UpdateGlobalSecondaryIndexActionTableTypeDef], # (1)
Create: NotRequired[CreateGlobalSecondaryIndexActionTableTypeDef], # (2)
Delete: NotRequired[DeleteGlobalSecondaryIndexActionTableTypeDef], # (3)
- See UpdateGlobalSecondaryIndexActionTableTypeDef
- See CreateGlobalSecondaryIndexActionTableTypeDef
- See DeleteGlobalSecondaryIndexActionTableTypeDef
SourceTableFeatureDetailsTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import SourceTableFeatureDetailsTypeDef
def get_value() -> SourceTableFeatureDetailsTypeDef:
return {
"LocalSecondaryIndexes": ...,
}
Definition
class SourceTableFeatureDetailsTypeDef(TypedDict):
LocalSecondaryIndexes: NotRequired[List[LocalSecondaryIndexInfoTypeDef]], # (1)
GlobalSecondaryIndexes: NotRequired[List[GlobalSecondaryIndexInfoTypeDef]], # (2)
StreamDescription: NotRequired[StreamSpecificationTypeDef], # (3)
TimeToLiveDescription: NotRequired[TimeToLiveDescriptionTypeDef], # (4)
SSEDescription: NotRequired[SSEDescriptionTypeDef], # (5)
- See LocalSecondaryIndexInfoTypeDef
- See GlobalSecondaryIndexInfoTypeDef
- See StreamSpecificationTypeDef
- See TimeToLiveDescriptionTypeDef
- See SSEDescriptionTypeDef
CreateTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateTableInputRequestTypeDef
def get_value() -> CreateTableInputRequestTypeDef:
return {
"AttributeDefinitions": ...,
"TableName": ...,
"KeySchema": ...,
}
Definition
class CreateTableInputRequestTypeDef(TypedDict):
AttributeDefinitions: Sequence[AttributeDefinitionTypeDef], # (1)
TableName: str,
KeySchema: Sequence[KeySchemaElementTypeDef], # (2)
LocalSecondaryIndexes: NotRequired[Sequence[LocalSecondaryIndexTypeDef]], # (3)
GlobalSecondaryIndexes: NotRequired[Sequence[GlobalSecondaryIndexTypeDef]], # (4)
BillingMode: NotRequired[BillingModeType], # (5)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (6)
StreamSpecification: NotRequired[StreamSpecificationTypeDef], # (7)
SSESpecification: NotRequired[SSESpecificationTypeDef], # (8)
Tags: NotRequired[Sequence[TagTypeDef]], # (9)
TableClass: NotRequired[TableClassType], # (10)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionTypeDef
- See KeySchemaElementTypeDef
- See LocalSecondaryIndexTypeDef
- See GlobalSecondaryIndexTypeDef
- See BillingModeType
- See ProvisionedThroughputTypeDef
- See StreamSpecificationTypeDef
- See SSESpecificationTypeDef
- See TagTypeDef
- See TableClassType
RestoreTableFromBackupInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreTableFromBackupInputRequestTypeDef
def get_value() -> RestoreTableFromBackupInputRequestTypeDef:
return {
"TargetTableName": ...,
"BackupArn": ...,
}
Definition
class RestoreTableFromBackupInputRequestTypeDef(TypedDict):
TargetTableName: str,
BackupArn: str,
BillingModeOverride: NotRequired[BillingModeType], # (1)
GlobalSecondaryIndexOverride: NotRequired[Sequence[GlobalSecondaryIndexTypeDef]], # (2)
LocalSecondaryIndexOverride: NotRequired[Sequence[LocalSecondaryIndexTypeDef]], # (3)
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputTypeDef], # (4)
SSESpecificationOverride: NotRequired[SSESpecificationTypeDef], # (5)
- See BillingModeType
- See GlobalSecondaryIndexTypeDef
- See LocalSecondaryIndexTypeDef
- See ProvisionedThroughputTypeDef
- See SSESpecificationTypeDef
RestoreTableToPointInTimeInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreTableToPointInTimeInputRequestTypeDef
def get_value() -> RestoreTableToPointInTimeInputRequestTypeDef:
return {
"TargetTableName": ...,
}
Definition
class RestoreTableToPointInTimeInputRequestTypeDef(TypedDict):
TargetTableName: str,
SourceTableArn: NotRequired[str],
SourceTableName: NotRequired[str],
UseLatestRestorableTime: NotRequired[bool],
RestoreDateTime: NotRequired[Union[datetime, str]],
BillingModeOverride: NotRequired[BillingModeType], # (1)
GlobalSecondaryIndexOverride: NotRequired[Sequence[GlobalSecondaryIndexTypeDef]], # (2)
LocalSecondaryIndexOverride: NotRequired[Sequence[LocalSecondaryIndexTypeDef]], # (3)
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputTypeDef], # (4)
SSESpecificationOverride: NotRequired[SSESpecificationTypeDef], # (5)
- See BillingModeType
- See GlobalSecondaryIndexTypeDef
- See LocalSecondaryIndexTypeDef
- See ProvisionedThroughputTypeDef
- See SSESpecificationTypeDef
TableCreationParametersTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableCreationParametersTypeDef
def get_value() -> TableCreationParametersTypeDef:
return {
"TableName": ...,
"AttributeDefinitions": ...,
"KeySchema": ...,
}
Definition
class TableCreationParametersTypeDef(TypedDict):
TableName: str,
AttributeDefinitions: List[AttributeDefinitionTypeDef], # (1)
KeySchema: List[KeySchemaElementTypeDef], # (2)
BillingMode: NotRequired[BillingModeType], # (3)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (4)
SSESpecification: NotRequired[SSESpecificationTypeDef], # (5)
GlobalSecondaryIndexes: NotRequired[List[GlobalSecondaryIndexTypeDef]], # (6)
- See AttributeDefinitionTypeDef
- See KeySchemaElementTypeDef
- See BillingModeType
- See ProvisionedThroughputTypeDef
- See SSESpecificationTypeDef
- See GlobalSecondaryIndexTypeDef
GlobalSecondaryIndexUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexUpdateTypeDef
def get_value() -> GlobalSecondaryIndexUpdateTypeDef:
return {
"Update": ...,
}
Definition
class GlobalSecondaryIndexUpdateTypeDef(TypedDict):
Update: NotRequired[UpdateGlobalSecondaryIndexActionTypeDef], # (1)
Create: NotRequired[CreateGlobalSecondaryIndexActionTypeDef], # (2)
Delete: NotRequired[DeleteGlobalSecondaryIndexActionTypeDef], # (3)
- See UpdateGlobalSecondaryIndexActionTypeDef
- See CreateGlobalSecondaryIndexActionTypeDef
- See DeleteGlobalSecondaryIndexActionTypeDef
ListGlobalTablesOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListGlobalTablesOutputTypeDef
def get_value() -> ListGlobalTablesOutputTypeDef:
return {
"GlobalTables": ...,
"LastEvaluatedGlobalTableName": ...,
"ResponseMetadata": ...,
}
Definition
class ListGlobalTablesOutputTypeDef(TypedDict):
GlobalTables: List[GlobalTableTypeDef], # (1)
LastEvaluatedGlobalTableName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReplicaDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaDescriptionTableTypeDef
def get_value() -> ReplicaDescriptionTableTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaDescriptionTableTypeDef(TypedDict):
RegionName: NotRequired[str],
ReplicaStatus: NotRequired[ReplicaStatusType], # (1)
ReplicaStatusDescription: NotRequired[str],
ReplicaStatusPercentProgress: NotRequired[str],
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTableTypeDef], # (2)
GlobalSecondaryIndexes: NotRequired[List[ReplicaGlobalSecondaryIndexDescriptionTableTypeDef]], # (3)
ReplicaInaccessibleDateTime: NotRequired[datetime],
ReplicaTableClassSummary: NotRequired[TableClassSummaryTableTypeDef], # (4)
- See ReplicaStatusType
- See ProvisionedThroughputOverrideTableTypeDef
- See ReplicaGlobalSecondaryIndexDescriptionTableTypeDef
- See TableClassSummaryTableTypeDef
CreateReplicationGroupMemberActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateReplicationGroupMemberActionTableTypeDef
def get_value() -> CreateReplicationGroupMemberActionTableTypeDef:
return {
"RegionName": ...,
}
Definition
class CreateReplicationGroupMemberActionTableTypeDef(TypedDict):
RegionName: str,
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTableTypeDef], # (1)
GlobalSecondaryIndexes: NotRequired[Sequence[ReplicaGlobalSecondaryIndexTableTypeDef]], # (2)
TableClassOverride: NotRequired[TableClassType], # (3)
- See ProvisionedThroughputOverrideTableTypeDef
- See ReplicaGlobalSecondaryIndexTableTypeDef
- See TableClassType
UpdateReplicationGroupMemberActionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateReplicationGroupMemberActionTableTypeDef
def get_value() -> UpdateReplicationGroupMemberActionTableTypeDef:
return {
"RegionName": ...,
}
Definition
class UpdateReplicationGroupMemberActionTableTypeDef(TypedDict):
RegionName: str,
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTableTypeDef], # (1)
GlobalSecondaryIndexes: NotRequired[Sequence[ReplicaGlobalSecondaryIndexTableTypeDef]], # (2)
TableClassOverride: NotRequired[TableClassType], # (3)
- See ProvisionedThroughputOverrideTableTypeDef
- See ReplicaGlobalSecondaryIndexTableTypeDef
- See TableClassType
ReplicaDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaDescriptionTypeDef
def get_value() -> ReplicaDescriptionTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaDescriptionTypeDef(TypedDict):
RegionName: NotRequired[str],
ReplicaStatus: NotRequired[ReplicaStatusType], # (1)
ReplicaStatusDescription: NotRequired[str],
ReplicaStatusPercentProgress: NotRequired[str],
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTypeDef], # (2)
GlobalSecondaryIndexes: NotRequired[List[ReplicaGlobalSecondaryIndexDescriptionTypeDef]], # (3)
ReplicaInaccessibleDateTime: NotRequired[datetime],
ReplicaTableClassSummary: NotRequired[TableClassSummaryTypeDef], # (4)
- See ReplicaStatusType
- See ProvisionedThroughputOverrideTypeDef
- See ReplicaGlobalSecondaryIndexDescriptionTypeDef
- See TableClassSummaryTypeDef
CreateReplicationGroupMemberActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateReplicationGroupMemberActionTypeDef
def get_value() -> CreateReplicationGroupMemberActionTypeDef:
return {
"RegionName": ...,
}
Definition
class CreateReplicationGroupMemberActionTypeDef(TypedDict):
RegionName: str,
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTypeDef], # (1)
GlobalSecondaryIndexes: NotRequired[Sequence[ReplicaGlobalSecondaryIndexTypeDef]], # (2)
TableClassOverride: NotRequired[TableClassType], # (3)
UpdateReplicationGroupMemberActionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateReplicationGroupMemberActionTypeDef
def get_value() -> UpdateReplicationGroupMemberActionTypeDef:
return {
"RegionName": ...,
}
Definition
class UpdateReplicationGroupMemberActionTypeDef(TypedDict):
RegionName: str,
KMSMasterKeyId: NotRequired[str],
ProvisionedThroughputOverride: NotRequired[ProvisionedThroughputOverrideTypeDef], # (1)
GlobalSecondaryIndexes: NotRequired[Sequence[ReplicaGlobalSecondaryIndexTypeDef]], # (2)
TableClassOverride: NotRequired[TableClassType], # (3)
UpdateGlobalTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalTableInputRequestTypeDef
def get_value() -> UpdateGlobalTableInputRequestTypeDef:
return {
"GlobalTableName": ...,
"ReplicaUpdates": ...,
}
Definition
class UpdateGlobalTableInputRequestTypeDef(TypedDict):
GlobalTableName: str,
ReplicaUpdates: Sequence[ReplicaUpdateTypeDef], # (1)
CreateTableInputServiceResourceCreateTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateTableInputServiceResourceCreateTableTypeDef
def get_value() -> CreateTableInputServiceResourceCreateTableTypeDef:
return {
"AttributeDefinitions": ...,
"TableName": ...,
"KeySchema": ...,
}
Definition
class CreateTableInputServiceResourceCreateTableTypeDef(TypedDict):
AttributeDefinitions: Sequence[AttributeDefinitionServiceResourceTypeDef], # (1)
TableName: str,
KeySchema: Sequence[KeySchemaElementServiceResourceTypeDef], # (2)
LocalSecondaryIndexes: NotRequired[Sequence[LocalSecondaryIndexServiceResourceTypeDef]], # (3)
GlobalSecondaryIndexes: NotRequired[Sequence[GlobalSecondaryIndexServiceResourceTypeDef]], # (4)
BillingMode: NotRequired[BillingModeType], # (5)
ProvisionedThroughput: NotRequired[ProvisionedThroughputServiceResourceTypeDef], # (6)
StreamSpecification: NotRequired[StreamSpecificationServiceResourceTypeDef], # (7)
SSESpecification: NotRequired[SSESpecificationServiceResourceTypeDef], # (8)
Tags: NotRequired[Sequence[TagServiceResourceTypeDef]], # (9)
TableClass: NotRequired[TableClassType], # (10)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionServiceResourceTypeDef
- See KeySchemaElementServiceResourceTypeDef
- See LocalSecondaryIndexServiceResourceTypeDef
- See GlobalSecondaryIndexServiceResourceTypeDef
- See BillingModeType
- See ProvisionedThroughputServiceResourceTypeDef
- See StreamSpecificationServiceResourceTypeDef
- See SSESpecificationServiceResourceTypeDef
- See TagServiceResourceTypeDef
- See TableClassType
ListImportsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ListImportsOutputTypeDef
def get_value() -> ListImportsOutputTypeDef:
return {
"ImportSummaryList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListImportsOutputTypeDef(TypedDict):
ImportSummaryList: List[ImportSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchWriteItemInputServiceResourceBatchWriteItemTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchWriteItemInputServiceResourceBatchWriteItemTypeDef
def get_value() -> BatchWriteItemInputServiceResourceBatchWriteItemTypeDef:
return {
"RequestItems": ...,
}
Definition
class BatchWriteItemInputServiceResourceBatchWriteItemTypeDef(TypedDict):
RequestItems: Mapping[str, Sequence[WriteRequestServiceResourceTypeDef]], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (3)
- See WriteRequestServiceResourceTypeDef
- See ReturnConsumedCapacityType
- See ReturnItemCollectionMetricsType
BatchWriteItemOutputServiceResourceTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchWriteItemOutputServiceResourceTypeDef
def get_value() -> BatchWriteItemOutputServiceResourceTypeDef:
return {
"UnprocessedItems": ...,
"ItemCollectionMetrics": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class BatchWriteItemOutputServiceResourceTypeDef(TypedDict):
UnprocessedItems: Dict[str, List[WriteRequestServiceResourceTypeDef]], # (1)
ItemCollectionMetrics: Dict[str, List[ItemCollectionMetricsServiceResourceTypeDef]], # (2)
ConsumedCapacity: List[ConsumedCapacityServiceResourceTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See WriteRequestServiceResourceTypeDef
- See ItemCollectionMetricsServiceResourceTypeDef
- See ConsumedCapacityServiceResourceTypeDef
- See ResponseMetadataTypeDef
TransactGetItemsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactGetItemsInputRequestTypeDef
def get_value() -> TransactGetItemsInputRequestTypeDef:
return {
"TransactItems": ...,
}
Definition
class TransactGetItemsInputRequestTypeDef(TypedDict):
TransactItems: Sequence[TransactGetItemTypeDef], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
BatchWriteItemInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchWriteItemInputRequestTypeDef
def get_value() -> BatchWriteItemInputRequestTypeDef:
return {
"RequestItems": ...,
}
Definition
class BatchWriteItemInputRequestTypeDef(TypedDict):
RequestItems: Mapping[str, Sequence[WriteRequestTypeDef]], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (3)
BatchWriteItemOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BatchWriteItemOutputTypeDef
def get_value() -> BatchWriteItemOutputTypeDef:
return {
"UnprocessedItems": ...,
"ItemCollectionMetrics": ...,
"ConsumedCapacity": ...,
"ResponseMetadata": ...,
}
Definition
class BatchWriteItemOutputTypeDef(TypedDict):
UnprocessedItems: Dict[str, List[WriteRequestTypeDef]], # (1)
ItemCollectionMetrics: Dict[str, List[ItemCollectionMetricsTypeDef]], # (2)
ConsumedCapacity: List[ConsumedCapacityTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See WriteRequestTypeDef
- See ItemCollectionMetricsTypeDef
- See ConsumedCapacityTypeDef
- See ResponseMetadataTypeDef
TransactWriteItemsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TransactWriteItemsInputRequestTypeDef
def get_value() -> TransactWriteItemsInputRequestTypeDef:
return {
"TransactItems": ...,
}
Definition
class TransactWriteItemsInputRequestTypeDef(TypedDict):
TransactItems: Sequence[TransactWriteItemTypeDef], # (1)
ReturnConsumedCapacity: NotRequired[ReturnConsumedCapacityType], # (2)
ReturnItemCollectionMetrics: NotRequired[ReturnItemCollectionMetricsType], # (3)
ClientRequestToken: NotRequired[str],
ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef(TypedDict):
IndexName: NotRequired[str],
IndexStatus: NotRequired[IndexStatusType], # (1)
ProvisionedReadCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
ProvisionedWriteCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
- See IndexStatusType
- See AutoScalingSettingsDescriptionTypeDef
- See AutoScalingSettingsDescriptionTypeDef
ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef(TypedDict):
IndexName: str,
IndexStatus: NotRequired[IndexStatusType], # (1)
ProvisionedReadCapacityUnits: NotRequired[int],
ProvisionedReadCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
ProvisionedWriteCapacityUnits: NotRequired[int],
ProvisionedWriteCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
- See IndexStatusType
- See AutoScalingSettingsDescriptionTypeDef
- See AutoScalingSettingsDescriptionTypeDef
GlobalSecondaryIndexAutoScalingUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalSecondaryIndexAutoScalingUpdateTypeDef
def get_value() -> GlobalSecondaryIndexAutoScalingUpdateTypeDef:
return {
"IndexName": ...,
}
Definition
class GlobalSecondaryIndexAutoScalingUpdateTypeDef(TypedDict):
IndexName: NotRequired[str],
ProvisionedWriteCapacityAutoScalingUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (1)
GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
def get_value() -> GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef:
return {
"IndexName": ...,
}
Definition
class GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef(TypedDict):
IndexName: str,
ProvisionedWriteCapacityUnits: NotRequired[int],
ProvisionedWriteCapacityAutoScalingSettingsUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (1)
ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef(TypedDict):
IndexName: NotRequired[str],
ProvisionedReadCapacityAutoScalingUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (1)
ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef
def get_value() -> ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef:
return {
"IndexName": ...,
}
Definition
class ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef(TypedDict):
IndexName: str,
ProvisionedReadCapacityUnits: NotRequired[int],
ProvisionedReadCapacityAutoScalingSettingsUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (1)
BackupDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import BackupDescriptionTypeDef
def get_value() -> BackupDescriptionTypeDef:
return {
"BackupDetails": ...,
}
Definition
class BackupDescriptionTypeDef(TypedDict):
BackupDetails: NotRequired[BackupDetailsTypeDef], # (1)
SourceTableDetails: NotRequired[SourceTableDetailsTypeDef], # (2)
SourceTableFeatureDetails: NotRequired[SourceTableFeatureDetailsTypeDef], # (3)
ImportTableDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ImportTableDescriptionTypeDef
def get_value() -> ImportTableDescriptionTypeDef:
return {
"ImportArn": ...,
}
Definition
class ImportTableDescriptionTypeDef(TypedDict):
ImportArn: NotRequired[str],
ImportStatus: NotRequired[ImportStatusType], # (1)
TableArn: NotRequired[str],
TableId: NotRequired[str],
ClientToken: NotRequired[str],
S3BucketSource: NotRequired[S3BucketSourceTypeDef], # (2)
ErrorCount: NotRequired[int],
CloudWatchLogGroupArn: NotRequired[str],
InputFormat: NotRequired[InputFormatType], # (3)
InputFormatOptions: NotRequired[InputFormatOptionsTypeDef], # (4)
InputCompressionType: NotRequired[InputCompressionTypeType], # (5)
TableCreationParameters: NotRequired[TableCreationParametersTypeDef], # (6)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
ProcessedSizeBytes: NotRequired[int],
ProcessedItemCount: NotRequired[int],
ImportedItemCount: NotRequired[int],
FailureCode: NotRequired[str],
FailureMessage: NotRequired[str],
- See ImportStatusType
- See S3BucketSourceTypeDef
- See InputFormatType
- See InputFormatOptionsTypeDef
- See InputCompressionTypeType
- See TableCreationParametersTypeDef
ImportTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ImportTableInputRequestTypeDef
def get_value() -> ImportTableInputRequestTypeDef:
return {
"S3BucketSource": ...,
"InputFormat": ...,
"TableCreationParameters": ...,
}
Definition
class ImportTableInputRequestTypeDef(TypedDict):
S3BucketSource: S3BucketSourceTypeDef, # (1)
InputFormat: InputFormatType, # (2)
TableCreationParameters: TableCreationParametersTypeDef, # (3)
ClientToken: NotRequired[str],
InputFormatOptions: NotRequired[InputFormatOptionsTypeDef], # (4)
InputCompressionType: NotRequired[InputCompressionTypeType], # (5)
- See S3BucketSourceTypeDef
- See InputFormatType
- See TableCreationParametersTypeDef
- See InputFormatOptionsTypeDef
- See InputCompressionTypeType
TableDescriptionTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableDescriptionTableTypeDef
def get_value() -> TableDescriptionTableTypeDef:
return {
"AttributeDefinitions": ...,
}
Definition
class TableDescriptionTableTypeDef(TypedDict):
AttributeDefinitions: NotRequired[List[AttributeDefinitionTableTypeDef]], # (1)
TableName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTableTypeDef]], # (2)
TableStatus: NotRequired[TableStatusType], # (3)
CreationDateTime: NotRequired[datetime],
ProvisionedThroughput: NotRequired[ProvisionedThroughputDescriptionTableTypeDef], # (4)
TableSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
TableArn: NotRequired[str],
TableId: NotRequired[str],
BillingModeSummary: NotRequired[BillingModeSummaryTableTypeDef], # (5)
LocalSecondaryIndexes: NotRequired[List[LocalSecondaryIndexDescriptionTableTypeDef]], # (6)
GlobalSecondaryIndexes: NotRequired[List[GlobalSecondaryIndexDescriptionTableTypeDef]], # (7)
StreamSpecification: NotRequired[StreamSpecificationTableTypeDef], # (8)
LatestStreamLabel: NotRequired[str],
LatestStreamArn: NotRequired[str],
GlobalTableVersion: NotRequired[str],
Replicas: NotRequired[List[ReplicaDescriptionTableTypeDef]], # (9)
RestoreSummary: NotRequired[RestoreSummaryTableTypeDef], # (10)
SSEDescription: NotRequired[SSEDescriptionTableTypeDef], # (11)
ArchivalSummary: NotRequired[ArchivalSummaryTableTypeDef], # (12)
TableClassSummary: NotRequired[TableClassSummaryTableTypeDef], # (13)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionTableTypeDef
- See KeySchemaElementTableTypeDef
- See TableStatusType
- See ProvisionedThroughputDescriptionTableTypeDef
- See BillingModeSummaryTableTypeDef
- See LocalSecondaryIndexDescriptionTableTypeDef
- See GlobalSecondaryIndexDescriptionTableTypeDef
- See StreamSpecificationTableTypeDef
- See ReplicaDescriptionTableTypeDef
- See RestoreSummaryTableTypeDef
- See SSEDescriptionTableTypeDef
- See ArchivalSummaryTableTypeDef
- See TableClassSummaryTableTypeDef
ReplicationGroupUpdateTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicationGroupUpdateTableTypeDef
def get_value() -> ReplicationGroupUpdateTableTypeDef:
return {
"Create": ...,
}
Definition
class ReplicationGroupUpdateTableTypeDef(TypedDict):
Create: NotRequired[CreateReplicationGroupMemberActionTableTypeDef], # (1)
Update: NotRequired[UpdateReplicationGroupMemberActionTableTypeDef], # (2)
Delete: NotRequired[DeleteReplicationGroupMemberActionTableTypeDef], # (3)
- See CreateReplicationGroupMemberActionTableTypeDef
- See UpdateReplicationGroupMemberActionTableTypeDef
- See DeleteReplicationGroupMemberActionTableTypeDef
GlobalTableDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import GlobalTableDescriptionTypeDef
def get_value() -> GlobalTableDescriptionTypeDef:
return {
"ReplicationGroup": ...,
}
Definition
class GlobalTableDescriptionTypeDef(TypedDict):
ReplicationGroup: NotRequired[List[ReplicaDescriptionTypeDef]], # (1)
GlobalTableArn: NotRequired[str],
CreationDateTime: NotRequired[datetime],
GlobalTableStatus: NotRequired[GlobalTableStatusType], # (2)
GlobalTableName: NotRequired[str],
TableDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableDescriptionTypeDef
def get_value() -> TableDescriptionTypeDef:
return {
"AttributeDefinitions": ...,
}
Definition
class TableDescriptionTypeDef(TypedDict):
AttributeDefinitions: NotRequired[List[AttributeDefinitionTypeDef]], # (1)
TableName: NotRequired[str],
KeySchema: NotRequired[List[KeySchemaElementTypeDef]], # (2)
TableStatus: NotRequired[TableStatusType], # (3)
CreationDateTime: NotRequired[datetime],
ProvisionedThroughput: NotRequired[ProvisionedThroughputDescriptionTypeDef], # (4)
TableSizeBytes: NotRequired[int],
ItemCount: NotRequired[int],
TableArn: NotRequired[str],
TableId: NotRequired[str],
BillingModeSummary: NotRequired[BillingModeSummaryTypeDef], # (5)
LocalSecondaryIndexes: NotRequired[List[LocalSecondaryIndexDescriptionTypeDef]], # (6)
GlobalSecondaryIndexes: NotRequired[List[GlobalSecondaryIndexDescriptionTypeDef]], # (7)
StreamSpecification: NotRequired[StreamSpecificationTypeDef], # (8)
LatestStreamLabel: NotRequired[str],
LatestStreamArn: NotRequired[str],
GlobalTableVersion: NotRequired[str],
Replicas: NotRequired[List[ReplicaDescriptionTypeDef]], # (9)
RestoreSummary: NotRequired[RestoreSummaryTypeDef], # (10)
SSEDescription: NotRequired[SSEDescriptionTypeDef], # (11)
ArchivalSummary: NotRequired[ArchivalSummaryTypeDef], # (12)
TableClassSummary: NotRequired[TableClassSummaryTypeDef], # (13)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionTypeDef
- See KeySchemaElementTypeDef
- See TableStatusType
- See ProvisionedThroughputDescriptionTypeDef
- See BillingModeSummaryTypeDef
- See LocalSecondaryIndexDescriptionTypeDef
- See GlobalSecondaryIndexDescriptionTypeDef
- See StreamSpecificationTypeDef
- See ReplicaDescriptionTypeDef
- See RestoreSummaryTypeDef
- See SSEDescriptionTypeDef
- See ArchivalSummaryTypeDef
- See TableClassSummaryTypeDef
ReplicationGroupUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicationGroupUpdateTypeDef
def get_value() -> ReplicationGroupUpdateTypeDef:
return {
"Create": ...,
}
Definition
class ReplicationGroupUpdateTypeDef(TypedDict):
Create: NotRequired[CreateReplicationGroupMemberActionTypeDef], # (1)
Update: NotRequired[UpdateReplicationGroupMemberActionTypeDef], # (2)
Delete: NotRequired[DeleteReplicationGroupMemberActionTypeDef], # (3)
- See CreateReplicationGroupMemberActionTypeDef
- See UpdateReplicationGroupMemberActionTypeDef
- See DeleteReplicationGroupMemberActionTypeDef
ReplicaAutoScalingDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaAutoScalingDescriptionTypeDef
def get_value() -> ReplicaAutoScalingDescriptionTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaAutoScalingDescriptionTypeDef(TypedDict):
RegionName: NotRequired[str],
GlobalSecondaryIndexes: NotRequired[List[ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef]], # (1)
ReplicaProvisionedReadCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
ReplicaProvisionedWriteCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (2)
ReplicaStatus: NotRequired[ReplicaStatusType], # (4)
- See ReplicaGlobalSecondaryIndexAutoScalingDescriptionTypeDef
- See AutoScalingSettingsDescriptionTypeDef
- See AutoScalingSettingsDescriptionTypeDef
- See ReplicaStatusType
ReplicaSettingsDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaSettingsDescriptionTypeDef
def get_value() -> ReplicaSettingsDescriptionTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaSettingsDescriptionTypeDef(TypedDict):
RegionName: str,
ReplicaStatus: NotRequired[ReplicaStatusType], # (1)
ReplicaBillingModeSummary: NotRequired[BillingModeSummaryTypeDef], # (2)
ReplicaProvisionedReadCapacityUnits: NotRequired[int],
ReplicaProvisionedReadCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (3)
ReplicaProvisionedWriteCapacityUnits: NotRequired[int],
ReplicaProvisionedWriteCapacityAutoScalingSettings: NotRequired[AutoScalingSettingsDescriptionTypeDef], # (3)
ReplicaGlobalSecondaryIndexSettings: NotRequired[List[ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef]], # (5)
ReplicaTableClassSummary: NotRequired[TableClassSummaryTypeDef], # (6)
- See ReplicaStatusType
- See BillingModeSummaryTypeDef
- See AutoScalingSettingsDescriptionTypeDef
- See AutoScalingSettingsDescriptionTypeDef
- See ReplicaGlobalSecondaryIndexSettingsDescriptionTypeDef
- See TableClassSummaryTypeDef
ReplicaAutoScalingUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaAutoScalingUpdateTypeDef
def get_value() -> ReplicaAutoScalingUpdateTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaAutoScalingUpdateTypeDef(TypedDict):
RegionName: str,
ReplicaGlobalSecondaryIndexUpdates: NotRequired[Sequence[ReplicaGlobalSecondaryIndexAutoScalingUpdateTypeDef]], # (1)
ReplicaProvisionedReadCapacityAutoScalingUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (2)
ReplicaSettingsUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ReplicaSettingsUpdateTypeDef
def get_value() -> ReplicaSettingsUpdateTypeDef:
return {
"RegionName": ...,
}
Definition
class ReplicaSettingsUpdateTypeDef(TypedDict):
RegionName: str,
ReplicaProvisionedReadCapacityUnits: NotRequired[int],
ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (1)
ReplicaGlobalSecondaryIndexSettingsUpdate: NotRequired[Sequence[ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef]], # (2)
ReplicaTableClass: NotRequired[TableClassType], # (3)
- See AutoScalingSettingsUpdateTypeDef
- See ReplicaGlobalSecondaryIndexSettingsUpdateTypeDef
- See TableClassType
DeleteBackupOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteBackupOutputTypeDef
def get_value() -> DeleteBackupOutputTypeDef:
return {
"BackupDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteBackupOutputTypeDef(TypedDict):
BackupDescription: BackupDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeBackupOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeBackupOutputTypeDef
def get_value() -> DescribeBackupOutputTypeDef:
return {
"BackupDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeBackupOutputTypeDef(TypedDict):
BackupDescription: BackupDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeImportOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeImportOutputTypeDef
def get_value() -> DescribeImportOutputTypeDef:
return {
"ImportTableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeImportOutputTypeDef(TypedDict):
ImportTableDescription: ImportTableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImportTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import ImportTableOutputTypeDef
def get_value() -> ImportTableOutputTypeDef:
return {
"ImportTableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class ImportTableOutputTypeDef(TypedDict):
ImportTableDescription: ImportTableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteTableOutputTableTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteTableOutputTableTypeDef
def get_value() -> DeleteTableOutputTableTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteTableOutputTableTypeDef(TypedDict):
TableDescription: TableDescriptionTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTableInputTableUpdateTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTableInputTableUpdateTypeDef
def get_value() -> UpdateTableInputTableUpdateTypeDef:
return {
"AttributeDefinitions": ...,
}
Definition
class UpdateTableInputTableUpdateTypeDef(TypedDict):
AttributeDefinitions: NotRequired[Sequence[AttributeDefinitionTableTypeDef]], # (1)
BillingMode: NotRequired[BillingModeType], # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTableTypeDef], # (3)
GlobalSecondaryIndexUpdates: NotRequired[Sequence[GlobalSecondaryIndexUpdateTableTypeDef]], # (4)
StreamSpecification: NotRequired[StreamSpecificationTableTypeDef], # (5)
SSESpecification: NotRequired[SSESpecificationTableTypeDef], # (6)
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTableTypeDef]], # (7)
TableClass: NotRequired[TableClassType], # (8)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionTableTypeDef
- See BillingModeType
- See ProvisionedThroughputTableTypeDef
- See GlobalSecondaryIndexUpdateTableTypeDef
- See StreamSpecificationTableTypeDef
- See SSESpecificationTableTypeDef
- See ReplicationGroupUpdateTableTypeDef
- See TableClassType
CreateGlobalTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateGlobalTableOutputTypeDef
def get_value() -> CreateGlobalTableOutputTypeDef:
return {
"GlobalTableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class CreateGlobalTableOutputTypeDef(TypedDict):
GlobalTableDescription: GlobalTableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeGlobalTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableOutputTypeDef
def get_value() -> DescribeGlobalTableOutputTypeDef:
return {
"GlobalTableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeGlobalTableOutputTypeDef(TypedDict):
GlobalTableDescription: GlobalTableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateGlobalTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalTableOutputTypeDef
def get_value() -> UpdateGlobalTableOutputTypeDef:
return {
"GlobalTableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateGlobalTableOutputTypeDef(TypedDict):
GlobalTableDescription: GlobalTableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import CreateTableOutputTypeDef
def get_value() -> CreateTableOutputTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class CreateTableOutputTypeDef(TypedDict):
TableDescription: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteTableOutputTypeDef
def get_value() -> DeleteTableOutputTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteTableOutputTypeDef(TypedDict):
TableDescription: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableOutputTypeDef
def get_value() -> DescribeTableOutputTypeDef:
return {
"Table": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTableOutputTypeDef(TypedDict):
Table: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreTableFromBackupOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreTableFromBackupOutputTypeDef
def get_value() -> RestoreTableFromBackupOutputTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class RestoreTableFromBackupOutputTypeDef(TypedDict):
TableDescription: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreTableToPointInTimeOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import RestoreTableToPointInTimeOutputTypeDef
def get_value() -> RestoreTableToPointInTimeOutputTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class RestoreTableToPointInTimeOutputTypeDef(TypedDict):
TableDescription: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTableOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTableOutputTypeDef
def get_value() -> UpdateTableOutputTypeDef:
return {
"TableDescription": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTableOutputTypeDef(TypedDict):
TableDescription: TableDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTableInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTableInputRequestTypeDef
def get_value() -> UpdateTableInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class UpdateTableInputRequestTypeDef(TypedDict):
TableName: str,
AttributeDefinitions: NotRequired[Sequence[AttributeDefinitionTypeDef]], # (1)
BillingMode: NotRequired[BillingModeType], # (2)
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (3)
GlobalSecondaryIndexUpdates: NotRequired[Sequence[GlobalSecondaryIndexUpdateTypeDef]], # (4)
StreamSpecification: NotRequired[StreamSpecificationTypeDef], # (5)
SSESpecification: NotRequired[SSESpecificationTypeDef], # (6)
ReplicaUpdates: NotRequired[Sequence[ReplicationGroupUpdateTypeDef]], # (7)
TableClass: NotRequired[TableClassType], # (8)
DeletionProtectionEnabled: NotRequired[bool],
- See AttributeDefinitionTypeDef
- See BillingModeType
- See ProvisionedThroughputTypeDef
- See GlobalSecondaryIndexUpdateTypeDef
- See StreamSpecificationTypeDef
- See SSESpecificationTypeDef
- See ReplicationGroupUpdateTypeDef
- See TableClassType
TableAutoScalingDescriptionTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import TableAutoScalingDescriptionTypeDef
def get_value() -> TableAutoScalingDescriptionTypeDef:
return {
"TableName": ...,
}
Definition
class TableAutoScalingDescriptionTypeDef(TypedDict):
TableName: NotRequired[str],
TableStatus: NotRequired[TableStatusType], # (1)
Replicas: NotRequired[List[ReplicaAutoScalingDescriptionTypeDef]], # (2)
DescribeGlobalTableSettingsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableSettingsOutputTypeDef
def get_value() -> DescribeGlobalTableSettingsOutputTypeDef:
return {
"GlobalTableName": ...,
"ReplicaSettings": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeGlobalTableSettingsOutputTypeDef(TypedDict):
GlobalTableName: str,
ReplicaSettings: List[ReplicaSettingsDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateGlobalTableSettingsOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalTableSettingsOutputTypeDef
def get_value() -> UpdateGlobalTableSettingsOutputTypeDef:
return {
"GlobalTableName": ...,
"ReplicaSettings": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateGlobalTableSettingsOutputTypeDef(TypedDict):
GlobalTableName: str,
ReplicaSettings: List[ReplicaSettingsDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTableReplicaAutoScalingInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTableReplicaAutoScalingInputRequestTypeDef
def get_value() -> UpdateTableReplicaAutoScalingInputRequestTypeDef:
return {
"TableName": ...,
}
Definition
class UpdateTableReplicaAutoScalingInputRequestTypeDef(TypedDict):
TableName: str,
GlobalSecondaryIndexUpdates: NotRequired[Sequence[GlobalSecondaryIndexAutoScalingUpdateTypeDef]], # (1)
ProvisionedWriteCapacityAutoScalingUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (2)
ReplicaUpdates: NotRequired[Sequence[ReplicaAutoScalingUpdateTypeDef]], # (3)
- See GlobalSecondaryIndexAutoScalingUpdateTypeDef
- See AutoScalingSettingsUpdateTypeDef
- See ReplicaAutoScalingUpdateTypeDef
UpdateGlobalTableSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateGlobalTableSettingsInputRequestTypeDef
def get_value() -> UpdateGlobalTableSettingsInputRequestTypeDef:
return {
"GlobalTableName": ...,
}
Definition
class UpdateGlobalTableSettingsInputRequestTypeDef(TypedDict):
GlobalTableName: str,
GlobalTableBillingMode: NotRequired[BillingModeType], # (1)
GlobalTableProvisionedWriteCapacityUnits: NotRequired[int],
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: NotRequired[AutoScalingSettingsUpdateTypeDef], # (2)
GlobalTableGlobalSecondaryIndexSettingsUpdate: NotRequired[Sequence[GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef]], # (3)
ReplicaSettingsUpdate: NotRequired[Sequence[ReplicaSettingsUpdateTypeDef]], # (4)
- See BillingModeType
- See AutoScalingSettingsUpdateTypeDef
- See GlobalTableGlobalSecondaryIndexSettingsUpdateTypeDef
- See ReplicaSettingsUpdateTypeDef
DescribeTableReplicaAutoScalingOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableReplicaAutoScalingOutputTypeDef
def get_value() -> DescribeTableReplicaAutoScalingOutputTypeDef:
return {
"TableAutoScalingDescription": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeTableReplicaAutoScalingOutputTypeDef(TypedDict):
TableAutoScalingDescription: TableAutoScalingDescriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTableReplicaAutoScalingOutputTypeDef
Usage Example
from mypy_boto3_dynamodb.type_defs import UpdateTableReplicaAutoScalingOutputTypeDef
def get_value() -> UpdateTableReplicaAutoScalingOutputTypeDef:
return {
"TableAutoScalingDescription": ...,
"ResponseMetadata": ...,
}