Skip to content

Type definitions#

Index > BackupStorage > Type definitions

Auto-generated documentation for BackupStorage type annotations stubs module mypy-boto3-backupstorage.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BackupObjectTypeDef#

# BackupObjectTypeDef definition

class BackupObjectTypeDef(TypedDict):
    Name: str,
    ObjectChecksum: str,
    ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType,  # (1)
    ObjectToken: str,
    ChunksCount: NotRequired[int],
    MetadataString: NotRequired[str],
  1. See SummaryChecksumAlgorithmType

ChunkTypeDef#

# ChunkTypeDef definition

class ChunkTypeDef(TypedDict):
    Index: int,
    Length: int,
    Checksum: str,
    ChecksumAlgorithm: DataChecksumAlgorithmType,  # (1)
    ChunkToken: str,
  1. See DataChecksumAlgorithmType

DeleteObjectInputRequestTypeDef#

# DeleteObjectInputRequestTypeDef definition

class DeleteObjectInputRequestTypeDef(TypedDict):
    BackupJobId: str,
    ObjectName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

GetChunkInputRequestTypeDef#

# GetChunkInputRequestTypeDef definition

class GetChunkInputRequestTypeDef(TypedDict):
    StorageJobId: str,
    ChunkToken: str,

GetObjectMetadataInputRequestTypeDef#

# GetObjectMetadataInputRequestTypeDef definition

class GetObjectMetadataInputRequestTypeDef(TypedDict):
    StorageJobId: str,
    ObjectToken: str,

ListChunksInputRequestTypeDef#

# ListChunksInputRequestTypeDef definition

class ListChunksInputRequestTypeDef(TypedDict):
    StorageJobId: str,
    ObjectToken: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

StartObjectInputRequestTypeDef#

# StartObjectInputRequestTypeDef definition

class StartObjectInputRequestTypeDef(TypedDict):
    BackupJobId: str,
    ObjectName: str,
    ThrowOnDuplicate: NotRequired[bool],

NotifyObjectCompleteInputRequestTypeDef#

# 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)
  1. See SummaryChecksumAlgorithmType
  2. See DataChecksumAlgorithmType

PutChunkInputRequestTypeDef#

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

PutObjectInputRequestTypeDef#

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetChunkOutputTypeDef#

# GetChunkOutputTypeDef definition

class GetChunkOutputTypeDef(TypedDict):
    Data: StreamingBody,
    Length: int,
    Checksum: str,
    ChecksumAlgorithm: DataChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

GetObjectMetadataOutputTypeDef#

# GetObjectMetadataOutputTypeDef definition

class GetObjectMetadataOutputTypeDef(TypedDict):
    MetadataString: str,
    MetadataBlob: StreamingBody,
    MetadataBlobLength: int,
    MetadataBlobChecksum: str,
    MetadataBlobChecksumAlgorithm: DataChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

ListChunksOutputTypeDef#

# ListChunksOutputTypeDef definition

class ListChunksOutputTypeDef(TypedDict):
    ChunkList: List[ChunkTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChunkTypeDef
  2. See ResponseMetadataTypeDef

ListObjectsOutputTypeDef#

# ListObjectsOutputTypeDef definition

class ListObjectsOutputTypeDef(TypedDict):
    ObjectList: List[BackupObjectTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupObjectTypeDef
  2. See ResponseMetadataTypeDef

NotifyObjectCompleteOutputTypeDef#

# NotifyObjectCompleteOutputTypeDef definition

class NotifyObjectCompleteOutputTypeDef(TypedDict):
    ObjectChecksum: str,
    ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SummaryChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

PutChunkOutputTypeDef#

# PutChunkOutputTypeDef definition

class PutChunkOutputTypeDef(TypedDict):
    ChunkChecksum: str,
    ChunkChecksumAlgorithm: DataChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

PutObjectOutputTypeDef#

# PutObjectOutputTypeDef definition

class PutObjectOutputTypeDef(TypedDict):
    InlineChunkChecksum: str,
    InlineChunkChecksumAlgorithm: DataChecksumAlgorithmType,  # (1)
    ObjectChecksum: str,
    ObjectChecksumAlgorithm: SummaryChecksumAlgorithmType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DataChecksumAlgorithmType
  2. See SummaryChecksumAlgorithmType
  3. See ResponseMetadataTypeDef

StartObjectOutputTypeDef#

# StartObjectOutputTypeDef definition

class StartObjectOutputTypeDef(TypedDict):
    UploadId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListObjectsInputRequestTypeDef#

# 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]],