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#

Check if an operation can be paginated.

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:
    ...

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

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: Union[JobResourceTypeDef, JobResourceOutputTypeDef] = ...,  # (4)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (5)
    Description: str = ...,
    KmsKeyARN: str = ...,
    RoleARN: str = ...,
    Notification: Union[NotificationTypeDef, NotificationOutputTypeDef] = ...,  # (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 JobResourceOutputTypeDef
  5. See OnDeviceServiceConfigurationTypeDef
  6. See NotificationTypeDef NotificationOutputTypeDef
  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: Union[JobResourceTypeDef, JobResourceOutputTypeDef] = ...,  # (2)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (3)
    Description: str = ...,
    AddressId: str = ...,
    KmsKeyARN: str = ...,
    RoleARN: str = ...,
    SnowballCapacityPreference: SnowballCapacityType = ...,  # (4)
    ShippingOption: ShippingOptionType = ...,  # (5)
    Notification: Union[NotificationTypeDef, NotificationOutputTypeDef] = ...,  # (6)
    ClusterId: str = ...,
    SnowballType: SnowballTypeType = ...,  # (7)
    ForwardingAddressId: str = ...,
    TaxDocuments: TaxDocumentsTypeDef = ...,  # (8)
    DeviceConfiguration: DeviceConfigurationTypeDef = ...,  # (9)
    RemoteManagement: RemoteManagementType = ...,  # (10)
    LongTermPricingId: str = ...,
    ImpactLevel: ImpactLevelType = ...,  # (11)
    PickupDetails: Union[PickupDetailsTypeDef, PickupDetailsOutputTypeDef] = ...,  # (12)
) -> CreateJobResultTypeDef:  # (13)
    ...
  1. See JobTypeType
  2. See JobResourceTypeDef JobResourceOutputTypeDef
  3. See OnDeviceServiceConfigurationTypeDef
  4. See SnowballCapacityType
  5. See ShippingOptionType
  6. See NotificationTypeDef NotificationOutputTypeDef
  7. See SnowballTypeType
  8. See TaxDocumentsTypeDef
  9. See DeviceConfigurationTypeDef
  10. See RemoteManagementType
  11. See ImpactLevelType
  12. See PickupDetailsTypeDef PickupDetailsOutputTypeDef
  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.