Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-snowball

Description

The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide .

Installation

NPM

npm install @aws-sdk/client-snowball

Yarn

yarn add @aws-sdk/client-snowball

pnpm

pnpm add @aws-sdk/client-snowball

Types

Type Name	Type
Address	Interface
AddressType	TypeAlias
AddressTypeenum	Variable
CancelClusterCommand	Class
CancelClusterCommandInput	Interface
CancelClusterCommandOutput	Interface
CancelClusterRequest	Interface
CancelClusterResult	Interface
CancelJobCommand	Class
CancelJobCommandInput	Interface
CancelJobCommandOutput	Interface
CancelJobRequest	Interface
CancelJobResult	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ClusterLimitExceededException	Class
ClusterListEntry	Interface
ClusterMetadata	Interface
ClusterState	TypeAlias
ClusterStateenum	Variable
CompatibleImage	Interface
ConflictException	Class
CreateAddressCommand	Class
CreateAddressCommandInput	Interface
CreateAddressCommandOutput	Interface
CreateAddressRequest	Interface
CreateAddressResult	Interface
CreateClusterCommand	Class
CreateClusterCommandInput	Interface
CreateClusterCommandOutput	Interface
CreateClusterRequest	Interface
CreateClusterResult	Interface
CreateJobCommand	Class
CreateJobCommandInput	Interface
CreateJobCommandOutput	Interface
CreateJobRequest	Interface
CreateJobResult	Interface
CreateLongTermPricingCommand	Class
CreateLongTermPricingCommandInput	Interface
CreateLongTermPricingCommandOutput	Interface
CreateLongTermPricingRequest	Interface
CreateLongTermPricingResult	Interface
CreateReturnShippingLabelCommand	Class
CreateReturnShippingLabelCommandInput	Interface
CreateReturnShippingLabelCommandOutput	Interface
CreateReturnShippingLabelRequest	Interface
CreateReturnShippingLabelResult	Interface
DataTransfer	Interface
DependentService	Interface
DescribeAddressCommand	Class
DescribeAddressCommandInput	Interface
DescribeAddressCommandOutput	Interface
DescribeAddressesCommand	Class
DescribeAddressesCommandInput	Interface
DescribeAddressesCommandOutput	Interface
DescribeAddressesRequest	Interface
DescribeAddressesResult	Interface
DescribeAddressRequest	Interface
DescribeAddressResult	Interface
DescribeClusterCommand	Class
DescribeClusterCommandInput	Interface
DescribeClusterCommandOutput	Interface
DescribeClusterRequest	Interface
DescribeClusterResult	Interface
DescribeJobCommand	Class
DescribeJobCommandInput	Interface
DescribeJobCommandOutput	Interface
DescribeJobRequest	Interface
DescribeJobResult	Interface
DescribeReturnShippingLabelCommand	Class
DescribeReturnShippingLabelCommandInput	Interface
DescribeReturnShippingLabelCommandOutput	Interface
DescribeReturnShippingLabelRequest	Interface
DescribeReturnShippingLabelResult	Interface
DeviceConfiguration	Interface
DeviceServiceName	TypeAlias
DeviceServiceNameenum	Variable
Ec2AmiResource	Interface
Ec2RequestFailedException	Class
EKSOnDeviceServiceConfiguration	Interface
EventTriggerDefinition	Interface
GetJobManifestCommand	Class
GetJobManifestCommandInput	Interface
GetJobManifestCommandOutput	Interface
GetJobManifestRequest	Interface
GetJobManifestResult	Interface
GetJobUnlockCodeCommand	Class
GetJobUnlockCodeCommandInput	Interface
GetJobUnlockCodeCommandOutput	Interface
GetJobUnlockCodeRequest	Interface
GetJobUnlockCodeResult	Interface
GetSnowballUsageCommand	Class
GetSnowballUsageCommandInput	Interface
GetSnowballUsageCommandOutput	Interface
GetSnowballUsageRequest	Interface
GetSnowballUsageResult	Interface
GetSoftwareUpdatesCommand	Class
GetSoftwareUpdatesCommandInput	Interface
GetSoftwareUpdatesCommandOutput	Interface
GetSoftwareUpdatesRequest	Interface
GetSoftwareUpdatesResult	Interface
ImpactLevel	TypeAlias
ImpactLevelenum	Variable
INDTaxDocuments	Interface
InvalidAddressException	Class
InvalidInputCombinationException	Class
InvalidJobStateException	Class
InvalidNextTokenException	Class
InvalidResourceException	Class
JobListEntry	Interface
JobLogs	Interface
JobMetadata	Interface
JobResource	Interface
JobState	TypeAlias
JobStateenum	Variable
JobType	TypeAlias
JobTypeenum	Variable
KeyRange	Interface
KMSRequestFailedException	Class
LambdaResource	Interface
ListClusterJobsCommand	Class
ListClusterJobsCommandInput	Interface
ListClusterJobsCommandOutput	Interface
ListClusterJobsRequest	Interface
ListClusterJobsResult	Interface
ListClustersCommand	Class
ListClustersCommandInput	Interface
ListClustersCommandOutput	Interface
ListClustersRequest	Interface
ListClustersResult	Interface
ListCompatibleImagesCommand	Class
ListCompatibleImagesCommandInput	Interface
ListCompatibleImagesCommandOutput	Interface
ListCompatibleImagesRequest	Interface
ListCompatibleImagesResult	Interface
ListJobsCommand	Class
ListJobsCommandInput	Interface
ListJobsCommandOutput	Interface
ListJobsRequest	Interface
ListJobsResult	Interface
ListLongTermPricingCommand	Class
ListLongTermPricingCommandInput	Interface
ListLongTermPricingCommandOutput	Interface
ListLongTermPricingRequest	Interface
ListLongTermPricingResult	Interface
ListPickupLocationsCommand	Class
ListPickupLocationsCommandInput	Interface
ListPickupLocationsCommandOutput	Interface
ListPickupLocationsRequest	Interface
ListPickupLocationsResult	Interface
ListServiceVersionsCommand	Class
ListServiceVersionsCommandInput	Interface
ListServiceVersionsCommandOutput	Interface
ListServiceVersionsRequest	Interface
ListServiceVersionsResult	Interface
LongTermPricingListEntry	Interface
LongTermPricingType	TypeAlias
LongTermPricingTypeenum	Variable
NFSOnDeviceServiceConfiguration	Interface
Notification	Interface
OnDeviceServiceConfiguration	Interface
paginateDescribeAddresses	Variable
paginateListClusterJobs	Variable
paginateListClusters	Variable
paginateListCompatibleImages	Variable
paginateListJobs	Variable
paginateListLongTermPricing	Variable
paginateListPickupLocations	Variable
PickupDetails	Interface
RemoteManagement	TypeAlias
RemoteManagementenum	Variable
ReturnShippingLabelAlreadyExistsException	Class
RuntimeExtension	Interface
S3OnDeviceServiceConfiguration	Interface
S3Resource	Interface
ServiceInputTypes	TypeAlias
ServiceName	TypeAlias
ServiceNameenum	Variable
ServiceOutputTypes	TypeAlias
ServiceVersion	Interface
Shipment	Interface
ShipmentState	TypeAlias
ShipmentStateenum	Variable
ShippingDetails	Interface
ShippingLabelStatus	TypeAlias
ShippingLabelStatusenum	Variable
ShippingOption	TypeAlias
ShippingOptionenum	Variable
Snowball	Class
Snowball	Interface
SnowballCapacity	TypeAlias
SnowballCapacityenum	Variable
SnowballClient	Class
SnowballClientConfig	Interface
SnowballClientConfigType	TypeAlias
SnowballClientResolvedConfig	Interface
SnowballClientResolvedConfigType	TypeAlias
SnowballPaginationConfiguration	Interface
SnowballServiceException	Class
SnowballType	TypeAlias
SnowballTypeenum	Variable
SnowconeDeviceConfiguration	Interface
StorageUnit	TypeAlias
StorageUnitenum	Variable
TargetOnDeviceService	Interface
TaxDocuments	Interface
TGWOnDeviceServiceConfiguration	Interface
TransferOption	TypeAlias
TransferOptionenum	Variable
UnsupportedAddressException	Class
UpdateClusterCommand	Class
UpdateClusterCommandInput	Interface
UpdateClusterCommandOutput	Interface
UpdateClusterRequest	Interface
UpdateClusterResult	Interface
UpdateJobCommand	Class
UpdateJobCommandInput	Interface
UpdateJobCommandOutput	Interface
UpdateJobRequest	Interface
UpdateJobResult	Interface
UpdateJobShipmentStateCommand	Class
UpdateJobShipmentStateCommandInput	Interface
UpdateJobShipmentStateCommandOutput	Interface
UpdateJobShipmentStateRequest	Interface
UpdateJobShipmentStateResult	Interface
UpdateLongTermPricingCommand	Class
UpdateLongTermPricingCommandInput	Interface
UpdateLongTermPricingCommandOutput	Interface
UpdateLongTermPricingRequest	Interface
UpdateLongTermPricingResult	Interface
WirelessConnection	Interface

Getting Started

References

@aws-sdk/client-snowball

Description

Installation

Types

Table of Contents

Search