Skip to content

Type definitions#

Index > Snowball > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

LambdaResourceUnionTypeDef#

# LambdaResourceUnionTypeDef definition

LambdaResourceUnionTypeDef = Union[
    LambdaResourceTypeDef,  # (1)
    LambdaResourceOutputTypeDef,  # (2)
]
  1. See LambdaResourceTypeDef
  2. See LambdaResourceOutputTypeDef

S3ResourceUnionTypeDef#

# S3ResourceUnionTypeDef definition

S3ResourceUnionTypeDef = Union[
    S3ResourceTypeDef,  # (1)
    S3ResourceOutputTypeDef,  # (2)
]
  1. See S3ResourceTypeDef
  2. See S3ResourceOutputTypeDef

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 ResponseMetadataTypeDef

GetJobUnlockCodeResultTypeDef#

# GetJobUnlockCodeResultTypeDef definition

class GetJobUnlockCodeResultTypeDef(TypedDict):
    UnlockCode: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSnowballUsageResultTypeDef#

# GetSnowballUsageResultTypeDef definition

class GetSnowballUsageResultTypeDef(TypedDict):
    SnowballLimit: int,
    SnowballsInUse: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSoftwareUpdatesResultTypeDef#

# GetSoftwareUpdatesResultTypeDef definition

class GetSoftwareUpdatesResultTypeDef(TypedDict):
    UpdatesURI: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListClustersResultTypeDef#

# ListClustersResultTypeDef definition

