Skip to content

Type definitions#

Index > Snowball > Type definitions

Auto-generated documentation for Snowball type annotations stubs module mypy-boto3-snowball.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

NotificationUnionTypeDef#

# NotificationUnionTypeDef definition

NotificationUnionTypeDef = Union[
    NotificationTypeDef,  # (1)
    NotificationOutputTypeDef,  # (2)
]
  1. See NotificationTypeDef
  2. See NotificationOutputTypeDef

PickupDetailsUnionTypeDef#

# PickupDetailsUnionTypeDef definition

PickupDetailsUnionTypeDef = Union[
    PickupDetailsTypeDef,  # (1)
    PickupDetailsOutputTypeDef,  # (2)
]
  1. See PickupDetailsTypeDef
  2. See PickupDetailsOutputTypeDef

JobResourceUnionTypeDef#

# JobResourceUnionTypeDef definition

JobResourceUnionTypeDef = Union[
    JobResourceTypeDef,  # (1)
    JobResourceOutputTypeDef,  # (2)
]
  1. See JobResourceTypeDef
  2. See JobResourceOutputTypeDef

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)
  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],
  1. See ClusterStateType

NotificationOutputTypeDef#

# NotificationOutputTypeDef definition

class NotificationOutputTypeDef(TypedDict):
    SnsTopicARN: NotRequired[str],
    JobStatesToNotify: NotRequired[List[JobStateType]],  # (1)
    NotifyAll: NotRequired[bool],
    DevicePickupSnsTopicARN: NotRequired[str],
  1. See JobStateType

CompatibleImageTypeDef#

# CompatibleImageTypeDef definition

class CompatibleImageTypeDef(TypedDict):
    AmiId: NotRequired[str],
    Name: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

NotificationTypeDef#

# NotificationTypeDef definition

class NotificationTypeDef(TypedDict):
    SnsTopicARN: NotRequired[str],
    JobStatesToNotify: NotRequired[Sequence[JobStateType]],  # (1)
    NotifyAll: NotRequired[bool],
    DevicePickupSnsTopicARN: NotRequired[str],
  1. See JobStateType

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],
  1. See JobStateType
  2. See JobTypeType
  3. See SnowballTypeType

CreateLongTermPricingRequestRequestTypeDef#

# CreateLongTermPricingRequestRequestTypeDef definition

class CreateLongTermPricingRequestRequestTypeDef(TypedDict):
    LongTermPricingType: LongTermPricingTypeType,  # (1)
    SnowballType: SnowballTypeType,  # (2)
    IsLongTermPricingAutoRenew: NotRequired[bool],
  1. See LongTermPricingTypeType
  2. See SnowballTypeType

CreateReturnShippingLabelRequestRequestTypeDef#

# CreateReturnShippingLabelRequestRequestTypeDef definition

class CreateReturnShippingLabelRequestRequestTypeDef(TypedDict):
    JobId: str,
    ShippingOption: NotRequired[ShippingOptionType],  # (1)
  1. See ShippingOptionType

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

PickupDetailsOutputTypeDef#

# PickupDetailsOutputTypeDef definition

class PickupDetailsOutputTypeDef(TypedDict):
    Name: NotRequired[str],
    PhoneNumber: NotRequired[str],
    Email: NotRequired[str],
    IdentificationNumber: NotRequired[str],
    IdentificationExpirationDate: NotRequired[datetime],
    IdentificationIssuingOrg: NotRequired[str],
    DevicePickupId: 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]],
  1. See LongTermPricingTypeType
  2. See SnowballTypeType

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

S3OnDeviceServiceConfigurationTypeDef#

# S3OnDeviceServiceConfigurationTypeDef definition

class S3OnDeviceServiceConfigurationTypeDef(TypedDict):
    StorageLimit: NotRequired[float],
    StorageUnit: NotRequired[StorageUnitType],  # (1)
    ServiceSize: NotRequired[int],
    FaultTolerance: NotRequired[int],
  1. See StorageUnitType

TGWOnDeviceServiceConfigurationTypeDef#

# TGWOnDeviceServiceConfigurationTypeDef definition

class TGWOnDeviceServiceConfigurationTypeDef(TypedDict):
    StorageLimit: NotRequired[int],
    StorageUnit: NotRequired[StorageUnitType],  # (1)
  1. See StorageUnitType

TargetOnDeviceServiceTypeDef#

# TargetOnDeviceServiceTypeDef definition

class TargetOnDeviceServiceTypeDef(TypedDict):
    ServiceName: NotRequired[DeviceServiceNameType],  # (1)
    TransferOption: NotRequired[TransferOptionType],  # (2)
  1. See DeviceServiceNameType
  2. See TransferOptionType

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

UpdateLongTermPricingRequestRequestTypeDef#

# UpdateLongTermPricingRequestRequestTypeDef definition

class UpdateLongTermPricingRequestRequestTypeDef(TypedDict):
    LongTermPricingId: str,
    ReplacementJob: NotRequired[str],
    IsLongTermPricingAutoRenew: NotRequired[bool],

CreateAddressRequestRequestTypeDef#

# CreateAddressRequestRequestTypeDef definition

class CreateAddressRequestRequestTypeDef(TypedDict):
    Address: AddressTypeDef,  # (1)
  1. See AddressTypeDef

CreateAddressResultTypeDef#

# CreateAddressResultTypeDef definition

class CreateAddressResultTypeDef(TypedDict):
    AddressId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateJobResultTypeDef#

# CreateJobResultTypeDef definition

class CreateJobResultTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLongTermPricingResultTypeDef#

# CreateLongTermPricingResultTypeDef definition

class CreateLongTermPricingResultTypeDef(TypedDict):
    LongTermPricingId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateReturnShippingLabelResultTypeDef#

# CreateReturnShippingLabelResultTypeDef definition

class CreateReturnShippingLabelResultTypeDef(TypedDict):
    Status: ShippingLabelStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ShippingLabelStatusType
  2. See ResponseMetadataTypeDef

DescribeAddressResultTypeDef#

# DescribeAddressResultTypeDef definition

class DescribeAddressResultTypeDef(TypedDict):
    Address: AddressTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AddressTypeDef
  2. See ResponseMetadataTypeDef

DescribeAddressesResultTypeDef#

# DescribeAddressesResultTypeDef definition

class DescribeAddressesResultTypeDef(TypedDict):
    Addresses: List[AddressTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AddressTypeDef
  2. See ResponseMetadataTypeDef

DescribeReturnShippingLabelResultTypeDef#

# DescribeReturnShippingLabelResultTypeDef definition

class DescribeReturnShippingLabelResultTypeDef(TypedDict):
    Status: ShippingLabelStatusType,  # (1)
    ExpirationDate: datetime,
    ReturnShippingLabelURI: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ShippingLabelStatusType
  2. See ResponseMetadataTypeDef

GetJobManifestResultTypeDef#

# GetJobManifestResultTypeDef definition

class GetJobManifestResultTypeDef(TypedDict):
    ManifestURI: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See