mypydantic.models.ebs

  1# Model Generated: Thu Mar  2 21:56:18 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Any, Dict, IO, List, Literal, Optional, Sequence, Type, Union
  7
  8from botocore.response import StreamingBody
  9from pydantic import Field
 10
 11from mypydantic.models.base_model import BaseModel
 12
 13
 14class BlockModel(BaseModel):
 15    block_index: Optional[int] = Field(default=None, alias="BlockIndex")
 16    block_token: Optional[str] = Field(default=None, alias="BlockToken")
 17
 18
 19class ChangedBlockModel(BaseModel):
 20    block_index: Optional[int] = Field(default=None, alias="BlockIndex")
 21    first_block_token: Optional[str] = Field(default=None, alias="FirstBlockToken")
 22    second_block_token: Optional[str] = Field(default=None, alias="SecondBlockToken")
 23
 24
 25class CompleteSnapshotRequestModel(BaseModel):
 26    snapshot_id: str = Field(alias="SnapshotId")
 27    changed_blocks_count: int = Field(alias="ChangedBlocksCount")
 28    checksum: Optional[str] = Field(default=None, alias="Checksum")
 29    checksum_algorithm: Optional[Literal["SHA256"]] = Field(
 30        default=None, alias="ChecksumAlgorithm"
 31    )
 32    checksum_aggregation_method: Optional[Literal["LINEAR"]] = Field(
 33        default=None, alias="ChecksumAggregationMethod"
 34    )
 35
 36
 37class ResponseMetadataModel(BaseModel):
 38    request_id: str = Field(alias="RequestId")
 39    host_id: str = Field(alias="HostId")
 40    http_status_code: int = Field(alias="HTTPStatusCode")
 41    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 42    retry_attempts: int = Field(alias="RetryAttempts")
 43
 44
 45class GetSnapshotBlockRequestModel(BaseModel):
 46    snapshot_id: str = Field(alias="SnapshotId")
 47    block_index: int = Field(alias="BlockIndex")
 48    block_token: str = Field(alias="BlockToken")
 49
 50
 51class ListChangedBlocksRequestModel(BaseModel):
 52    second_snapshot_id: str = Field(alias="SecondSnapshotId")
 53    first_snapshot_id: Optional[str] = Field(default=None, alias="FirstSnapshotId")
 54    next_token: Optional[str] = Field(default=None, alias="NextToken")
 55    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 56    starting_block_index: Optional[int] = Field(
 57        default=None, alias="StartingBlockIndex"
 58    )
 59
 60
 61class ListSnapshotBlocksRequestModel(BaseModel):
 62    snapshot_id: str = Field(alias="SnapshotId")
 63    next_token: Optional[str] = Field(default=None, alias="NextToken")
 64    max_results: Optional[int] = Field(default=None, alias="MaxResults")
 65    starting_block_index: Optional[int] = Field(
 66        default=None, alias="StartingBlockIndex"
 67    )
 68
 69
 70class PutSnapshotBlockRequestModel(BaseModel):
 71    snapshot_id: str = Field(alias="SnapshotId")
 72    block_index: int = Field(alias="BlockIndex")
 73    block_data: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
 74        alias="BlockData"
 75    )
 76    data_length: int = Field(alias="DataLength")
 77    checksum: str = Field(alias="Checksum")
 78    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
 79    progress: Optional[int] = Field(default=None, alias="Progress")
 80
 81
 82class TagModel(BaseModel):
 83    key: Optional[str] = Field(default=None, alias="Key")
 84    value: Optional[str] = Field(default=None, alias="Value")
 85
 86
 87class CompleteSnapshotResponseModel(BaseModel):
 88    status: Literal["completed", "error", "pending"] = Field(alias="Status")
 89    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 90
 91
 92class GetSnapshotBlockResponseModel(BaseModel):
 93    data_length: int = Field(alias="DataLength")
 94    block_data: Type[StreamingBody] = Field(alias="BlockData")
 95    checksum: str = Field(alias="Checksum")
 96    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
 97    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
 98
 99
