Typed dictionaries#
Index > BackupStorage > Typed dictionaries
Auto-generated documentation for BackupStorage type annotations stubs module mypy-boto3-backupstorage.
BackupObjectTypeDef#
# BackupObjectTypeDef usage example
from mypy_boto3_backupstorage.type_defs import BackupObjectTypeDef
def get_value() -> BackupObjectTypeDef:
return {
"Name": ...,
"ObjectChecksum": ...,
"ObjectChecksumAlgorithm": ...,
"ObjectToken": ...,
}
# BackupObjectTypeDef definition
class BackupObjectTypeDef(TypedDict):
Name: str,
ObjectChecksum: str,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType, # (1)
ObjectToken: str,
ChunksCount: NotRequired[int],
MetadataString: NotRequired[str],
ChunkTypeDef#
# ChunkTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ChunkTypeDef
def get_value() -> ChunkTypeDef:
return {
"Index": ...,
"Length": ...,
"Checksum": ...,
"ChecksumAlgorithm": ...,
"ChunkToken": ...,
}
# ChunkTypeDef definition
class ChunkTypeDef(TypedDict):
Index: int,
Length: int,
Checksum: str,
ChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
ChunkToken: str,
DeleteObjectInputRequestTypeDef#
# DeleteObjectInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import DeleteObjectInputRequestTypeDef
def get_value() -> DeleteObjectInputRequestTypeDef:
return {
"BackupJobId": ...,
"ObjectName": ...,
}
# DeleteObjectInputRequestTypeDef definition
class DeleteObjectInputRequestTypeDef(TypedDict):
BackupJobId: str,
ObjectName: str,
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_backupstorage.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetChunkInputRequestTypeDef#
# GetChunkInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import GetChunkInputRequestTypeDef
def get_value() -> GetChunkInputRequestTypeDef:
return {
"StorageJobId": ...,
"ChunkToken": ...,
}
# GetChunkInputRequestTypeDef definition
class GetChunkInputRequestTypeDef(TypedDict):
StorageJobId: str,
ChunkToken: str,
GetChunkOutputTypeDef#
# GetChunkOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import GetChunkOutputTypeDef
def get_value() -> GetChunkOutputTypeDef:
return {
"Data": ...,
"Length": ...,
"Checksum": ...,
"ChecksumAlgorithm": ...,
"ResponseMetadata": ...,
}
# GetChunkOutputTypeDef definition
class GetChunkOutputTypeDef(TypedDict):
Data: StreamingBody,
Length: int,
Checksum: str,
ChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetObjectMetadataInputRequestTypeDef#
# GetObjectMetadataInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import GetObjectMetadataInputRequestTypeDef
def get_value() -> GetObjectMetadataInputRequestTypeDef:
return {
"StorageJobId": ...,
"ObjectToken": ...,
}
# GetObjectMetadataInputRequestTypeDef definition
class GetObjectMetadataInputRequestTypeDef(TypedDict):
StorageJobId: str,
ObjectToken: str,
GetObjectMetadataOutputTypeDef#
# GetObjectMetadataOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import GetObjectMetadataOutputTypeDef
def get_value() -> GetObjectMetadataOutputTypeDef:
return {
"MetadataString": ...,
"MetadataBlob": ...,
"MetadataBlobLength": ...,
"MetadataBlobChecksum": ...,
"MetadataBlobChecksumAlgorithm": ...,
"ResponseMetadata": ...,
}
# GetObjectMetadataOutputTypeDef definition
class GetObjectMetadataOutputTypeDef(TypedDict):
MetadataString: str,
MetadataBlob: StreamingBody,
MetadataBlobLength: int,
MetadataBlobChecksum: str,
MetadataBlobChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChunksInputRequestTypeDef#
# ListChunksInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ListChunksInputRequestTypeDef
def get_value() -> ListChunksInputRequestTypeDef:
return {
"StorageJobId": ...,
"ObjectToken": ...,
}
# ListChunksInputRequestTypeDef definition
class ListChunksInputRequestTypeDef(TypedDict):
StorageJobId: str,
ObjectToken: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListObjectsInputRequestTypeDef#
# ListObjectsInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ListObjectsInputRequestTypeDef
def get_value() -> ListObjectsInputRequestTypeDef:
return {
"StorageJobId": ...,
}
# ListObjectsInputRequestTypeDef definition
class ListObjectsInputRequestTypeDef(TypedDict):
StorageJobId: str,
StartingObjectName: NotRequired[str],
StartingObjectPrefix: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
CreatedBefore: NotRequired[Union[datetime, str]],
CreatedAfter: NotRequired[Union[datetime, str]],
NotifyObjectCompleteInputRequestTypeDef#
# NotifyObjectCompleteInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import NotifyObjectCompleteInputRequestTypeDef
def get_value() -> NotifyObjectCompleteInputRequestTypeDef:
return {
"BackupJobId": ...,
"UploadId": ...,
"ObjectChecksum": ...,
"ObjectChecksumAlgorithm": ...,
}
# NotifyObjectCompleteInputRequestTypeDef definition
class NotifyObjectCompleteInputRequestTypeDef(TypedDict):
BackupJobId: str,
UploadId: str,
ObjectChecksum: str,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType, # (1)
MetadataString: NotRequired[str],
MetadataBlob: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
MetadataBlobLength: NotRequired[int],
MetadataBlobChecksum: NotRequired[str],
MetadataBlobChecksumAlgorithm: NotRequired[DataChecksumAlgorithmType], # (2)
NotifyObjectCompleteOutputTypeDef#
# NotifyObjectCompleteOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import NotifyObjectCompleteOutputTypeDef
def get_value() -> NotifyObjectCompleteOutputTypeDef:
return {
"ObjectChecksum": ...,
"ObjectChecksumAlgorithm": ...,
"ResponseMetadata": ...,
}
# NotifyObjectCompleteOutputTypeDef definition
class NotifyObjectCompleteOutputTypeDef(TypedDict):
ObjectChecksum: str,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutChunkInputRequestTypeDef#
# PutChunkInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import PutChunkInputRequestTypeDef
def get_value() -> PutChunkInputRequestTypeDef:
return {
"BackupJobId": ...,
"UploadId": ...,
"ChunkIndex": ...,
"Data": ...,
"Length": ...,
"Checksum": ...,
"ChecksumAlgorithm": ...,
}
# PutChunkInputRequestTypeDef definition
class PutChunkInputRequestTypeDef(TypedDict):
BackupJobId: str,
UploadId: str,
ChunkIndex: int,
Data: Union[str, bytes, IO[Any], StreamingBody],
Length: int,
Checksum: str,
ChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
PutChunkOutputTypeDef#
# PutChunkOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import PutChunkOutputTypeDef
def get_value() -> PutChunkOutputTypeDef:
return {
"ChunkChecksum": ...,
"ChunkChecksumAlgorithm": ...,
"ResponseMetadata": ...,
}
# PutChunkOutputTypeDef definition
class PutChunkOutputTypeDef(TypedDict):
ChunkChecksum: str,
ChunkChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutObjectInputRequestTypeDef#
# PutObjectInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import PutObjectInputRequestTypeDef
def get_value() -> PutObjectInputRequestTypeDef:
return {
"BackupJobId": ...,
"ObjectName": ...,
}
# PutObjectInputRequestTypeDef definition
class PutObjectInputRequestTypeDef(TypedDict):
BackupJobId: str,
ObjectName: str,
MetadataString: NotRequired[str],
InlineChunk: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
InlineChunkLength: NotRequired[int],
InlineChunkChecksum: NotRequired[str],
InlineChunkChecksumAlgorithm: NotRequired[str],
ObjectChecksum: NotRequired[str],
ObjectChecksumAlgorithm: NotRequired[SummaryChecksumAlgorithmType], # (1)
ThrowOnDuplicate: NotRequired[bool],
PutObjectOutputTypeDef#
# PutObjectOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import PutObjectOutputTypeDef
def get_value() -> PutObjectOutputTypeDef:
return {
"InlineChunkChecksum": ...,
"InlineChunkChecksumAlgorithm": ...,
"ObjectChecksum": ...,
"ObjectChecksumAlgorithm": ...,
"ResponseMetadata": ...,
}
# PutObjectOutputTypeDef definition
class PutObjectOutputTypeDef(TypedDict):
InlineChunkChecksum: str,
InlineChunkChecksumAlgorithm: DataChecksumAlgorithmType, # (1)
ObjectChecksum: str,
ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
StartObjectInputRequestTypeDef#
# StartObjectInputRequestTypeDef usage example
from mypy_boto3_backupstorage.type_defs import StartObjectInputRequestTypeDef
def get_value() -> StartObjectInputRequestTypeDef:
return {
"BackupJobId": ...,
"ObjectName": ...,
}
# StartObjectInputRequestTypeDef definition
class StartObjectInputRequestTypeDef(TypedDict):
BackupJobId: str,
ObjectName: str,
ThrowOnDuplicate: NotRequired[bool],
StartObjectOutputTypeDef#
# StartObjectOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import StartObjectOutputTypeDef
def get_value() -> StartObjectOutputTypeDef:
return {
"UploadId": ...,
"ResponseMetadata": ...,
}
# StartObjectOutputTypeDef definition
class StartObjectOutputTypeDef(TypedDict):
UploadId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListObjectsOutputTypeDef#
# ListObjectsOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ListObjectsOutputTypeDef
def get_value() -> ListObjectsOutputTypeDef:
return {
"ObjectList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListObjectsOutputTypeDef definition
class ListObjectsOutputTypeDef(TypedDict):
ObjectList: List[BackupObjectTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChunksOutputTypeDef#
# ListChunksOutputTypeDef usage example
from mypy_boto3_backupstorage.type_defs import ListChunksOutputTypeDef
def get_value() -> ListChunksOutputTypeDef:
return {
"ChunkList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListChunksOutputTypeDef definition
class ListChunksOutputTypeDef(TypedDict):
ChunkList: List[ChunkTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ChunkTypeDef
- See ResponseMetadataTypeDef