class ListClustersResultTypeDef(TypedDict):
    ClusterListEntries: list[ClusterListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ClusterListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListCompatibleImagesResultTypeDef#

# ListCompatibleImagesResultTypeDef definition

class ListCompatibleImagesResultTypeDef(TypedDict):
    CompatibleImages: list[CompatibleImageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See CompatibleImageTypeDef
  2. See ResponseMetadataTypeDef

ListPickupLocationsResultTypeDef#

# ListPickupLocationsResultTypeDef definition

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

CreateClusterResultTypeDef#

# CreateClusterResultTypeDef definition

class CreateClusterResultTypeDef(TypedDict):
    ClusterId: str,
    JobListEntries: list[JobListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListClusterJobsResultTypeDef#

# ListClusterJobsResultTypeDef definition

class ListClusterJobsResultTypeDef(TypedDict):
    JobListEntries: list[JobListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See JobListEntryTypeDef
  2. See ResponseMetadataTypeDef

ListJobsResultTypeDef#

# ListJobsResultTypeDef definition

class ListJobsResultTypeDef(TypedDict):
    JobListEntries: list[JobListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See JobListEntryTypeDef
  2. See ResponseMetadataTypeDef

DependentServiceTypeDef#

# DependentServiceTypeDef definition

class DependentServiceTypeDef(TypedDict):
    ServiceName: NotRequired[ServiceNameType],  # (1)
    ServiceVersion: NotRequired[ServiceVersionTypeDef],  # (2)
  1. See ServiceNameType
  2. See ServiceVersionTypeDef

DescribeAddressesRequestPaginateTypeDef#

# DescribeAddressesRequestPaginateTypeDef definition

class DescribeAddressesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListClusterJobsRequestPaginateTypeDef#

# ListClusterJobsRequestPaginateTypeDef definition

class ListClusterJobsRequestPaginateTypeDef(TypedDict):
    ClusterId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListClustersRequestPaginateTypeDef#

# ListClustersRequestPaginateTypeDef definition

class ListClustersRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListCompatibleImagesRequestPaginateTypeDef#

# ListCompatibleImagesRequestPaginateTypeDef definition

class ListCompatibleImagesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobsRequestPaginateTypeDef#

# ListJobsRequestPaginateTypeDef definition

class ListJobsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListLongTermPricingRequestPaginateTypeDef#

# ListLongTermPricingRequestPaginateTypeDef definition

class ListLongTermPricingRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

LambdaResourceOutputTypeDef#

# LambdaResourceOutputTypeDef definition

class LambdaResourceOutputTypeDef(TypedDict):
    LambdaArn: NotRequired[str],
    EventTriggers: NotRequired[list[EventTriggerDefinitionTypeDef]],  # (1)
  1. See EventTriggerDefinitionTypeDef

LambdaResourceTypeDef#

# LambdaResourceTypeDef definition

class LambdaResourceTypeDef(TypedDict):
    LambdaArn: NotRequired[str],
    EventTriggers: NotRequired[Sequence[EventTriggerDefinitionTypeDef]],  # (1)
  1. See EventTriggerDefinitionTypeDef

TaxDocumentsTypeDef#

# TaxDocumentsTypeDef definition

class TaxDocumentsTypeDef(TypedDict):
    IND: NotRequired[INDTaxDocumentsTypeDef],  # (1)
  1. See INDTaxDocumentsTypeDef

ListLongTermPricingResultTypeDef#

# ListLongTermPricingResultTypeDef definition

class ListLongTermPricingResultTypeDef(TypedDict):
    LongTermPricingEntries: list[LongTermPricingListEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See LongTermPricingListEntryTypeDef
  2. See ResponseMetadataTypeDef

OnDeviceServiceConfigurationTypeDef#

# OnDeviceServiceConfigurationTypeDef definition

class OnDeviceServiceConfigurationTypeDef(TypedDict):
    NFSOnDeviceService: NotRequired[NFSOnDeviceServiceConfigurationTypeDef],  # (1)
    TGWOnDeviceService: NotRequired[TGWOnDeviceServiceConfigurationTypeDef],  # (2)
    EKSOnDeviceService: NotRequired[EKSOnDeviceServiceConfigurationTypeDef],  # (3)
    S3OnDeviceService: NotRequired[S3OnDeviceServiceConfigurationTypeDef],  # (4)
  1. See NFSOnDeviceServiceConfigurationTypeDef
  2. See TGWOnDeviceServiceConfigurationTypeDef
  3. See EKSOnDeviceServiceConfigurationTypeDef
  4. See S3OnDeviceServiceConfigurationTypeDef

PickupDetailsTypeDef#

# PickupDetailsTypeDef definition

class PickupDetailsTypeDef(TypedDict):
    Name: NotRequired[str],
    PhoneNumber: NotRequired[str],
    Email: NotRequired[str],
    IdentificationNumber: NotRequired[str],
    IdentificationExpirationDate: NotRequired[TimestampTypeDef],
    IdentificationIssuingOrg: NotRequired[str],
    DevicePickupId: NotRequired[str],

S3ResourceOutputTypeDef#

# S3ResourceOutputTypeDef definition

class S3ResourceOutputTypeDef(TypedDict):
    BucketArn: NotRequired[str],
    KeyRange: NotRequired[KeyRangeTypeDef],  # (1)
    TargetOnDeviceServices: NotRequired[list[TargetOnDeviceServiceTypeDef]],  # (2)
  1. See KeyRangeTypeDef
  2. See TargetOnDeviceServiceTypeDef

S3ResourceTypeDef#

# S3ResourceTypeDef definition

class S3ResourceTypeDef(TypedDict):
    BucketArn: NotRequired[str],
    KeyRange: NotRequired[KeyRangeTypeDef],  # (1)
    TargetOnDeviceServices: NotRequired[Sequence[TargetOnDeviceServiceTypeDef]],  # (2)
  1. See KeyRangeTypeDef
  2. See TargetOnDeviceServiceTypeDef

ShippingDetailsTypeDef#

# ShippingDetailsTypeDef definition

class ShippingDetailsTypeDef(TypedDict):
    ShippingOption: NotRequired[ShippingOptionType],  # (1)
    InboundShipment: NotRequired[ShipmentTypeDef],  # (2)
    OutboundShipment: NotRequired[ShipmentTypeDef],  # (2)
  1. See ShippingOptionType
  2. See ShipmentTypeDef
  3. See ShipmentTypeDef

SnowconeDeviceConfigurationTypeDef#

# SnowconeDeviceConfigurationTypeDef definition

class SnowconeDeviceConfigurationTypeDef(TypedDict):
    WirelessConnection: NotRequired[WirelessConnectionTypeDef],  # (1)
  1. See WirelessConnectionTypeDef

ListServiceVersionsRequestRequestTypeDef#

# ListServiceVersionsRequestRequestTypeDef definition

class ListServiceVersionsRequestRequestTypeDef(TypedDict):
    ServiceName: ServiceNameType,  # (1)
    DependentServices: NotRequired[Sequence[DependentServiceTypeDef]],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ServiceNameType
  2. See DependentServiceTypeDef

ListServiceVersionsResultTypeDef#

# ListServiceVersionsResultTypeDef definition

class ListServiceVersionsResultTypeDef(TypedDict):
    ServiceVersions: list[ServiceVersionTypeDef],  # (1)
    ServiceName: ServiceNameType,  # (2)
    DependentServices: list[DependentServiceTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    NextToken: NotRequired[str],
  1. See ServiceVersionTypeDef
  2. See ServiceNameType
  3. See DependentServiceTypeDef
  4. See ResponseMetadataTypeDef

JobResourceOutputTypeDef#

# JobResourceOutputTypeDef definition

class JobResourceOutputTypeDef(TypedDict):
    S3Resources: NotRequired[list[S3ResourceOutputTypeDef]],  # (1)
    LambdaResources: NotRequired[list[LambdaResourceOutputTypeDef]],  # (2)
    Ec2AmiResources: NotRequired[list[Ec2AmiResourceTypeDef]],  # (3)
  1. See S3ResourceOutputTypeDef
  2. See LambdaResourceOutputTypeDef
  3. See Ec2AmiResourceTypeDef

DeviceConfigurationTypeDef#

# DeviceConfigurationTypeDef definition

class DeviceConfigurationTypeDef(TypedDict):
    SnowconeDeviceConfiguration: NotRequired[SnowconeDeviceConfigurationTypeDef],  # (1)
  1. See SnowconeDeviceConfigurationTypeDef

ClusterMetadataTypeDef#

# ClusterMetadataTypeDef definition

class ClusterMetadataTypeDef(TypedDict):
    ClusterId: NotRequired[str],
    Description: NotRequired[str],
    KmsKeyARN: NotRequired[str],
    RoleARN: NotRequired[str],
    ClusterState: NotRequired[ClusterStateType],  # (1)
    JobType: NotRequired[JobTypeType],  # (2)
    SnowballType: NotRequired[SnowballTypeType],  # (3)
    CreationDate: NotRequired[datetime],
    Resources: NotRequired[JobResourceOutputTypeDef],  # (4)
    AddressId: NotRequired[str],
    ShippingOption: NotRequired[ShippingOptionType],  # (5)
    Notification: NotRequired[NotificationOutputTypeDef],  # (6)
    ForwardingAddressId: NotRequired[str],
    TaxDocuments: NotRequired[TaxDocumentsTypeDef],  # (7)
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (8)
  1. See ClusterStateType
  2. See JobTypeType
  3. See SnowballTypeType
  4. See JobResourceOutputTypeDef
  5. See ShippingOptionType
  6. See NotificationOutputTypeDef
  7. See TaxDocumentsTypeDef
  8. See OnDeviceServiceConfigurationTypeDef

JobResourceTypeDef#

# JobResourceTypeDef definition

class JobResourceTypeDef(TypedDict):
    S3Resources: NotRequired[Sequence[S3ResourceUnionTypeDef]],  # (1)
    LambdaResources: NotRequired[Sequence[LambdaResourceUnionTypeDef]],  # (2)
    Ec2AmiResources: NotRequired[Sequence[Ec2AmiResourceTypeDef]],  # (3)
  1. See S3ResourceTypeDef S3ResourceOutputTypeDef
  2. See LambdaResourceTypeDef LambdaResourceOutputTypeDef
  3. See Ec2AmiResourceTypeDef

JobMetadataTypeDef#

# JobMetadataTypeDef definition

class JobMetadataTypeDef(TypedDict):
    JobId: NotRequired[str],
    JobState: NotRequired[JobStateType],  # (1)
    JobType: NotRequired[JobTypeType],  # (2)
    SnowballType: NotRequired[SnowballTypeType],  # (3)
    CreationDate: NotRequired[datetime],
    Resources: NotRequired[JobResourceOutputTypeDef],  # (4)
    Description: NotRequired[str],
    KmsKeyARN: NotRequired[str],
    RoleARN: NotRequired[str],
    AddressId: NotRequired[str],
    ShippingDetails: NotRequired[ShippingDetailsTypeDef],  # (5)
    SnowballCapacityPreference: NotRequired[SnowballCapacityType],  # (6)
    Notification: NotRequired[NotificationOutputTypeDef],  # (7)
    DataTransferProgress: NotRequired[DataTransferTypeDef],  # (8)
    JobLogInfo: NotRequired[JobLogsTypeDef],  # (9)
    ClusterId: NotRequired[str],
    ForwardingAddressId: NotRequired[str],
    TaxDocuments: NotRequired[TaxDocumentsTypeDef],  # (10)
    DeviceConfiguration: NotRequired[DeviceConfigurationTypeDef],  # (11)
    RemoteManagement: NotRequired[RemoteManagementType],  # (12)
    LongTermPricingId: NotRequired[str],
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (13)
    ImpactLevel: NotRequired[ImpactLevelType],  # (14)
    PickupDetails: NotRequired[PickupDetailsOutputTypeDef],  # (15)
    SnowballId: NotRequired[str],
  1. See JobStateType
  2. See JobTypeType
  3. See SnowballTypeType
  4. See JobResourceOutputTypeDef
  5. See ShippingDetailsTypeDef
  6. See SnowballCapacityType
  7. See NotificationOutputTypeDef
  8. See DataTransferTypeDef
  9. See JobLogsTypeDef
  10. See TaxDocumentsTypeDef
  11. See DeviceConfigurationTypeDef
  12. See RemoteManagementType
  13. See OnDeviceServiceConfigurationTypeDef
  14. See ImpactLevelType
  15. See PickupDetailsOutputTypeDef

DescribeClusterResultTypeDef#

# DescribeClusterResultTypeDef definition

class DescribeClusterResultTypeDef(TypedDict):
    ClusterMetadata: ClusterMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterMetadataTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterRequestRequestTypeDef#

# CreateClusterRequestRequestTypeDef definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    JobType: JobTypeType,  # (1)
    AddressId: str,
    SnowballType: SnowballTypeType,  # (2)
    ShippingOption: ShippingOptionType,  # (3)
    Resources: NotRequired[JobResourceTypeDef],  # (4)
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (5)
    Description: NotRequired[str],
    KmsKeyARN: NotRequired[str],
    RoleARN: NotRequired[str],
    Notification: NotRequired[NotificationTypeDef],  # (6)
    ForwardingAddressId: NotRequired[str],
    TaxDocuments: NotRequired[TaxDocumentsTypeDef],  # (7)
    RemoteManagement: NotRequired[RemoteManagementType],  # (8)
    InitialClusterSize: NotRequired[int],
    ForceCreateJobs: NotRequired[bool],
    LongTermPricingIds: NotRequired[Sequence[str]],
    SnowballCapacityPreference: NotRequired[SnowballCapacityType],  # (9)
  1. See JobTypeType
  2. See SnowballTypeType
  3. See ShippingOptionType
  4. See JobResourceTypeDef
  5. See OnDeviceServiceConfigurationTypeDef
  6. See NotificationTypeDef
  7. See TaxDocumentsTypeDef
  8. See RemoteManagementType
  9. See SnowballCapacityType

CreateJobRequestRequestTypeDef#

# CreateJobRequestRequestTypeDef definition

class CreateJobRequestRequestTypeDef(TypedDict):
    JobType: NotRequired[JobTypeType],  # (1)
    Resources: NotRequired[JobResourceTypeDef],  # (2)
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (3)
    Description: NotRequired[str],
    AddressId: NotRequired[str],
    KmsKeyARN: NotRequired[str],
    RoleARN: NotRequired[str],
    SnowballCapacityPreference: NotRequired[SnowballCapacityType],  # (4)
    ShippingOption: NotRequired[ShippingOptionType],  # (5)
    Notification: NotRequired[NotificationTypeDef],  # (6)
    ClusterId: NotRequired[str],
    SnowballType: NotRequired[SnowballTypeType],  # (7)
    ForwardingAddressId: NotRequired[str],
    TaxDocuments: NotRequired[TaxDocumentsTypeDef],  # (8)
    DeviceConfiguration: NotRequired[DeviceConfigurationTypeDef],  # (9)
    RemoteManagement: NotRequired[RemoteManagementType],  # (10)
    LongTermPricingId: NotRequired[str],
    ImpactLevel: NotRequired[ImpactLevelType],  # (11)
    PickupDetails: NotRequired[PickupDetailsTypeDef],  # (12)
  1. See JobTypeType
  2. See JobResourceTypeDef
  3. See OnDeviceServiceConfigurationTypeDef
  4. See SnowballCapacityType
  5. See ShippingOptionType
  6. See NotificationTypeDef
  7. See SnowballTypeType
  8. See TaxDocumentsTypeDef
  9. See DeviceConfigurationTypeDef
  10. See RemoteManagementType
  11. See ImpactLevelType
  12. See PickupDetailsTypeDef

UpdateClusterRequestRequestTypeDef#

# UpdateClusterRequestRequestTypeDef definition

class UpdateClusterRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    RoleARN: NotRequired[str],
    Description: NotRequired[str],
    Resources: NotRequired[JobResourceTypeDef],  # (1)
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (2)
    AddressId: NotRequired[str],
    ShippingOption: NotRequired[ShippingOptionType],  # (3)
    Notification: NotRequired[NotificationTypeDef],  # (4)
    ForwardingAddressId: NotRequired[str],
  1. See JobResourceTypeDef
  2. See OnDeviceServiceConfigurationTypeDef
  3. See ShippingOptionType
  4. See NotificationTypeDef

UpdateJobRequestRequestTypeDef#

# UpdateJobRequestRequestTypeDef definition

class UpdateJobRequestRequestTypeDef(TypedDict):
    JobId: str,
    RoleARN: NotRequired[str],
    Notification: NotRequired[NotificationTypeDef],  # (1)
    Resources: NotRequired[JobResourceTypeDef],  # (2)
    OnDeviceServiceConfiguration: NotRequired[OnDeviceServiceConfigurationTypeDef],  # (3)
    AddressId: NotRequired[str],
    ShippingOption: NotRequired[ShippingOptionType],  # (4)
    Description: NotRequired[str],
    SnowballCapacityPreference: NotRequired[SnowballCapacityType],  # (5)
    ForwardingAddressId: NotRequired[str],
    PickupDetails: NotRequired[PickupDetailsTypeDef],  # (6)
  1. See NotificationTypeDef
  2. See JobResourceTypeDef
  3. See OnDeviceServiceConfigurationTypeDef
  4. See ShippingOptionType
  5. See SnowballCapacityType
  6. See PickupDetailsTypeDef

DescribeJobResultTypeDef#

# DescribeJobResultTypeDef definition

class DescribeJobResultTypeDef(TypedDict):
    JobMetadata: JobMetadataTypeDef,  # (1)
    SubJobMetadata: list[JobMetadataTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See JobMetadataTypeDef
  2. See JobMetadataTypeDef
  3. See ResponseMetadataTypeDef