Class: Aws::Snowball::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Snowball::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb
Overview
An API client for Snowball. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Snowball::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_cluster(params = {}) ⇒ Struct
Cancels a cluster job.
-
#cancel_job(params = {}) ⇒ Struct
Cancels the specified job.
-
#create_address(params = {}) ⇒ Types::CreateAddressResult
Creates an address for a Snow device to be shipped to.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResult
Creates an empty cluster.
-
#create_job(params = {}) ⇒ Types::CreateJobResult
Creates a job to import or export data between Amazon S3 and your on-premises data center.
-
#create_long_term_pricing(params = {}) ⇒ Types::CreateLongTermPricingResult
Creates a job with the long-term usage option for a device.
-
#create_return_shipping_label(params = {}) ⇒ Types::CreateReturnShippingLabelResult
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
-
#describe_address(params = {}) ⇒ Types::DescribeAddressResult
Takes an
AddressId
and returns specific details about that address in the form of anAddress
object. -
#describe_addresses(params = {}) ⇒ Types::DescribeAddressesResult
Returns a specified number of
ADDRESS
objects. -
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResult
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
-
#describe_job(params = {}) ⇒ Types::DescribeJobResult
Returns information about a specific job including shipping information, job status, and other important metadata.
-
#describe_return_shipping_label(params = {}) ⇒ Types::DescribeReturnShippingLabelResult
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
-
#get_job_manifest(params = {}) ⇒ Types::GetJobManifestResult
Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value. -
#get_job_unlock_code(params = {}) ⇒ Types::GetJobUnlockCodeResult
Returns the
UnlockCode
code value for the specified job. -
#get_snowball_usage(params = {}) ⇒ Types::GetSnowballUsageResult
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
-
#get_software_updates(params = {}) ⇒ Types::GetSoftwareUpdatesResult
Returns an Amazon S3 presigned URL for an update file associated with a specified
JobId
. -
#list_cluster_jobs(params = {}) ⇒ Types::ListClusterJobsResult
Returns an array of
JobListEntry
objects of the specified length. -
#list_clusters(params = {}) ⇒ Types::ListClustersResult
Returns an array of
ClusterListEntry
objects of the specified length. -
#list_compatible_images(params = {}) ⇒ Types::ListCompatibleImagesResult
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.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Returns an array of
JobListEntry
objects of the specified length. -
#list_long_term_pricing(params = {}) ⇒ Types::ListLongTermPricingResult
Lists all long-term pricing types.
-
#update_cluster(params = {}) ⇒ Struct
While a cluster's
ClusterState
value is in theAwaitingQuorum
state, you can update some of the information associated with a cluster. -
#update_job(params = {}) ⇒ Struct
While a job's
JobState
value isNew
, you can update some of the information associated with a job. -
#update_job_shipment_state(params = {}) ⇒ Struct
Updates the state when a shipment state changes to a different state.
-
#update_long_term_pricing(params = {}) ⇒ Struct
Updates the long-term pricing type.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#cancel_cluster(params = {}) ⇒ Struct
Cancels a cluster job. You can only cancel a cluster job while it's
in the AwaitingQuorum
status. You'll have at least an hour after
creating a cluster job to cancel it.
393 394 395 396 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 393 def cancel_cluster(params = {}, = {}) req = build_request(:cancel_cluster, params) req.send_request() end |
#cancel_job(params = {}) ⇒ Struct
Cancels the specified job. You can only cancel a job before its
JobState
value changes to PreparingAppliance
. Requesting the
ListJobs
or DescribeJob
action returns a job's JobState
as part
of the response element data returned.
428 429 430 431 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 428 def cancel_job(params = {}, = {}) req = build_request(:cancel_job, params) req.send_request() end |
#create_address(params = {}) ⇒ Types::CreateAddressResult
Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.
500 501 502 503 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 500 def create_address(params = {}, = {}) req = build_request(:create_address, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResult
Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.
734 735 736 737 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 734 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResult
Creates a job to import or export data between Amazon S3 and your
on-premises data center. Your Amazon Web Services account must have
the right trust policies and permissions in place to create a job for
a Snow device. If you're creating a job for a node in a cluster, you
only need to provide the clusterId
value; the other job attributes
are inherited from the cluster.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family Devices and their capacities.
Snow Family device type: SNC1_SSD
Capacity: T14
Description: Snowcone
Snow Family device type: SNC1_HDD
Capacity: T8
Description: Snowcone
Device type: EDGE_S
Capacity: T98
Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
Capacity: T42
Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
Capacity: T42
Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
Capacity: T100
Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: STANDARD
Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1099 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_long_term_pricing(params = {}) ⇒ Types::CreateLongTermPricingResult
Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1140 def create_long_term_pricing(params = {}, = {}) req = build_request(:create_long_term_pricing, params) req.send_request() end |
#create_return_shipping_label(params = {}) ⇒ Types::CreateReturnShippingLabelResult
Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1177 def create_return_shipping_label(params = {}, = {}) req = build_request(:create_return_shipping_label, params) req.send_request() end |
#describe_address(params = {}) ⇒ Types::DescribeAddressResult
Takes an AddressId
and returns specific details about that address
in the form of an Address
object.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1243 def describe_address(params = {}, = {}) req = build_request(:describe_address, params) req.send_request() end |
#describe_addresses(params = {}) ⇒ Types::DescribeAddressesResult
Returns a specified number of ADDRESS
objects. Calling this API in
one of the US regions will return addresses from the list of all
addresses associated with this account in all US regions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1324 def describe_addresses(params = {}, = {}) req = build_request(:describe_addresses, params) req.send_request() end |
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResult
Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1425 def describe_cluster(params = {}, = {}) req = build_request(:describe_cluster, params) req.send_request() end |
#describe_job(params = {}) ⇒ Types::DescribeJobResult
Returns information about a specific job including shipping information, job status, and other important metadata.
1598 1599 1600 1601 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1598 def describe_job(params = {}, = {}) req = build_request(:describe_job, params) req.send_request() end |
#describe_return_shipping_label(params = {}) ⇒ Types::DescribeReturnShippingLabelResult
Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
1632 1633 1634 1635 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1632 def describe_return_shipping_label(params = {}, = {}) req = build_request(:describe_return_shipping_label, params) req.send_request() end |
#get_job_manifest(params = {}) ⇒ Types::GetJobManifestResult
Returns a link to an Amazon S3 presigned URL for the manifest file
associated with the specified JobId
value. You can access the
manifest file for up to 60 minutes after this request has been made.
To access the manifest file after 60 minutes have passed, you'll have
to make another call to the GetJobManifest
action.
The manifest is an encrypted file that you can download after your job
enters the WithCustomer
status. The manifest is decrypted by using
the UnlockCode
code value, when you pass both values to the Snow
device through the Snowball client when the client is started for the
first time.
As a best practice, we recommend that you don't save a copy of an
UnlockCode
value in the same location as the manifest file for that
job. Saving these separately helps prevent unauthorized parties from
gaining access to the Snow device associated with that job.
The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1702 def get_job_manifest(params = {}, = {}) req = build_request(:get_job_manifest, params) req.send_request() end |
#get_job_unlock_code(params = {}) ⇒ Types::GetJobUnlockCodeResult
Returns the UnlockCode
code value for the specified job. A
particular UnlockCode
value can be accessed for up to 360 days after
the associated job has been created.
The UnlockCode
value is a 29-character code with 25 alphanumeric
characters and 4 hyphens. This code is used to decrypt the manifest
file when it is passed along with the manifest to the Snow device
through the Snowball client when the client is started for the first
time.
As a best practice, we recommend that you don't save a copy of the
UnlockCode
in the same location as the manifest file for that job.
Saving these separately helps prevent unauthorized parties from
gaining access to the Snow device associated with that job.
1765 1766 1767 1768 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1765 def get_job_unlock_code(params = {}, = {}) req = build_request(:get_job_unlock_code, params) req.send_request() end |
#get_snowball_usage(params = {}) ⇒ Types::GetSnowballUsageResult
Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.
The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1808 def get_snowball_usage(params = {}, = {}) req = build_request(:get_snowball_usage, params) req.send_request() end |
#get_software_updates(params = {}) ⇒ Types::GetSoftwareUpdatesResult
Returns an Amazon S3 presigned URL for an update file associated with
a specified JobId
.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1838 def get_software_updates(params = {}, = {}) req = build_request(:get_software_updates, params) req.send_request() end |
#list_cluster_jobs(params = {}) ⇒ Types::ListClusterJobsResult
Returns an array of JobListEntry
objects of the specified length.
Each JobListEntry
object is for a job in the specified cluster and
contains a job's state, a job's ID, and other information.
1949 1950 1951 1952 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 1949 def list_cluster_jobs(params = {}, = {}) req = build_request(:list_cluster_jobs, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResult
Returns an array of ClusterListEntry
objects of the specified
length. Each ClusterListEntry
object contains a cluster's state, a
cluster's ID, and other important status information.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2012 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_compatible_images(params = {}) ⇒ Types::ListCompatibleImagesResult
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. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the Amazon Web Services Marketplace.
2056 2057 2058 2059 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2056 def list_compatible_images(params = {}, = {}) req = build_request(:list_compatible_images, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Returns an array of JobListEntry
objects of the specified length.
Each JobListEntry
object contains a job's state, a job's ID, and a
value that indicates whether the job is a job part, in the case of
export jobs. Calling this API action in one of the US regions will
return jobs from the list of all jobs associated with this account in
all US regions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2131 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_long_term_pricing(params = {}) ⇒ Types::ListLongTermPricingResult
Lists all long-term pricing types.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2177 def list_long_term_pricing(params = {}, = {}) req = build_request(:list_long_term_pricing, params) req.send_request() end |
#update_cluster(params = {}) ⇒ Struct
While a cluster's ClusterState
value is in the AwaitingQuorum
state, you can update some of the information associated with a
cluster. Once the cluster changes to a different job state, usually 60
minutes after the cluster being created, this action is no longer
available.
2305 2306 2307 2308 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2305 def update_cluster(params = {}, = {}) req = build_request(:update_cluster, params) req.send_request() end |
#update_job(params = {}) ⇒ Struct
While a job's JobState
value is New
, you can update some of the
information associated with a job. Once the job changes to a different
job state, usually within 60 minutes of the job being created, this
action is no longer available.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2444 def update_job(params = {}, = {}) req = build_request(:update_job, params) req.send_request() end |
#update_job_shipment_state(params = {}) ⇒ Struct
Updates the state when a shipment state changes to a different state.
2476 2477 2478 2479 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2476 def update_job_shipment_state(params = {}, = {}) req = build_request(:update_job_shipment_state, params) req.send_request() end |
#update_long_term_pricing(params = {}) ⇒ Struct
Updates the long-term pricing type.
2509 2510 2511 2512 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/client.rb', line 2509 def update_long_term_pricing(params = {}, = {}) req = build_request(:update_long_term_pricing, params) req.send_request() end |