Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 4.17 KB

README.md

File metadata and controls

90 lines (63 loc) · 4.17 KB
Raw

AWS SDK for Rust code examples for Snowball

Purpose

These examples demonstrate how to perform several AWS Snowball (Snowball) operations using the developer preview version of the AWS SDK for Rust.

Snowball uses physical storage devices to transfer large amounts of data between Amazon Simple Storage Service (Amazon S3) and your onsite data storage location at faster-than-internet speeds.

Code examples

⚠ Important

  • We recommend that you grant this code least privilege, or at most the minimum permissions required to perform the task. For more information, see Grant Least Privilege in the AWS Identity and Access Management User Guide.
  • This code has not been tested in all AWS Regions. Some AWS services are available only in specific Regions.
  • Running this code might result in charges to your AWS account.

Running the code examples

Prerequisites

You must have an AWS account, and have configured your default credentials and AWS Region as described in https://github.com/awslabs/aws-sdk-rust.

create-address

This example creates an AWS Snowball address.

cargo run --bin create-address -- --city CITY --company COMPANY --country COUNTRY --landmark LANDMARK --name NAME --phone-number PHONE-NUMBER --postal-code POSTAL-CODE --prefecture-or-district PREFECTURE-OR-DISTRICT --state STATE --street1 STREET1 --street2 STREET2 --street3 STREET3 [-r REGION] [-v]

  • CITY is the required city portion of the address.
  • COMPANY is the company portion of the address.
  • COUNTRY is the required country portion of the address.
  • LANDMARK is the landmark portion of the address.
  • NAME is the required name portion of the address.
  • PHONE-NUMBER is the required phone number portion of the address.
  • POSTAL-CODE is the required postal code (zip in USA) portion of the address.
  • PREFECTURE-OR-DISTRICT is the prefecture or district portion of the address.
  • STATE is the required state portion of the address. It must be (two is best) upper-case letters.
  • STREET1 is the required first street portion of the address.
  • STREET2 is the second street portion of the address.
  • STREET3 is the third street portion of the address.
  • REGION is the AWS Region in which the client is created. If not supplied, uses the value of the AWS_REGION environment variable. If the environment variable is not set, defaults to us-west-2.
  • -v displays additional information.

describe-addresses

This example lists your AWS Snowball addresses.

cargo run --bin describe-addresses -- [-r REGION] [-v]

  • REGION is the AWS Region in which the client is created. If not supplied, uses the value of the AWS_REGION environment variable. If the environment variable is not set, defaults to us-west-2.
  • -v displays additional information.

list-jobs

This example lists your AWS Snowball jobs.

cargo run --bin list-jobs -- [-r REGION] [-v]

  • REGION is the AWS Region in which the client is created. If not supplied, uses the value of the AWS_REGION environment variable. If the environment variable is not set, defaults to us-west-2.
  • -v displays additional information.

Resources

Contributing

To propose a new code example to the AWS documentation team, see CONTRIBUTING.md. The team prefers to create code examples that show broad scenarios rather than individual API calls.

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0