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

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.

Usage example

client = boto3.client("snowball")

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

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

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

Method definition

def cancel_cluster(
    self,
    *,
    ClusterId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

Method definition

def cancel_job(
    self,
    *,
    JobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

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

Method definition

def create_address(
    self,
    *,
    Address: AddressTypeDef,  # (1)
) -> CreateAddressResultTypeDef:  # (2)
    ...

1. See AddressTypeDef
2. See CreateAddressResultTypeDef

Usage example with kwargs

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

Method definition

def create_cluster(
    self,
    *,
    JobType: JobTypeType,  # (1)
    Resources: JobResourceTypeDef,  # (2)
    AddressId: str,
    RoleARN: str,
    SnowballType: SnowballTypeType,  # (3)
    ShippingOption: ShippingOptionType,  # (4)
    OnDeviceServiceConfiguration: OnDeviceServiceConfigurationTypeDef = ...,  # (5)
    Description: str = ...,
    KmsKeyARN: str = ...,
    Notification: NotificationTypeDef = ...,  # (6)
    ForwardingAddressId: str = ...,
    TaxDocuments: TaxDocumentsTypeDef = ...,  # (7)
    RemoteManagement: RemoteManagementType = ...,  # (8)
) -> CreateClusterResultTypeDef:  # (9)
    ...

1. See JobTypeType
2. See JobResourceTypeDef
3. See SnowballTypeType
4. See ShippingOptionType
5. See OnDeviceServiceConfigurationTypeDef
6. See NotificationTypeDef
7. See TaxDocumentsTypeDef
8. See RemoteManagementType
9. See CreateClusterResultTypeDef

Usage example with kwargs

kwargs: CreateClusterRequestRequestTypeDef = {  # (1)
    "JobType": ...,
    "Resources": ...,
    "AddressId": ...,
    "RoleARN": ...,
    "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

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 = ...,
) -> CreateJobResultTypeDef:  # (11)
    ...

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 CreateJobResultTypeDef

Usage example with kwargs

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

Method definition

def create_long_term_pricing(
    self,
    *,
    LongTermPricingType: LongTermPricingTypeType,  # (1)
    IsLongTermPricingAutoRenew: bool = ...,
    SnowballType: SnowballTypeType = ...,  # (2)
) -> CreateLongTermPricingResultTypeDef:  # (3)
    ...

1. See LongTermPricingTypeType
2. See SnowballTypeType
3. See CreateLongTermPricingResultTypeDef

Usage example with kwargs

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

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

Method definition

def create_return_shipping_label(
    self,
    *,
    JobId: str,
    ShippingOption: ShippingOptionType = ...,  # (1)
) -> CreateReturnShippingLabelResultTypeDef:  # (2)
    ...

1. See ShippingOptionType
2. See CreateReturnShippingLabelResultTypeDef

Usage example with kwargs

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

Method definition

def describe_address(
    self,
    *,
    AddressId: str,
) -> DescribeAddressResultTypeDef:  # (1)
    ...

1. See DescribeAddressResultTypeDef

Usage example with kwargs

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

Method definition

def describe_addresses(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAddressesResultTypeDef:  # (1)
    ...

1. See DescribeAddressesResultTypeDef

Usage example with kwargs

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

Method definition

def describe_cluster(
    self,
    *,
    ClusterId: str,
) -> DescribeClusterResultTypeDef:  # (1)
    ...

1. See DescribeClusterResultTypeDef

Usage example with kwargs

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

Method definition

def describe_job(
    self,
    *,
    JobId: str,
) -> DescribeJobResultTypeDef:  # (1)
    ...

1. See DescribeJobResultTypeDef

Usage example with kwargs

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

Method definition

def describe_return_shipping_label(
    self,
    *,
    JobId: str,
) -> DescribeReturnShippingLabelResultTypeDef:  # (1)
    ...

1. See DescribeReturnShippingLabelResultTypeDef

Usage example with kwargs

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

parent.describe_return_shipping_label(**kwargs)

1. See DescribeReturnShippingLabelRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

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

Method definition

def get_job_manifest(
    self,
    *,
    JobId: str,
) -> GetJobManifestResultTypeDef:  # (1)
    ...

1. See GetJobManifestResultTypeDef

Usage example with kwargs

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

Method definition

def get_job_unlock_code(
    self,
    *,
    JobId: str,
) -> GetJobUnlockCodeResultTypeDef:  # (1)
    ...

1. See GetJobUnlockCodeResultTypeDef

Usage example with kwargs

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

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

Method definition

def get_software_updates(
    self,
    *,
    JobId: str,
) -> GetSoftwareUpdatesResultTypeDef:  # (1)
    ...

1. See GetSoftwareUpdatesResultTypeDef

Usage example with kwargs

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

Method definition

def list_cluster_jobs(
    self,
    *,
    ClusterId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClusterJobsResultTypeDef:  # (1)
    ...

1. See ListClusterJobsResultTypeDef

Usage example with kwargs

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

Method definition

def list_clusters(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersResultTypeDef:  # (1)
    ...

1. See ListClustersResultTypeDef

Usage example with kwargs

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

parent.list_clusters(**kwargs)

1. See ListClustersRequestRequestTypeDef

list_compatible_images

This action returns a list of the different Amazon EC2 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

Method definition

def list_compatible_images(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCompatibleImagesResultTypeDef:  # (1)
    ...

1. See ListCompatibleImagesResultTypeDef

Usage example with kwargs

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

Method definition

def list_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListJobsResultTypeDef:  # (1)
    ...

1. See ListJobsResultTypeDef

Usage example with kwargs

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

Method definition

def list_long_term_pricing(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLongTermPricingResultTypeDef:  # (1)
    ...

1. See ListLongTermPricingResultTypeDef

Usage example with kwargs

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

parent.list_long_term_pricing(**kwargs)

1. See ListLongTermPricingRequestRequestTypeDef

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

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

Usage example with kwargs

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

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

Usage example with kwargs

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

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 = ...,
) -> Dict[str, Any]:
    ...

1. See NotificationTypeDef
2. See JobResourceTypeDef
3. See OnDeviceServiceConfigurationTypeDef
4. See ShippingOptionType
5. See SnowballCapacityType

Usage example with kwargs

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

Method definition

def update_job_shipment_state(
    self,
    *,
    JobId: str,
    ShipmentState: ShipmentStateType,  # (1)
) -> Dict[str, Any]:
    ...

1. See ShipmentStateType

Usage example with kwargs

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

Method definition

def update_long_term_pricing(
    self,
    *,
    LongTermPricingId: str,
    ReplacementJob: str = ...,
    IsLongTermPricingAutoRenew: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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.

• client.get_paginator("describe_addresses") -> DescribeAddressesPaginator
• client.get_paginator("list_cluster_jobs") -> ListClusterJobsPaginator
• client.get_paginator("list_clusters") -> ListClustersPaginator
• client.get_paginator("list_compatible_images") -> ListCompatibleImagesPaginator
• client.get_paginator("list_jobs") -> ListJobsPaginator
• client.get_paginator("list_long_term_pricing") -> ListLongTermPricingPaginator