Skip to content

SnowballClient#

Index > Snowball > SnowballClient

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

SnowballClient#

Type annotations and code completion for boto3.client("snowball"). boto3 documentation

# SnowballClient usage example

from boto3.session import Session
from mypy_boto3_snowball.client import SnowballClient

def get_snowball_client() -> SnowballClient:
    return Session().client("snowball")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("snowball").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("snowball")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ClusterLimitExceededException,
    client.exceptions.ConflictException,
    client.exceptions.Ec2RequestFailedException,
    client.exceptions.InvalidAddressException,
    client.exceptions.InvalidInputCombinationException,
    client.exceptions.InvalidJobStateException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidResourceException,
    client.exceptions.KMSRequestFailedException,
    client.exceptions.ReturnShippingLabelAlreadyExistsException,
    client.exceptions.UnsupportedAddressException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_snowball.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("snowball").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("snowball").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_cluster#

Cancels a cluster job.

Type annotations and code completion for boto3.client("snowball").cancel_cluster method. boto3 documentation

# cancel_cluster method definition

def cancel_cluster(
    self,
    *,
    ClusterId: str,
) -> dict[str, Any]:
    ...
# cancel_cluster method usage example with argument unpacking

kwargs: CancelClusterRequestRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.cancel_cluster(**kwargs)
  1. See CancelClusterRequestRequestTypeDef

cancel_job#

Cancels the specified job.

Type annotations and code completion for boto3.client("snowball").cancel_job method. boto3 documentation

# cancel_job method definition

def cancel_job(
    self,
    *,
    JobId: str,
) -> dict[str, Any]:
    ...
# cancel_job method usage example with argument unpacking

kwargs: CancelJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.cancel_job(**kwargs)
  1. See CancelJobRequestRequestTypeDef

create_address#

Creates an address for a Snow device to be shipped to.

Type annotations and code completion for boto3.client("snowball").create_address method. boto3 documentation

# create_address method definition

def create_address(
    self,
    *,
    Address: AddressTypeDef,  # (1)
) -> CreateAddressResultTypeDef:  # (2)
    ...
  1. See AddressTypeDef
  2. See CreateAddressResultTypeDef 
# create_address method usage example with argument unpacking

kwargs: CreateAddressRequestRequestTypeDef = {  # (1)
    "Address": ...,
}

parent.create_address(**kwargs)
  1. See CreateAddressRequestRequestTypeDef

create_cluster#

Creates an empty cluster.

Type annotations and code completion for boto3.client("snowball").create_cluster method. boto3 documentation

# create_cluster method definition

def create_cluster(
    self,
    *,
    JobType: JobTypeType,  # (1)
    AddressId: str,
    SnowballType: SnowballTypeType,  # (2)
    ShippingOption: ShippingOptionType,  # (3)
    Resources: JobResourceTypeDef = ...,  # (4)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (5)
    Description: str = ...,
    KmsKeyARN: str = ...,
    RoleARN: str = ...,
    Notification: NotificationTypeDef = ...,  # (6)
    ForwardingAddressId: str = ...,
    TaxDocuments: TaxDocumentsTypeDef = ...,  # (7)
    RemoteManagement: RemoteManagementType = ...,  # (8)
    InitialClusterSize: int = ...,
    ForceCreateJobs: bool = ...,
    LongTermPricingIds: Sequence[str] = ...,
    SnowballCapacityPreference: SnowballCapacityType = ...,  # (9)
) -> CreateClusterResultTypeDef:  # (10)
    ...
  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
  10. See CreateClusterResultTypeDef 
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "JobType": ...,
    "AddressId": ...,
    "SnowballType": ...,
    "ShippingOption": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterRequestRequestTypeDef

create_job#

Creates a job to import or export data between Amazon S3 and your on-premises data center.

Type annotations and code completion for boto3.client("snowball").create_job method. boto3 documentation

# create_job method definition

def create_job(
    self,
    *,
    JobType: JobTypeType = ...,  # (1)
    Resources: JobResourceTypeDef = ...,  # (2)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (3)
    Description: str = ...,
    AddressId: str = ...,
    KmsKeyARN: str = ...,
    RoleARN: str = ...,
    SnowballCapacityPreference: SnowballCapacityType = ...,  # (4)
    ShippingOption: ShippingOptionType = ...,  # (5)
    Notification: NotificationTypeDef = ...,  # (6)
    ClusterId: str = ...,
    SnowballType: SnowballTypeType = ...,  # (7)
    ForwardingAddressId: str = ...,
    TaxDocuments: TaxDocumentsTypeDef = ...,  # (8)
    DeviceConfiguration: DeviceConfigurationTypeDef = ...,  # (9)
    RemoteManagement: RemoteManagementType = ...,  # (10)
    LongTermPricingId: str = ...,
    ImpactLevel: ImpactLevelType = ...,  # (11)
    PickupDetails: PickupDetailsTypeDef = ...,  # (12)
) -> CreateJobResultTypeDef:  # (13)
    ...
  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
  13. See CreateJobResultTypeDef 
