Skip to content

Typed dictionaries

Index > DynamoDB > 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)
  1. See ScalarAttributeTypeType

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)
  1. See ScalarAttributeTypeType

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)
  1. See ScalarAttributeTypeType

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)
  1. See AttributeActionType

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],
  1. See BackupStatusType
  2. 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],
  1. See BackupStatusType
  2. 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],
  1. See BackupStatusType
  2. 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],
  1. See BatchStatementErrorCodeEnumType

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],
  1. 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],
  1. 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]]],
  1. See ComparisonOperatorType

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],
  1. See PointInTimeRecoveryStatusType

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)
  1. See ContributorInsightsStatusType

CreateBackupInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import CreateBackupInputRequestTypeDef

def get_value() -> CreateBackupInputRequestTypeDef:
    return {
        "TableName": ...,
        "BackupName": ...,
    }
Definition
class CreateBackupInputRequestTypeDef(TypedDict):
    TableName: str,
    BackupName: str,

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)
  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]],
  1. See ProjectionTypeType

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": ...,
    }
Definition
class KeySchemaElementTypeDef(TypedDict):
    AttributeName: str,
    KeyType: KeyTypeType,  # (1)
  1. 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]],
  1. See ProjectionTypeType

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": ...,
    }
Definition
class ReplicaTypeDef(TypedDict):
    RegionName: NotRequired[str],

CreateReplicaActionTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import CreateReplicaActionTypeDef

def get_value() -> CreateReplicaActionTypeDef:
    return {
        "RegionName": ...,
    }
Definition
class CreateReplicaActionTypeDef(TypedDict):
    RegionName: str,

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],
  1. 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)
  1. See StreamViewTypeType

TagTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

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)
  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],
  1. 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)
  1. See StreamViewTypeType

TagServiceResourceTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import TagServiceResourceTypeDef

def get_value() -> TagServiceResourceTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagServiceResourceTypeDef(TypedDict):
    Key: str,
    Value: str,

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": ...,
    }
Definition
class DeleteBackupInputRequestTypeDef(TypedDict):
    BackupArn: str,

DeleteGlobalSecondaryIndexActionTableTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteGlobalSecondaryIndexActionTableTypeDef

def get_value() -> DeleteGlobalSecondaryIndexActionTableTypeDef:
    return {
        "IndexName": ...,
    }
Definition
class DeleteGlobalSecondaryIndexActionTableTypeDef(TypedDict):
    IndexName: str,

DeleteGlobalSecondaryIndexActionTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteGlobalSecondaryIndexActionTypeDef

def get_value() -> DeleteGlobalSecondaryIndexActionTypeDef:
    return {
        "IndexName": ...,
    }
Definition
class DeleteGlobalSecondaryIndexActionTypeDef(TypedDict):
    IndexName: str,

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]]],
  1. See ComparisonOperatorType

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": ...,
    }
Definition
class DeleteReplicaActionTypeDef(TypedDict):
    RegionName: str,

DeleteReplicationGroupMemberActionTableTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteReplicationGroupMemberActionTableTypeDef

def get_value() -> DeleteReplicationGroupMemberActionTableTypeDef:
    return {
        "RegionName": ...,
    }
Definition
class DeleteReplicationGroupMemberActionTableTypeDef(TypedDict):
    RegionName: str,

DeleteReplicationGroupMemberActionTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DeleteReplicationGroupMemberActionTypeDef

def get_value() -> DeleteReplicationGroupMemberActionTypeDef:
    return {
        "RegionName": ...,
    }
Definition
class DeleteReplicationGroupMemberActionTypeDef(TypedDict):
    RegionName: str,

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": ...,
    }
Definition
class DeleteTableInputRequestTypeDef(TypedDict):
    TableName: str,

DescribeBackupInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeBackupInputRequestTypeDef

def get_value() -> DescribeBackupInputRequestTypeDef:
    return {
        "BackupArn": ...,
    }
Definition
class DescribeBackupInputRequestTypeDef(TypedDict):
    BackupArn: str,

DescribeContinuousBackupsInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeContinuousBackupsInputRequestTypeDef

def get_value() -> DescribeContinuousBackupsInputRequestTypeDef:
    return {
        "TableName": ...,
    }
Definition
class DescribeContinuousBackupsInputRequestTypeDef(TypedDict):
    TableName: str,

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": ...,
    }
Definition
class EndpointTypeDef(TypedDict):
    Address: str,
    CachePeriodInMinutes: int,

DescribeExportInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeExportInputRequestTypeDef

def get_value() -> DescribeExportInputRequestTypeDef:
    return {
        "ExportArn": ...,
    }
Definition
class DescribeExportInputRequestTypeDef(TypedDict):
    ExportArn: str,

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],
  1. See ExportStatusType
  2. See S3SseAlgorithmType
  3. See ExportFormatType

DescribeGlobalTableInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableInputRequestTypeDef

def get_value() -> DescribeGlobalTableInputRequestTypeDef:
    return {
        "GlobalTableName": ...,
    }
Definition
class DescribeGlobalTableInputRequestTypeDef(TypedDict):
    GlobalTableName: str,

DescribeGlobalTableSettingsInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeGlobalTableSettingsInputRequestTypeDef

def get_value() -> DescribeGlobalTableSettingsInputRequestTypeDef:
    return {
        "GlobalTableName": ...,
    }
Definition
class DescribeGlobalTableSettingsInputRequestTypeDef(TypedDict):
    GlobalTableName: str,

DescribeImportInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeImportInputRequestTypeDef

def get_value() -> DescribeImportInputRequestTypeDef:
    return {
        "ImportArn": ...,
    }
Definition
class DescribeImportInputRequestTypeDef(TypedDict):
    ImportArn: str,

DescribeKinesisStreamingDestinationInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeKinesisStreamingDestinationInputRequestTypeDef

def get_value() -> DescribeKinesisStreamingDestinationInputRequestTypeDef:
    return {
        "TableName": ...,
    }
Definition
class DescribeKinesisStreamingDestinationInputRequestTypeDef(TypedDict):
    TableName: str,

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],
  1. See DestinationStatusType

DescribeTableInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTableInputRequestTypeDef

def get_value() -> DescribeTableInputRequestTypeDef:
    return {
        "TableName": ...,
    }
Definition
class DescribeTableInputRequestTypeDef(TypedDict):
    TableName: str,

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": ...,
    }
Definition
class DescribeTableReplicaAutoScalingInputRequestTypeDef(TypedDict):
    TableName: str,

DescribeTimeToLiveInputRequestTypeDef

Usage Example
from mypy_boto3_dynamodb.type_defs import DescribeTimeToLiveInputRequestTypeDef

def get_value() -> DescribeTimeToLiveInputRequestTypeDef:
    return {
        "TableName": ...,
    }
Definition
class DescribeTimeToLiveInputRequestTypeDef(TypedDict):
    TableName: str,

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],
  1. See TimeToLiveStatusType

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)
  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)
  1. See S3SseAlgorithmType
  2. 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]],
  1. See ReturnConsumedCapacityType

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]],
  1. See ProjectionTypeType

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)
  1. See BackupTypeFilterType

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": ...,
    }
Definition
class TagTableTypeDef(TypedDict):
    Key: str,
    Value: str,

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],
  1. 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],
  1. 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 {