Typed dictionaries

Index > EBS > Typed dictionaries

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

BlockTypeDef

# BlockTypeDef usage example

from mypy_boto3_ebs.type_defs import BlockTypeDef

def get_value() -> BlockTypeDef:
    return {
        "BlockIndex": ...,
    }

# BlockTypeDef definition

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

ChangedBlockTypeDef

# ChangedBlockTypeDef usage example

from mypy_boto3_ebs.type_defs import ChangedBlockTypeDef

def get_value() -> ChangedBlockTypeDef:
    return {
        "BlockIndex": ...,
    }

# ChangedBlockTypeDef definition

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

CompleteSnapshotRequestRequestTypeDef

# CompleteSnapshotRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import CompleteSnapshotRequestRequestTypeDef

def get_value() -> CompleteSnapshotRequestRequestTypeDef:
    return {
        "SnapshotId": ...,
        "ChangedBlocksCount": ...,
    }

# 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

CompleteSnapshotResponseTypeDef

# CompleteSnapshotResponseTypeDef usage example

from mypy_boto3_ebs.type_defs import CompleteSnapshotResponseTypeDef

def get_value() -> CompleteSnapshotResponseTypeDef:
    return {
        "Status": ...,
        "ResponseMetadata": ...,
    }

# CompleteSnapshotResponseTypeDef definition

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

1. See StatusType
2. See ResponseMetadataTypeDef

GetSnapshotBlockRequestRequestTypeDef

# GetSnapshotBlockRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import GetSnapshotBlockRequestRequestTypeDef

def get_value() -> GetSnapshotBlockRequestRequestTypeDef:
    return {
        "SnapshotId": ...,
        "BlockIndex": ...,
        "BlockToken": ...,
    }

# GetSnapshotBlockRequestRequestTypeDef definition

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

GetSnapshotBlockResponseTypeDef

# GetSnapshotBlockResponseTypeDef usage example

from mypy_boto3_ebs.type_defs import GetSnapshotBlockResponseTypeDef

def get_value() -> GetSnapshotBlockResponseTypeDef:
    return {
        "DataLength": ...,
        "BlockData": ...,
        "Checksum": ...,
        "ChecksumAlgorithm": ...,
        "ResponseMetadata": ...,
    }

# GetSnapshotBlockResponseTypeDef definition

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

1. See ChecksumAlgorithmType
2. See ResponseMetadataTypeDef

ListChangedBlocksRequestRequestTypeDef

# ListChangedBlocksRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import ListChangedBlocksRequestRequestTypeDef

def get_value() -> ListChangedBlocksRequestRequestTypeDef:
    return {
        "SecondSnapshotId": ...,
    }

# ListChangedBlocksRequestRequestTypeDef definition

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

ListSnapshotBlocksRequestRequestTypeDef

# ListSnapshotBlocksRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import ListSnapshotBlocksRequestRequestTypeDef

def get_value() -> ListSnapshotBlocksRequestRequestTypeDef:
    return {
        "SnapshotId": ...,
    }

# ListSnapshotBlocksRequestRequestTypeDef definition

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

PutSnapshotBlockRequestRequestTypeDef

# PutSnapshotBlockRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import PutSnapshotBlockRequestRequestTypeDef

def get_value() -> PutSnapshotBlockRequestRequestTypeDef:
    return {
        "SnapshotId": ...,
        "BlockIndex": ...,
        "BlockData": ...,
        "DataLength": ...,
        "Checksum": ...,
        "ChecksumAlgorithm": ...,
    }

# PutSnapshotBlockRequestRequestTypeDef definition

class PutSnapshotBlockRequestRequestTypeDef(TypedDict):
    SnapshotId: str,
    BlockIndex: int,
    BlockData: Union[str, bytes, IO[Any], StreamingBody],
    DataLength: int,
    Checksum: str,
    ChecksumAlgorithm: ChecksumAlgorithmType,  # (1)
    Progress: NotRequired[int],

1. See ChecksumAlgorithmType

PutSnapshotBlockResponseTypeDef

# PutSnapshotBlockResponseTypeDef usage example

from mypy_boto3_ebs.type_defs import PutSnapshotBlockResponseTypeDef

def get_value() -> PutSnapshotBlockResponseTypeDef:
    return {
        "Checksum": ...,
        "ChecksumAlgorithm": ...,
        "ResponseMetadata": ...,
    }

# PutSnapshotBlockResponseTypeDef definition

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

1. See ChecksumAlgorithmType
2. See ResponseMetadataTypeDef

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_ebs.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,

TagTypeDef

# TagTypeDef usage example

from mypy_boto3_ebs.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }

# TagTypeDef definition

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

ListSnapshotBlocksResponseTypeDef

# ListSnapshotBlocksResponseTypeDef usage example

from mypy_boto3_ebs.type_defs import ListSnapshotBlocksResponseTypeDef

def get_value() -> ListSnapshotBlocksResponseTypeDef:
    return {
        "Blocks": ...,
        "ExpiryTime": ...,
        "VolumeSize": ...,
        "BlockSize": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListSnapshotBlocksResponseTypeDef definition

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

1. See BlockTypeDef
2. See ResponseMetadataTypeDef

ListChangedBlocksResponseTypeDef

# ListChangedBlocksResponseTypeDef usage example

from mypy_boto3_ebs.type_defs import ListChangedBlocksResponseTypeDef

def get_value() -> ListChangedBlocksResponseTypeDef:
    return {
        "ChangedBlocks": ...,
        "ExpiryTime": ...,
        "VolumeSize": ...,
        "BlockSize": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListChangedBlocksResponseTypeDef definition

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

1. See ChangedBlockTypeDef
2. See ResponseMetadataTypeDef

StartSnapshotRequestRequestTypeDef

# StartSnapshotRequestRequestTypeDef usage example

from mypy_boto3_ebs.type_defs import StartSnapshotRequestRequestTypeDef

def get_value() -> StartSnapshotRequestRequestTypeDef:
    return {
        "VolumeSize": ...,
    }

# 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 usage example

from mypy_boto3_ebs.type_defs import StartSnapshotResponseTypeDef

def get_value() -> StartSnapshotResponseTypeDef:
    return {
        "Description": ...,
        "SnapshotId": ...,
        "OwnerId": ...,
        "Status": ...,
        "StartTime": ...,
        "VolumeSize": ...,
        "BlockSize": ...,
        "Tags": ...,
        "ParentSnapshotId": ...,
        "KmsKeyArn": ...,
        "ResponseMetadata": ...,
    }

# 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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See StatusType
2. See TagTypeDef
3. See ResponseMetadataTypeDef