Type definitions#
Auto-generated documentation for Snowball type annotations stubs module mypy-boto3-snowball.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AddressTypeDef#
# AddressTypeDef definition
class AddressTypeDef(TypedDict):
AddressId: NotRequired[str],
Name: NotRequired[str],
Company: NotRequired[str],
Street1: NotRequired[str],
Street2: NotRequired[str],
Street3: NotRequired[str],
City: NotRequired[str],
StateOrProvince: NotRequired[str],
PrefectureOrDistrict: NotRequired[str],
Landmark: NotRequired[str],
Country: NotRequired[str],
PostalCode: NotRequired[str],
PhoneNumber: NotRequired[str],
IsRestricted: NotRequired[bool],
Type: NotRequired[AddressTypeType], # (1)
- See AddressTypeType
CancelClusterRequestRequestTypeDef#
# CancelClusterRequestRequestTypeDef definition
class CancelClusterRequestRequestTypeDef(TypedDict):
ClusterId: str,
CancelJobRequestRequestTypeDef#
# CancelJobRequestRequestTypeDef definition
class CancelJobRequestRequestTypeDef(TypedDict):
JobId: str,
ClusterListEntryTypeDef#
# ClusterListEntryTypeDef definition
class ClusterListEntryTypeDef(TypedDict):
ClusterId: NotRequired[str],
ClusterState: NotRequired[ClusterStateType], # (1)
CreationDate: NotRequired[datetime],
Description: NotRequired[str],
- See ClusterStateType
NotificationTypeDef#
# NotificationTypeDef definition
class NotificationTypeDef(TypedDict):
SnsTopicARN: NotRequired[str],
JobStatesToNotify: NotRequired[Sequence[JobStateType]], # (1)
NotifyAll: NotRequired[bool],
DevicePickupSnsTopicARN: NotRequired[str],
- See JobStateType
CompatibleImageTypeDef#
# CompatibleImageTypeDef definition
class CompatibleImageTypeDef(TypedDict):
AmiId: NotRequired[str],
Name: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
JobListEntryTypeDef#
# JobListEntryTypeDef definition
class JobListEntryTypeDef(TypedDict):
JobId: NotRequired[str],
JobState: NotRequired[JobStateType], # (1)
IsMaster: NotRequired[bool],
JobType: NotRequired[JobTypeType], # (2)
SnowballType: NotRequired[SnowballTypeType], # (3)
CreationDate: NotRequired[datetime],
Description: NotRequired[str],
- See JobStateType
- See JobTypeType
- See SnowballTypeType
CreateLongTermPricingRequestRequestTypeDef#
# CreateLongTermPricingRequestRequestTypeDef definition
class CreateLongTermPricingRequestRequestTypeDef(TypedDict):
LongTermPricingType: LongTermPricingTypeType, # (1)
SnowballType: SnowballTypeType, # (2)
IsLongTermPricingAutoRenew: NotRequired[bool],
CreateReturnShippingLabelRequestRequestTypeDef#
# CreateReturnShippingLabelRequestRequestTypeDef definition
class CreateReturnShippingLabelRequestRequestTypeDef(TypedDict):
JobId: str,
ShippingOption: NotRequired[ShippingOptionType], # (1)
DataTransferTypeDef#
# DataTransferTypeDef definition
class DataTransferTypeDef(TypedDict):
BytesTransferred: NotRequired[int],
ObjectsTransferred: NotRequired[int],
TotalBytes: NotRequired[int],
TotalObjects: NotRequired[int],
ServiceVersionTypeDef#
# ServiceVersionTypeDef definition
class ServiceVersionTypeDef(TypedDict):
Version: NotRequired[str],
DescribeAddressRequestRequestTypeDef#
# DescribeAddressRequestRequestTypeDef definition
class DescribeAddressRequestRequestTypeDef(TypedDict):
AddressId: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAddressesRequestRequestTypeDef#
# DescribeAddressesRequestRequestTypeDef definition
class DescribeAddressesRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
DescribeClusterRequestRequestTypeDef#
# DescribeClusterRequestRequestTypeDef definition
class DescribeClusterRequestRequestTypeDef(TypedDict):
ClusterId: str,
DescribeJobRequestRequestTypeDef#
# DescribeJobRequestRequestTypeDef definition
class DescribeJobRequestRequestTypeDef(TypedDict):
JobId: str,
DescribeReturnShippingLabelRequestRequestTypeDef#
# DescribeReturnShippingLabelRequestRequestTypeDef definition
class DescribeReturnShippingLabelRequestRequestTypeDef(TypedDict):
JobId: str,
EKSOnDeviceServiceConfigurationTypeDef#
# EKSOnDeviceServiceConfigurationTypeDef definition
class EKSOnDeviceServiceConfigurationTypeDef(TypedDict):
KubernetesVersion: NotRequired[str],
EKSAnywhereVersion: NotRequired[str],
Ec2AmiResourceTypeDef#
# Ec2AmiResourceTypeDef definition
class Ec2AmiResourceTypeDef(TypedDict):
AmiId: str,
SnowballAmiId: NotRequired[str],
EventTriggerDefinitionTypeDef#
# EventTriggerDefinitionTypeDef definition
class EventTriggerDefinitionTypeDef(TypedDict):
EventResourceARN: NotRequired[str],
GetJobManifestRequestRequestTypeDef#
# GetJobManifestRequestRequestTypeDef definition
class GetJobManifestRequestRequestTypeDef(TypedDict):
JobId: str,
GetJobUnlockCodeRequestRequestTypeDef#
# GetJobUnlockCodeRequestRequestTypeDef definition
class GetJobUnlockCodeRequestRequestTypeDef(TypedDict):
JobId: str,
GetSoftwareUpdatesRequestRequestTypeDef#
# GetSoftwareUpdatesRequestRequestTypeDef definition
class GetSoftwareUpdatesRequestRequestTypeDef(TypedDict):
JobId: str,
INDTaxDocumentsTypeDef#
# INDTaxDocumentsTypeDef definition
class INDTaxDocumentsTypeDef(TypedDict):
GSTIN: NotRequired[str],
JobLogsTypeDef#
# JobLogsTypeDef definition
class JobLogsTypeDef(TypedDict):
JobCompletionReportURI: NotRequired[str],
JobSuccessLogURI: NotRequired[str],
JobFailureLogURI: NotRequired[str],
KeyRangeTypeDef#
# KeyRangeTypeDef definition
class KeyRangeTypeDef(TypedDict):
BeginMarker: NotRequired[str],
EndMarker: NotRequired[str],
ListClusterJobsRequestRequestTypeDef#
# ListClusterJobsRequestRequestTypeDef definition
class ListClusterJobsRequestRequestTypeDef(TypedDict):
ClusterId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListClustersRequestRequestTypeDef#
# ListClustersRequestRequestTypeDef definition
class ListClustersRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListCompatibleImagesRequestRequestTypeDef#
# ListCompatibleImagesRequestRequestTypeDef definition
class ListCompatibleImagesRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListJobsRequestRequestTypeDef#
# ListJobsRequestRequestTypeDef definition
class ListJobsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListLongTermPricingRequestRequestTypeDef#
# ListLongTermPricingRequestRequestTypeDef definition
class ListLongTermPricingRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
LongTermPricingListEntryTypeDef#
# LongTermPricingListEntryTypeDef definition
class LongTermPricingListEntryTypeDef(TypedDict):
LongTermPricingId: NotRequired[str],
LongTermPricingEndDate: NotRequired[datetime],
LongTermPricingStartDate: NotRequired[datetime],
LongTermPricingType: NotRequired[LongTermPricingTypeType], # (1)
CurrentActiveJob: NotRequired[str],
ReplacementJob: NotRequired[str],
IsLongTermPricingAutoRenew: NotRequired[bool],
LongTermPricingStatus: NotRequired[str],
SnowballType: NotRequired[SnowballTypeType], # (2)
JobIds: NotRequired[List[str]],
ListPickupLocationsRequestRequestTypeDef#
# ListPickupLocationsRequestRequestTypeDef definition
class ListPickupLocationsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
NFSOnDeviceServiceConfigurationTypeDef#
# NFSOnDeviceServiceConfigurationTypeDef definition
class NFSOnDeviceServiceConfigurationTypeDef(TypedDict):
StorageLimit: NotRequired[int],
StorageUnit: NotRequired[StorageUnitType], # (1)
- See StorageUnitType
S3OnDeviceServiceConfigurationTypeDef#
# S3OnDeviceServiceConfigurationTypeDef definition
class S3OnDeviceServiceConfigurationTypeDef(TypedDict):
StorageLimit: NotRequired[float],
StorageUnit: NotRequired[StorageUnitType], # (1)
ServiceSize: NotRequired[int],
FaultTolerance: NotRequired[int],
- See StorageUnitType
TGWOnDeviceServiceConfigurationTypeDef#
# TGWOnDeviceServiceConfigurationTypeDef definition
class TGWOnDeviceServiceConfigurationTypeDef(TypedDict):
StorageLimit: NotRequired[int],
StorageUnit: NotRequired[StorageUnitType], # (1)
- See StorageUnitType
TargetOnDeviceServiceTypeDef#
# TargetOnDeviceServiceTypeDef definition
class TargetOnDeviceServiceTypeDef(TypedDict):
ServiceName: NotRequired[DeviceServiceNameType], # (1)
TransferOption: NotRequired[TransferOptionType], # (2)
ShipmentTypeDef#
# ShipmentTypeDef definition
class ShipmentTypeDef(TypedDict):
Status: NotRequired[str],
TrackingNumber: NotRequired[str],
WirelessConnectionTypeDef#
# WirelessConnectionTypeDef definition
class WirelessConnectionTypeDef(TypedDict):
IsWifiEnabled: NotRequired[bool],
UpdateJobShipmentStateRequestRequestTypeDef#
# UpdateJobShipmentStateRequestRequestTypeDef definition
class UpdateJobShipmentStateRequestRequestTypeDef(TypedDict):
JobId: str,
ShipmentState: ShipmentStateType, # (1)
UpdateLongTermPricingRequestRequestTypeDef#
# UpdateLongTermPricingRequestRequestTypeDef definition
class UpdateLongTermPricingRequestRequestTypeDef(TypedDict):
LongTermPricingId: str,
ReplacementJob: NotRequired[str],
IsLongTermPricingAutoRenew: NotRequired[bool],
CreateAddressRequestRequestTypeDef#
# CreateAddressRequestRequestTypeDef definition
class CreateAddressRequestRequestTypeDef(TypedDict):
Address: AddressTypeDef, # (1)
- See AddressTypeDef
CreateAddressResultTypeDef#
# CreateAddressResultTypeDef definition
class CreateAddressResultTypeDef(TypedDict):
AddressId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateJobResultTypeDef#
# CreateJobResultTypeDef definition
class CreateJobResultTypeDef(TypedDict):
JobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateLongTermPricingResultTypeDef#
# CreateLongTermPricingResultTypeDef definition
class CreateLongTermPricingResultTypeDef(TypedDict):
LongTermPricingId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateReturnShippingLabelResultTypeDef#
# CreateReturnShippingLabelResultTypeDef definition
class CreateReturnShippingLabelResultTypeDef(TypedDict):
Status: ShippingLabelStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAddressResultTypeDef#
# DescribeAddressResultTypeDef definition
class DescribeAddressResultTypeDef(TypedDict):
Address: AddressTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAddressesResultTypeDef#
# DescribeAddressesResultTypeDef definition
class DescribeAddressesResultTypeDef(TypedDict):
Addresses: List[AddressTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeReturnShippingLabelResultTypeDef#
# DescribeReturnShippingLabelResultTypeDef definition
class DescribeReturnShippingLabelResultTypeDef(TypedDict):
Status: ShippingLabelStatusType, # (1)
ExpirationDate: datetime,
ReturnShippingLabelURI: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetJobManifestResultTypeDef#
# GetJobManifestResultTypeDef definition
class GetJobManifestResultTypeDef(TypedDict):
ManifestURI: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetJobUnlockCodeResultTypeDef#
# GetJobUnlockCodeResultTypeDef definition
class GetJobUnlockCodeResultTypeDef(TypedDict):
UnlockCode: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSnowballUsageResultTypeDef#
# GetSnowballUsageResultTypeDef definition
class GetSnowballUsageResultTypeDef(TypedDict):
SnowballLimit: int,
SnowballsInUse: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSoftwareUpdatesResultTypeDef#
# GetSoftwareUpdatesResultTypeDef definition
class GetSoftwareUpdatesResultTypeDef(TypedDict):
UpdatesURI: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListClustersResultTypeDef#
# ListClustersResultTypeDef definition
class ListClustersResultTypeDef(TypedDict):
ClusterListEntries: List[ClusterListEntryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCompatibleImagesResultTypeDef#
# ListCompatibleImagesResultTypeDef definition
class ListCompatibleImagesResultTypeDef(TypedDict):
CompatibleImages: List[CompatibleImageTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPickupLocationsResultTypeDef#
# ListPickupLocationsResultTypeDef definition
class ListPickupLocationsResultTypeDef(TypedDict):
Addresses: List[AddressTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateClusterResultTypeDef#
# CreateClusterResultTypeDef definition
class CreateClusterResultTypeDef(TypedDict):
ClusterId: str,
JobListEntries: List[JobListEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClusterJobsResultTypeDef#
# ListClusterJobsResultTypeDef definition
class ListClusterJobsResultTypeDef(TypedDict):
JobListEntries: List[JobListEntryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobsResultTypeDef#
# ListJobsResultTypeDef definition
class ListJobsResultTypeDef(TypedDict):
JobListEntries: List[JobListEntryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DependentServiceTypeDef#
# DependentServiceTypeDef definition
class DependentServiceTypeDef(TypedDict):
ServiceName: NotRequired[ServiceNameType], # (1)
ServiceVersion: NotRequired[ServiceVersionTypeDef], # (2)
- See ServiceNameType
- See ServiceVersionTypeDef
DescribeAddressesRequestDescribeAddressesPaginateTypeDef#
# DescribeAddressesRequestDescribeAddressesPaginateTypeDef definition
class DescribeAddressesRequestDescribeAddressesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClusterJobsRequestListClusterJobsPaginateTypeDef#
# ListClusterJobsRequestListClusterJobsPaginateTypeDef definition
class ListClusterJobsRequestListClusterJobsPaginateTypeDef(TypedDict):
ClusterId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClustersRequestListClustersPaginateTypeDef#
# ListClustersRequestListClustersPaginateTypeDef definition
class ListClustersRequestListClustersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCompatibleImagesRequestListCompatibleImagesPaginateTypeDef#
# ListCompatibleImagesRequestListCompatibleImagesPaginateTypeDef definition
class ListCompatibleImagesRequestListCompatibleImagesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobsRequestListJobsPaginateTypeDef#
# ListJobsRequestListJobsPaginateTypeDef definition
class ListJobsRequestListJobsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListLongTermPricingRequestListLongTermPricingPaginateTypeDef#
# ListLongTermPricingRequestListLongTermPricingPaginateTypeDef definition
class ListLongTermPricingRequestListLongTermPricingPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
LambdaResourceTypeDef#
# LambdaResourceTypeDef definition
class LambdaResourceTypeDef(TypedDict):
LambdaArn: NotRequired[str],
EventTriggers: NotRequired[Sequence[EventTriggerDefinitionTypeDef]], # (1)
TaxDocumentsTypeDef#
# TaxDocumentsTypeDef definition
class TaxDocumentsTypeDef(TypedDict):
IND: NotRequired[INDTaxDocumentsTypeDef], # (1)
ListLongTermPricingResultTypeDef#
# ListLongTermPricingResultTypeDef definition
class ListLongTermPricingResultTypeDef(TypedDict):
LongTermPricingEntries: List[LongTermPricingListEntryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
OnDeviceServiceConfigurationTypeDef#
# OnDeviceServiceConfigurationTypeDef definition
class OnDeviceServiceConfigurationTypeDef(TypedDict):
NFSOnDeviceService: NotRequired[NFSOnDeviceServiceConfigurationTypeDef], # (1)
TGWOnDeviceService: NotRequired[TGWOnDeviceServiceConfigurationTypeDef], # (2)
EKSOnDeviceService: NotRequired[EKSOnDeviceServiceConfigurationTypeDef], # (3)
S3OnDeviceService: NotRequired[S3OnDeviceServiceConfigurationTypeDef], # (4)
- See NFSOnDeviceServiceConfigurationTypeDef
- See TGWOnDeviceServiceConfigurationTypeDef
- See EKSOnDeviceServiceConfigurationTypeDef
- See S3OnDeviceServiceConfigurationTypeDef
PickupDetailsTypeDef#
# PickupDetailsTypeDef definition
class PickupDetailsTypeDef(TypedDict):
Name: NotRequired[str],
PhoneNumber: NotRequired[str],
Email: NotRequired[str],
IdentificationNumber: NotRequired[str],
IdentificationExpirationDate: NotRequired[Union[datetime, str]],
IdentificationIssuingOrg: NotRequired[str],
DevicePickupId: NotRequired[str],
S3ResourceTypeDef#
# S3ResourceTypeDef definition
class S3ResourceTypeDef(TypedDict):
BucketArn: NotRequired[str],
KeyRange: NotRequired[KeyRangeTypeDef], # (1)
TargetOnDeviceServices: NotRequired[Sequence[TargetOnDeviceServiceTypeDef]], # (2)
ShippingDetailsTypeDef#
# ShippingDetailsTypeDef definition
class ShippingDetailsTypeDef(TypedDict):
ShippingOption: NotRequired[ShippingOptionType], # (1)
InboundShipment: NotRequired[ShipmentTypeDef], # (2)
OutboundShipment: NotRequired[ShipmentTypeDef], # (2)
- See ShippingOptionType
- See ShipmentTypeDef
- See ShipmentTypeDef
SnowconeDeviceConfigurationTypeDef#