# create_job method usage example with argument unpacking

kwargs: CreateJobRequestRequestTypeDef = {  # (1)
    "JobType": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobRequestRequestTypeDef

create_long_term_pricing#

Creates a job with the long-term usage option for a device.

Type annotations and code completion for boto3.client("snowball").create_long_term_pricing method. boto3 documentation

# create_long_term_pricing method definition

def create_long_term_pricing(
    self,
    *,
    LongTermPricingType: LongTermPricingTypeType,  # (1)
    SnowballType: SnowballTypeType,  # (2)
    IsLongTermPricingAutoRenew: bool = ...,
) -> CreateLongTermPricingResultTypeDef:  # (3)
    ...
  1. See LongTermPricingTypeType
  2. See SnowballTypeType
  3. See CreateLongTermPricingResultTypeDef 
# create_long_term_pricing method usage example with argument unpacking

kwargs: CreateLongTermPricingRequestRequestTypeDef = {  # (1)
    "LongTermPricingType": ...,
    "SnowballType": ...,
}

parent.create_long_term_pricing(**kwargs)
  1. See CreateLongTermPricingRequestRequestTypeDef

create_return_shipping_label#

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

Type annotations and code completion for boto3.client("snowball").create_return_shipping_label method. boto3 documentation

# create_return_shipping_label method definition

def create_return_shipping_label(
    self,
    *,
    JobId: str,
    ShippingOption: ShippingOptionType = ...,  # (1)
) -> CreateReturnShippingLabelResultTypeDef:  # (2)
    ...
  1. See ShippingOptionType
  2. See CreateReturnShippingLabelResultTypeDef 
# create_return_shipping_label method usage example with argument unpacking

kwargs: CreateReturnShippingLabelRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.create_return_shipping_label(**kwargs)
  1. See CreateReturnShippingLabelRequestRequestTypeDef

describe_address#

Takes an AddressId and returns specific details about that address in the form of an Address object.

Type annotations and code completion for boto3.client("snowball").describe_address method. boto3 documentation

# describe_address method definition

def describe_address(
    self,
    *,
    AddressId: str,
) -> DescribeAddressResultTypeDef:  # (1)
    ...
  1. See DescribeAddressResultTypeDef 
# describe_address method usage example with argument unpacking

kwargs: DescribeAddressRequestRequestTypeDef = {  # (1)
    "AddressId": ...,
}

parent.describe_address(**kwargs)
  1. See DescribeAddressRequestRequestTypeDef

describe_addresses#

Returns a specified number of ADDRESS objects.

Type annotations and code completion for boto3.client("snowball").describe_addresses method. boto3 documentation

# describe_addresses method definition

def describe_addresses(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAddressesResultTypeDef:  # (1)
    ...
  1. See DescribeAddressesResultTypeDef 
# describe_addresses method usage example with argument unpacking

kwargs: DescribeAddressesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_addresses(**kwargs)
  1. See DescribeAddressesRequestRequestTypeDef

describe_cluster#

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Type annotations and code completion for boto3.client("snowball").describe_cluster method. boto3 documentation

# describe_cluster method definition

def describe_cluster(
    self,
    *,
    ClusterId: str,
) -> DescribeClusterResultTypeDef:  # (1)
    ...
  1. See DescribeClusterResultTypeDef 
# describe_cluster method usage example with argument unpacking

kwargs: DescribeClusterRequestRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.describe_cluster(**kwargs)
  1. See DescribeClusterRequestRequestTypeDef

describe_job#

Returns information about a specific job including shipping information, job status, and other important metadata.

Type annotations and code completion for boto3.client("snowball").describe_job method. boto3 documentation

# describe_job method definition

def describe_job(
    self,
    *,
    JobId: str,
) -> DescribeJobResultTypeDef:  # (1)
    ...
  1. See DescribeJobResultTypeDef 
# describe_job method usage example with argument unpacking

kwargs: DescribeJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_job(**kwargs)
  1. See DescribeJobRequestRequestTypeDef

describe_return_shipping_label#

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

Type annotations and code completion for boto3.client("snowball").describe_return_shipping_label method. boto3 documentation

# describe_return_shipping_label method definition

def describe_return_shipping_label(
    self,
    *,
    JobId: str,
) -> DescribeReturnShippingLabelResultTypeDef:  # (1)
    ...
  1. See DescribeReturnShippingLabelResultTypeDef 
# describe_return_shipping_label method usage example with argument unpacking

kwargs: DescribeReturnShippingLabelRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.describe_return_shipping_label(**kwargs)
  1. See DescribeReturnShippingLabelRequestRequestTypeDef

get_job_manifest#

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value.

Type annotations and code completion for boto3.client("snowball").get_job_manifest method. boto3 documentation

# get_job_manifest method definition

def get_job_manifest(
    self,
    *,
    JobId: str,
) -> GetJobManifestResultTypeDef:  # (1)
    ...
  1. See GetJobManifestResultTypeDef 
# get_job_manifest method usage example with argument unpacking

kwargs: GetJobManifestRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_job_manifest(**kwargs)
  1. See GetJobManifestRequestRequestTypeDef

get_job_unlock_code#

Returns the UnlockCode code value for the specified job.

Type annotations and code completion for boto3.client("snowball").get_job_unlock_code method. boto3 documentation

# get_job_unlock_code method definition

def get_job_unlock_code(
    self,
    *,
    JobId: str,
) -> GetJobUnlockCodeResultTypeDef:  # (1)
    ...
  1. See GetJobUnlockCodeResultTypeDef 
# get_job_unlock_code method usage example with argument unpacking

kwargs: GetJobUnlockCodeRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_job_unlock_code(**kwargs)
  1. See GetJobUnlockCodeRequestRequestTypeDef

get_snowball_usage#

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

Type annotations and code completion for boto3.client("snowball").get_snowball_usage method. boto3 documentation

# get_snowball_usage method definition

def get_snowball_usage(
    self,
) -> GetSnowballUsageResultTypeDef:  # (1)
    ...
  1. See GetSnowballUsageResultTypeDef

get_software_updates#

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

Type annotations and code completion for boto3.client("snowball").get_software_updates method. boto3 documentation

# get_software_updates method definition

def get_software_updates(
    self,
    *,
    JobId: str,
) -> GetSoftwareUpdatesResultTypeDef:  # (1)
    ...
  1. See GetSoftwareUpdatesResultTypeDef 
# get_software_updates method usage example with argument unpacking

kwargs: GetSoftwareUpdatesRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_software_updates(**kwargs)
  1. See GetSoftwareUpdatesRequestRequestTypeDef

list_cluster_jobs#

Returns an array of JobListEntry objects of the specified length.

Type annotations and code completion for boto3.client("snowball").list_cluster_jobs method. boto3 documentation

# list_cluster_jobs method definition

def list_cluster_jobs(
    self,
    *,
    ClusterId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClusterJobsResultTypeDef:  # (1)
    ...
  1. See ListClusterJobsResultTypeDef 
# list_cluster_jobs method usage example with argument unpacking

kwargs: ListClusterJobsRequestRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_cluster_jobs(**kwargs)
  1. See ListClusterJobsRequestRequestTypeDef

list_clusters#

Returns an array of ClusterListEntry objects of the specified length.

Type annotations and code completion for boto3.client("snowball").list_clusters method. boto3 documentation

# list_clusters method definition

def list_clusters(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersResultTypeDef:  # (1)
    ...
  1. See ListClustersResultTypeDef 
# list_clusters method usage example with argument unpacking

kwargs: ListClustersRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_clusters(**kwargs)
  1. See ListClustersRequestRequestTypeDef

list_compatible_images#

This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device.

Type annotations and code completion for boto3.client("snowball").list_compatible_images method. boto3 documentation

# list_compatible_images method definition

def list_compatible_images(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCompatibleImagesResultTypeDef:  # (1)
    ...
  1. See ListCompatibleImagesResultTypeDef 
# list_compatible_images method usage example with argument unpacking

kwargs: ListCompatibleImagesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_compatible_images(**kwargs)
  1. See ListCompatibleImagesRequestRequestTypeDef

list_jobs#

Returns an array of JobListEntry objects of the specified length.

Type annotations and code completion for boto3.client("snowball").list_jobs method. boto3 documentation

# list_jobs method definition

def list_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJobsResultTypeDef:  # (1)
    ...
  1. See ListJobsResultTypeDef 
# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_jobs(**kwargs)
  1. See ListJobsRequestRequestTypeDef

list_long_term_pricing#

Lists all long-term pricing types.

Type annotations and code completion for boto3.client("snowball").list_long_term_pricing method. boto3 documentation

# list_long_term_pricing method definition

def list_long_term_pricing(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLongTermPricingResultTypeDef:  # (1)
    ...
  1. See ListLongTermPricingResultTypeDef 
# list_long_term_pricing method usage example with argument unpacking

kwargs: ListLongTermPricingRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_long_term_pricing(**kwargs)
  1. See ListLongTermPricingRequestRequestTypeDef

list_pickup_locations#

A list of locations from which the customer can choose to pickup a device.

Type annotations and code completion for boto3.client("snowball").list_pickup_locations method. boto3 documentation

# list_pickup_locations method definition

def list_pickup_locations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPickupLocationsResultTypeDef:  # (1)
    ...
  1. See ListPickupLocationsResultTypeDef 
# list_pickup_locations method usage example with argument unpacking

kwargs: ListPickupLocationsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_pickup_locations(**kwargs)
  1. See ListPickupLocationsRequestRequestTypeDef

list_service_versions#

Lists all supported versions for Snow on-device services.

Type annotations and code completion for boto3.client("snowball").list_service_versions method. boto3 documentation

# list_service_versions method definition

def list_service_versions(
    self,
    *,
    ServiceName: ServiceNameType,  # (1)
    DependentServices: Sequence[DependentServiceTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListServiceVersionsResultTypeDef:  # (3)
    ...
  1. See ServiceNameType
  2. See DependentServiceTypeDef
  3. See ListServiceVersionsResultTypeDef 
# list_service_versions method usage example with argument unpacking

kwargs: ListServiceVersionsRequestRequestTypeDef = {  # (1)
    "ServiceName": ...,
}

parent.list_service_versions(**kwargs)
  1. See ListServiceVersionsRequestRequestTypeDef

update_cluster#

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster.

Type annotations and code completion for boto3.client("snowball").update_cluster method. boto3 documentation

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterId: str,
    RoleARN: str = ...,
    Description: str = ...,
    Resources: JobResourceTypeDef = ...,  # (1)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (2)
    AddressId: str = ...,
    ShippingOption: ShippingOptionType = ...,  # (3)
    Notification: NotificationTypeDef = ...,  # (4)
    ForwardingAddressId: str = ...,
) -> dict[str, Any]:
    ...
  1. See JobResourceTypeDef
  2. See OnDeviceServiceConfigurationTypeDef
  3. See ShippingOptionType
  4. See NotificationTypeDef 
# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.update_cluster(**kwargs)
  1. See UpdateClusterRequestRequestTypeDef

update_job#

While a job's JobState value is New, you can update some of the information associated with a job.

Type annotations and code completion for boto3.client("snowball").update_job method. boto3 documentation

# update_job method definition

def update_job(
    self,
    *,
    JobId: str,
    RoleARN: str = ...,
    Notification: NotificationTypeDef = ...,  # (1)
    Resources: JobResourceTypeDef = ...,  # (2)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (3)
    AddressId: str = ...,
    ShippingOption: ShippingOptionType = ...,  # (4)
    Description: str = ...,
    SnowballCapacityPreference: SnowballCapacityType = ...,  # (5)
    ForwardingAddressId: str = ...,
    PickupDetails: PickupDetailsTypeDef = ...,  # (6)
) -> dict[str, Any]:
    ...
  1. See NotificationTypeDef
  2. See JobResourceTypeDef
  3. See OnDeviceServiceConfigurationTypeDef
  4. See ShippingOptionType
  5. See SnowballCapacityType
  6. See PickupDetailsTypeDef 
# update_job method usage example with argument unpacking

kwargs: UpdateJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.update_job(**kwargs)
  1. See UpdateJobRequestRequestTypeDef

update_job_shipment_state#

Updates the state when a shipment state changes to a different state.

Type annotations and code completion for boto3.client("snowball").update_job_shipment_state method. boto3 documentation

# update_job_shipment_state method definition

def update_job_shipment_state(
    self,
    *,
    JobId: str,
    ShipmentState: ShipmentStateType,  # (1)
) -> dict[str, Any]:
    ...
  1. See ShipmentStateType 
# update_job_shipment_state method usage example with argument unpacking

kwargs: UpdateJobShipmentStateRequestRequestTypeDef = {  # (1)
    "JobId": ...,
    "ShipmentState": ...,
}

parent.update_job_shipment_state(**kwargs)
  1. See UpdateJobShipmentStateRequestRequestTypeDef

update_long_term_pricing#

Updates the long-term pricing type.

Type annotations and code completion for boto3.client("snowball").update_long_term_pricing method. boto3 documentation

# update_long_term_pricing method definition

def update_long_term_pricing(
    self,
    *,
    LongTermPricingId: str,
    ReplacementJob: str = ...,
    IsLongTermPricingAutoRenew: bool = ...,
) -> dict[str, Any]:
    ...
# update_long_term_pricing method usage example with argument unpacking

kwargs: UpdateLongTermPricingRequestRequestTypeDef = {  # (1)
    "LongTermPricingId": ...,
}

parent.update_long_term_pricing(**kwargs)
  1. See UpdateLongTermPricingRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("snowball").get_paginator method with overloads.