Snowball module#
Index > Snowball
Auto-generated documentation for Snowball type annotations stubs module types-boto3-snowball.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
Snowball
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Snowball
.
From PyPI with pip#
Install types-boto3
for Snowball
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[snowball]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[snowball]'
# standalone installation
python -m pip install types-boto3-snowball
How to uninstall#
python -m pip uninstall -y types-boto3-snowball
Usage#
Code samples can be found in Examples.
SnowballClient#
Type annotations and code completion for boto3.client("snowball")
as SnowballClient
boto3 documentation
# SnowballClient usage example
from boto3.session import Session
from types_boto3_snowball.client import SnowballClient
def get_client() -> SnowballClient:
return Session().client("snowball")
Paginators#
Type annotations and code completion for paginators
from boto3.client("snowball").get_paginator("...")
.
# DescribeAddressesPaginator usage example
from boto3.session import Session
from types_boto3_snowball.paginator import DescribeAddressesPaginator
def get_describe_addresses_paginator() -> DescribeAddressesPaginator:
return Session().client("snowball").get_paginator("describe_addresses"))
- DescribeAddressesPaginator
- ListClusterJobsPaginator
- ListClustersPaginator
- ListCompatibleImagesPaginator
- ListJobsPaginator
- ListLongTermPricingPaginator
Literals#
Type annotations for literals used in methods and schema.
# AddressTypeType usage example
from types_boto3_snowball.literals import AddressTypeType
def get_value() -> AddressTypeType:
return "AWS_SHIP"
- AddressTypeType
- ClusterStateType
- DescribeAddressesPaginatorName
- DeviceServiceNameType
- ImpactLevelType
- JobStateType
- JobTypeType
- ListClusterJobsPaginatorName
- ListClustersPaginatorName
- ListCompatibleImagesPaginatorName
- ListJobsPaginatorName
- ListLongTermPricingPaginatorName
- LongTermPricingTypeType
- RemoteManagementType
- ServiceNameType
- ShipmentStateType
- ShippingLabelStatusType
- ShippingOptionType
- SnowballCapacityType
- SnowballTypeType
- StorageUnitType
- TransferOptionType
- SnowballServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AddressTypeDef
- CancelClusterRequestTypeDef
- CancelJobRequestTypeDef
- ClusterListEntryTypeDef
- NotificationOutputTypeDef
- CompatibleImageTypeDef
- ResponseMetadataTypeDef
- JobListEntryTypeDef
- CreateLongTermPricingRequestTypeDef
- CreateReturnShippingLabelRequestTypeDef
- DataTransferTypeDef
- ServiceVersionTypeDef
- DescribeAddressRequestTypeDef
- PaginatorConfigTypeDef
- DescribeAddressesRequestTypeDef
- DescribeClusterRequestTypeDef
- DescribeJobRequestTypeDef
- DescribeReturnShippingLabelRequestTypeDef
- EKSOnDeviceServiceConfigurationTypeDef
- Ec2AmiResourceTypeDef
- EventTriggerDefinitionTypeDef
- GetJobManifestRequestTypeDef
- GetJobUnlockCodeRequestTypeDef
- GetSoftwareUpdatesRequestTypeDef
- INDTaxDocumentsTypeDef
- JobLogsTypeDef
- PickupDetailsOutputTypeDef
- KeyRangeTypeDef
- ListClusterJobsRequestTypeDef
- ListClustersRequestTypeDef
- ListCompatibleImagesRequestTypeDef
- ListJobsRequestTypeDef
- ListLongTermPricingRequestTypeDef
- LongTermPricingListEntryTypeDef
- ListPickupLocationsRequestTypeDef
- NFSOnDeviceServiceConfigurationTypeDef
- NotificationTypeDef
- S3OnDeviceServiceConfigurationTypeDef
- TGWOnDeviceServiceConfigurationTypeDef
- TimestampTypeDef
- TargetOnDeviceServiceTypeDef
- ShipmentTypeDef
- WirelessConnectionTypeDef
- UpdateJobShipmentStateRequestTypeDef
- UpdateLongTermPricingRequestTypeDef
- CreateAddressRequestTypeDef
- CreateAddressResultTypeDef
- CreateJobResultTypeDef
- CreateLongTermPricingResultTypeDef
- CreateReturnShippingLabelResultTypeDef
- DescribeAddressResultTypeDef
- DescribeAddressesResultTypeDef
- DescribeReturnShippingLabelResultTypeDef
- GetJobManifestResultTypeDef
- GetJobUnlockCodeResultTypeDef
- GetSnowballUsageResultTypeDef
- GetSoftwareUpdatesResultTypeDef
- ListClustersResultTypeDef
- ListCompatibleImagesResultTypeDef
- ListPickupLocationsResultTypeDef
- CreateClusterResultTypeDef
- ListClusterJobsResultTypeDef
- ListJobsResultTypeDef
- DependentServiceTypeDef
- DescribeAddressesRequestPaginateTypeDef
- ListClusterJobsRequestPaginateTypeDef
- ListClustersRequestPaginateTypeDef
- ListCompatibleImagesRequestPaginateTypeDef
- ListJobsRequestPaginateTypeDef
- ListLongTermPricingRequestPaginateTypeDef
- LambdaResourceOutputTypeDef
- LambdaResourceTypeDef
- TaxDocumentsTypeDef
- ListLongTermPricingResultTypeDef
- NotificationUnionTypeDef
- OnDeviceServiceConfigurationTypeDef
- PickupDetailsTypeDef
- S3ResourceOutputTypeDef
- S3ResourceTypeDef
- ShippingDetailsTypeDef
- SnowconeDeviceConfigurationTypeDef
- ListServiceVersionsRequestTypeDef
- ListServiceVersionsResultTypeDef
- PickupDetailsUnionTypeDef
- JobResourceOutputTypeDef
- JobResourceTypeDef
- DeviceConfigurationTypeDef
- ClusterMetadataTypeDef
- JobResourceUnionTypeDef
- JobMetadataTypeDef
- DescribeClusterResultTypeDef
- CreateClusterRequestTypeDef
- CreateJobRequestTypeDef
- UpdateClusterRequestTypeDef
- UpdateJobRequestTypeDef
- DescribeJobResultTypeDef