Skip to content

Type definitions#

Index > EBS > Type definitions

Auto-generated documentation for EBS type annotations stubs module mypy-boto3-ebs.

BlobTypeDef#

# BlobTypeDef definition

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

BlockTypeDef#

# BlockTypeDef definition

class BlockTypeDef(TypedDict):
    BlockIndex: NotRequired[int],
    BlockToken: NotRequired[str],

ChangedBlockTypeDef#

# ChangedBlockTypeDef definition

class ChangedBlockTypeDef(TypedDict):
    BlockIndex: NotRequired[int],
    FirstBlockToken: NotRequired[str],
    SecondBlockToken: NotRequired[str],

CompleteSnapshotRequestRequestTypeDef#

# CompleteSnapshotRequestRequestTypeDef definition

class CompleteSnapshotRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    ChangedBlocksCount: int,
    Checksum: NotRequired[str],
    ChecksumAlgorithm: NotRequired[ChecksumAlgorithmType],  # (1)
    ChecksumAggregationMethod: NotRequired[ChecksumAggregationMethodType],  # (2)
  1. See ChecksumAlgorithmType
  2. See ChecksumAggregationMethodType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetSnapshotBlockRequestRequestTypeDef#

# GetSnapshotBlockRequestRequestTypeDef definition

class GetSnapshotBlockRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    BlockIndex: int,
    BlockToken: str,

ListChangedBlocksRequestRequestTypeDef#

# ListChangedBlocksRequestRequestTypeDef definition

class ListChangedBlocksRequestRequestTypeDef(TypedDict):
    SecondSnapshotId: str,
    FirstSnapshotId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StartingBlockIndex: NotRequired[int],

ListSnapshotBlocksRequestRequestTypeDef#

# ListSnapshotBlocksRequestRequestTypeDef definition

class ListSnapshotBlocksRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    StartingBlockIndex: NotRequired[int],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

PutSnapshotBlockRequestRequestTypeDef#

# PutSnapshotBlockRequestRequestTypeDef definition

class PutSnapshotBlockRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    BlockIndex: int,
    BlockData: BlobTypeDef,
    DataLength: int,
    Checksum: str,
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (1)
    Progress: NotRequired[int],
  1. See ChecksumAlgorithmType

CompleteSnapshotResponseTypeDef#

# CompleteSnapshotResponseTypeDef definition

class CompleteSnapshotResponseTypeDef(TypedDict):
    Status: StatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StatusType
  2. See ResponseMetadataTypeDef

GetSnapshotBlockResponseTypeDef#

# GetSnapshotBlockResponseTypeDef definition

class GetSnapshotBlockResponseTypeDef(TypedDict):
    DataLength: int,
    BlockData: StreamingBody,
    Checksum: str,
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

ListChangedBlocksResponseTypeDef#

# ListChangedBlocksResponseTypeDef definition

class ListChangedBlocksResponseTypeDef(TypedDict):
    ChangedBlocks: list[ChangedBlockTypeDef],  # (1)
    ExpiryTime: datetime,
    VolumeSize: int,
    BlockSize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ChangedBlockTypeDef
  2. See ResponseMetadataTypeDef

ListSnapshotBlocksResponseTypeDef#

# ListSnapshotBlocksResponseTypeDef definition

class ListSnapshotBlocksResponseTypeDef(TypedDict):
    Blocks: list[BlockTypeDef],  # (1)
    ExpiryTime: datetime,
    VolumeSize: int,
    BlockSize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BlockTypeDef
  2. See ResponseMetadataTypeDef

PutSnapshotBlockResponseTypeDef#

# PutSnapshotBlockResponseTypeDef definition

class PutSnapshotBlockResponseTypeDef(TypedDict):
    Checksum: str,
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChecksumAlgorithmType
  2. See ResponseMetadataTypeDef

StartSnapshotRequestRequestTypeDef#

# StartSnapshotRequestRequestTypeDef definition

class StartSnapshotRequestRequestTypeDef(TypedDict):
    VolumeSize: int,
    ParentSnapshotId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    Description: NotRequired[str],
    ClientToken: NotRequired[str],
    Encrypted: NotRequired[bool],
    KmsKeyArn: NotRequired[str],
    Timeout: NotRequired[int],
  1. See TagTypeDef

StartSnapshotResponseTypeDef#

# StartSnapshotResponseTypeDef definition

class StartSnapshotResponseTypeDef(TypedDict):
    Description: str,
    SnapshotId: str,
    OwnerId: str,
    Status: StatusType,  # (1)
    StartTime: datetime,
    VolumeSize: int,
    BlockSize: int,
    Tags: list[TagTypeDef],  # (2)
    ParentSnapshotId: str,
    KmsKeyArn: str,
    SseType: SSETypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See StatusType
  2. See TagTypeDef
  3. See SSETypeType
  4. See ResponseMetadataTypeDef