100class ListChangedBlocksResponseModel(BaseModel):
101    changed_blocks: List[ChangedBlockModel] = Field(alias="ChangedBlocks")
102    expiry_time: datetime = Field(alias="ExpiryTime")
103    volume_size: int = Field(alias="VolumeSize")
104    block_size: int = Field(alias="BlockSize")
105    next_token: str = Field(alias="NextToken")
106    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
107
108
109class ListSnapshotBlocksResponseModel(BaseModel):
110    blocks: List[BlockModel] = Field(alias="Blocks")
111    expiry_time: datetime = Field(alias="ExpiryTime")
112    volume_size: int = Field(alias="VolumeSize")
113    block_size: int = Field(alias="BlockSize")
114    next_token: str = Field(alias="NextToken")
115    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
116
117
118class PutSnapshotBlockResponseModel(BaseModel):
119    checksum: str = Field(alias="Checksum")
120    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
121    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
122
123
124class StartSnapshotRequestModel(BaseModel):
125    volume_size: int = Field(alias="VolumeSize")
126    parent_snapshot_id: Optional[str] = Field(default=None, alias="ParentSnapshotId")
127    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
128    description: Optional[str] = Field(default=None, alias="Description")
129    client_token: Optional[str] = Field(default=None, alias="ClientToken")
130    encrypted: Optional[bool] = Field(default=None, alias="Encrypted")
131    kms_key_arn: Optional[str] = Field(default=None, alias="KmsKeyArn")
132    timeout: Optional[int] = Field(default=None, alias="Timeout")
133
134
135class StartSnapshotResponseModel(BaseModel):
136    description: str = Field(alias="Description")
137    snapshot_id: str = Field(alias="SnapshotId")
138    owner_id: str = Field(alias="OwnerId")
139    status: Literal["completed", "error", "pending"] = Field(alias="Status")
140    start_time: datetime = Field(alias="StartTime")
141    volume_size: int = Field(alias="VolumeSize")
142    block_size: int = Field(alias="BlockSize")
143    tags: List[TagModel] = Field(alias="Tags")
144    parent_snapshot_id: str = Field(alias="ParentSnapshotId")
145    kms_key_arn: str = Field(alias="KmsKeyArn")
146    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
class BlockModel(mypydantic.models.base_model.BaseModel):
15class BlockModel(BaseModel):
16    block_index: Optional[int] = Field(default=None, alias="BlockIndex")
17    block_token: Optional[str] = Field(default=None, alias="BlockToken")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ChangedBlockModel(mypydantic.models.base_model.BaseModel):
20class ChangedBlockModel(BaseModel):
21    block_index: Optional[int] = Field(default=None, alias="BlockIndex")
22    first_block_token: Optional[str] = Field(default=None, alias="FirstBlockToken")
23    second_block_token: Optional[str] = Field(default=None, alias="SecondBlockToken")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class CompleteSnapshotRequestModel(mypydantic.models.base_model.BaseModel):
26class CompleteSnapshotRequestModel(BaseModel):
27    snapshot_id: str = Field(alias="SnapshotId")
28    changed_blocks_count: int = Field(alias="ChangedBlocksCount")
29    checksum: Optional[str] = Field(default=None, alias="Checksum")
30    checksum_algorithm: Optional[Literal["SHA256"]] = Field(
31        default=None, alias="ChecksumAlgorithm"
32    )
33    checksum_aggregation_method: Optional[Literal["LINEAR"]] = Field(
34        default=None, alias="ChecksumAggregationMethod"
35    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ResponseMetadataModel(mypydantic.models.base_model.BaseModel):
38class ResponseMetadataModel(BaseModel):
39    request_id: str = Field(alias="RequestId")
40    host_id: str = Field(alias="HostId")
41    http_status_code: int = Field(alias="HTTPStatusCode")
42    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
43    retry_attempts: int = Field(alias="RetryAttempts")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetSnapshotBlockRequestModel(mypydantic.models.base_model.BaseModel):
46class GetSnapshotBlockRequestModel(BaseModel):
47    snapshot_id: str = Field(alias="SnapshotId")
48    block_index: int = Field(alias="BlockIndex")
49    block_token: str = Field(alias="BlockToken")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListChangedBlocksRequestModel(mypydantic.models.base_model.BaseModel):
52class ListChangedBlocksRequestModel(BaseModel):
53    second_snapshot_id: str = Field(alias="SecondSnapshotId")
54    first_snapshot_id: Optional[str] = Field(default=None, alias="FirstSnapshotId")
55    next_token: Optional[str] = Field(default=None, alias="NextToken")
56    max_results: Optional[int] = Field(default=None, alias="MaxResults")
57    starting_block_index: Optional[int] = Field(
58        default=None, alias="StartingBlockIndex"
59    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListSnapshotBlocksRequestModel(mypydantic.models.base_model.BaseModel):
62class ListSnapshotBlocksRequestModel(BaseModel):
63    snapshot_id: str = Field(alias="SnapshotId")
64    next_token: Optional[str] = Field(default=None, alias="NextToken")
65    max_results: Optional[int] = Field(default=None, alias="MaxResults")
66    starting_block_index: Optional[int] = Field(
67        default=None, alias="StartingBlockIndex"
68    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class PutSnapshotBlockRequestModel(mypydantic.models.base_model.BaseModel):
71class PutSnapshotBlockRequestModel(BaseModel):
72    snapshot_id: str = Field(alias="SnapshotId")
73    block_index: int = Field(alias="BlockIndex")
74    block_data: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
75        alias="BlockData"
76    )
77    data_length: int = Field(alias="DataLength")
78    checksum: str = Field(alias="Checksum")
79    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
80    progress: Optional[int] = Field(default=None, alias="Progress")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class TagModel(mypydantic.models.base_model.BaseModel):
83class TagModel(BaseModel):
84    key: Optional[str] = Field(default=None, alias="Key")
85    value: Optional[str] = Field(default=None, alias="Value")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class CompleteSnapshotResponseModel(mypydantic.models.base_model.BaseModel):
88class CompleteSnapshotResponseModel(BaseModel):
89    status: Literal["completed", "error", "pending"] = Field(alias="Status")
90    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class GetSnapshotBlockResponseModel(mypydantic.models.base_model.BaseModel):
93class GetSnapshotBlockResponseModel(BaseModel):
94    data_length: int = Field(alias="DataLength")
95    block_data: Type[StreamingBody] = Field(alias="BlockData")
96    checksum: str = Field(alias="Checksum")
97    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
98    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListChangedBlocksResponseModel(mypydantic.models.base_model.BaseModel):
101class ListChangedBlocksResponseModel(BaseModel):
102    changed_blocks: List[ChangedBlockModel] = Field(alias="ChangedBlocks")
103    expiry_time: datetime = Field(alias="ExpiryTime")
104    volume_size: int = Field(alias="VolumeSize")
105    block_size: int = Field(alias="BlockSize")
106    next_token: str = Field(alias="NextToken")
107    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ListSnapshotBlocksResponseModel(mypydantic.models.base_model.BaseModel):
110class ListSnapshotBlocksResponseModel(BaseModel):
111    blocks: List[BlockModel] = Field(alias="Blocks")
112    expiry_time: datetime = Field(alias="ExpiryTime")
113    volume_size: int = Field(alias="VolumeSize")
114    block_size: int = Field(alias="BlockSize")
115    next_token: str = Field(alias="NextToken")
116    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class PutSnapshotBlockResponseModel(mypydantic.models.base_model.BaseModel):
119class PutSnapshotBlockResponseModel(BaseModel):
120    checksum: str = Field(alias="Checksum")
121    checksum_algorithm: Literal["SHA256"] = Field(alias="ChecksumAlgorithm")
122    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class StartSnapshotRequestModel(mypydantic.models.base_model.BaseModel):
125class StartSnapshotRequestModel(BaseModel):
126    volume_size: int = Field(alias="VolumeSize")
127    parent_snapshot_id: Optional[str] = Field(default=None, alias="ParentSnapshotId")
128    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
129    description: Optional[str] = Field(default=None, alias="Description")
130    client_token: Optional[str] = Field(default=None, alias="ClientToken")
131    encrypted: Optional[bool] = Field(default=None, alias="Encrypted")
132    kms_key_arn: Optional[str] = Field(default=None, alias="KmsKeyArn")
133    timeout: Optional[int] = Field(default=None, alias="Timeout")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class StartSnapshotResponseModel(mypydantic.models.base_model.BaseModel):
136class StartSnapshotResponseModel(BaseModel):
137    description: str = Field(alias="Description")
138    snapshot_id: str = Field(alias="SnapshotId")
139    owner_id: str = Field(alias="OwnerId")
140    status: Literal["completed", "error", "pending"] = Field(alias="Status")
141    start_time: datetime = Field(alias="StartTime")
142    volume_size: int = Field(alias="VolumeSize")
143    block_size: int = Field(alias="BlockSize")
144    tags: List[TagModel] = Field(alias="Tags")
145    parent_snapshot_id: str = Field(alias="ParentSnapshotId")
146    kms_key_arn: str = Field(alias="KmsKeyArn")
147    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs