AWS Snowball User Guide
API Endpoint
Job Management API Reference for
AWS Snowball
The job management API for AWS Snowball is a network protocol based on HTTP (RFC 2616). For more
information on this RFC, see HTTP (RFC 2616). on the IETF website. For each call to the job management
API, you make an HTTP request to the region-specific job management API endpoint for the AWS Region
where you want to manage jobs. The API uses JSON (RFC 4627) documents for HTTP request/response
bodies.
Note
API calls made within the US regions for listing jobs or describing addresses will return all jobs
or addresses within the US for that account, respectively.
The job management API for Snowball is an RPC model, in which there is a fixed set of operations and
the syntax for each operation is known to clients without any prior interaction. Following, you can find a
description of each API operation using an abstract RPC notation, with an operation name that does not
appear on the wire. For each operation, the topic specifies the mapping to HTTP request elements.
The specific job management operation to which a given request maps is determined by a combination
of the request's method (GET, PUT, POST, or DELETE) and which of the various patterns its Request-URI
matches. If the operation is PUT or POST, Snowball extracts call arguments from the Request-URI path
segment, query parameters, and the JSON object in the request body.
Although the operation name, such as CreateJob, doesn't appear on the wire, these operation names
are meaningful in AWS Identity and Access Management (IAM) policies. The operation name is also used
to name commands in command-line tools and elements of the AWS SDK APIs. For example, the AWS
Command Line Interface (AWS CLI) command create-job maps to the CreateJob operation. The
operation name also appears in CloudTrail logs for Snowball API calls.
For information on installing and setting up the AWS CLI, including specifying what regions you want to
make AWS CLI calls against, see the AWS Command Line Interface User Guide.
Note
The job management API provides programmatic access to the same functionality available in
the AWS Snowball Management Console, that is to create and manage jobs for Snowball. To
actually transfer data locally with a Snowball appliance, you'll need to use the Snowball client
or the Amazon S3 Adapter for Snowball. For more information, see Transferring Data with a
Snowball (p. 51).
API Endpoint
The API endpoint is the Domain Name Service (DNS) name used as a host in the HTTP URI for the API
calls. These API endpoints are region-specific and take the following form.
snowball.aws-region.amazonaws.com
For example, the Snowball API endpoint for the US West (Oregon) Region is the following.
snowball.us-west-2.amazonaws.com
102
To Next Page
Loading...