Struct aws_sdk_snowball::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Import/Export Snowball
Client for invoking operations on Amazon Import/Export Snowball. Each operation on Amazon Import/Export Snowball is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_snowball::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_snowball::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CancelCluster
operation has
a Client::cancel_cluster
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.cancel_cluster()
.cluster_id("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn cancel_cluster(&self) -> CancelClusterFluentBuilder
pub fn cancel_cluster(&self) -> CancelClusterFluentBuilder
Constructs a fluent builder for the CancelCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
CancelClusterOutput
- On failure, responds with
SdkError<CancelClusterError>
source§impl Client
impl Client
sourcepub fn cancel_job(&self) -> CancelJobFluentBuilder
pub fn cancel_job(&self) -> CancelJobFluentBuilder
Constructs a fluent builder for the CancelJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
CancelJobOutput
- On failure, responds with
SdkError<CancelJobError>
source§impl Client
impl Client
sourcepub fn create_address(&self) -> CreateAddressFluentBuilder
pub fn create_address(&self) -> CreateAddressFluentBuilder
Constructs a fluent builder for the CreateAddress
operation.
- The fluent builder is configurable:
address(Address)
/set_address(Option<Address>)
:
required: trueThe address that you want the Snow device shipped to.
- On success, responds with
CreateAddressOutput
with field(s):address_id(Option<String>)
:The automatically generated ID for a specific address. You’ll use this ID when you create a job to specify which address you want the Snow device for that job shipped to.
- On failure, responds with
SdkError<CreateAddressError>
source§impl Client
impl Client
sourcepub fn create_cluster(&self) -> CreateClusterFluentBuilder
pub fn create_cluster(&self) -> CreateClusterFluentBuilder
Constructs a fluent builder for the CreateCluster
operation.
- The fluent builder is configurable:
job_type(JobType)
/set_job_type(Option<JobType>)
:
required: trueThe type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
resources(JobResource)
/set_resources(Option<JobResource>)
:
required: falseThe resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
on_device_service_configuration(OnDeviceServiceConfiguration)
/set_on_device_service_configuration(Option<OnDeviceServiceConfiguration>)
:
required: falseSpecifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAn optional description of this specific cluster, for example
Environmental Data Cluster-01
.address_id(impl Into<String>)
/set_address_id(Option<String>)
:
required: trueThe ID for the address that you want the cluster shipped to.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe
KmsKeyARN
value that you want to associate with this cluster.KmsKeyARN
values are created by using the CreateKey API action in Key Management Service (KMS).role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe
RoleARN
that you want to associate with this cluster.RoleArn
values are created by using the CreateRole API action in Identity and Access Management (IAM).snowball_type(SnowballType)
/set_snowball_type(Option<SnowballType>)
:
required: trueThe type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
shipping_option(ShippingOption)
/set_shipping_option(Option<ShippingOption>)
:
required: trueThe shipping speed for each node in this cluster. This speed doesn’t dictate how soon you’ll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
-
In India, Snow devices are delivered in one to seven days.
-
In the United States of America (US), you have access to one-day shipping and two-day shipping.
-
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
-
In India, Snow devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
-
notification(Notification)
/set_notification(Option<Notification>)
:
required: falseThe Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
forwarding_address_id(impl Into<String>)
/set_forwarding_address_id(Option<String>)
:
required: falseThe forwarding address ID for a cluster. This field is not supported in most regions.
tax_documents(TaxDocuments)
/set_tax_documents(Option<TaxDocuments>)
:
required: falseThe tax documents required in your Amazon Web Services Region.
remote_management(RemoteManagement)
/set_remote_management(Option<RemoteManagement>)
:
required: falseAllows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.initial_cluster_size(i32)
/set_initial_cluster_size(Option<i32>)
:
required: falseIf provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
force_create_jobs(bool)
/set_force_create_jobs(Option<bool>)
:
required: falseForce to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with
OnDeviceServiceConfiguration
.long_term_pricing_ids(impl Into<String>)
/set_long_term_pricing_ids(Option<Vec::<String>>)
:
required: falseLists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
snowball_capacity_preference(SnowballCapacity)
/set_snowball_capacity_preference(Option<SnowballCapacity>)
:
required: falseIf your job is being created in one of the US regions, you have the option of specifying what size Snow device you’d like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
- On success, responds with
CreateClusterOutput
with field(s):cluster_id(Option<String>)
:The automatically generated ID for a cluster.
job_list_entries(Option<Vec::<JobListEntry>>)
:List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.
- On failure, responds with
SdkError<CreateClusterError>
source§impl Client
impl Client
sourcepub fn create_job(&self) -> CreateJobFluentBuilder
pub fn create_job(&self) -> CreateJobFluentBuilder
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
job_type(JobType)
/set_job_type(Option<JobType>)
:
required: falseDefines the type of job that you’re creating.
resources(JobResource)
/set_resources(Option<JobResource>)
:
required: falseDefines the Amazon S3 buckets associated with this job.
With
IMPORT
jobs, you specify the bucket or buckets that your transferred data will be imported into.With
EXPORT
jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify aKeyRange
value. If you choose to export a range, you define the length of the range by providing either an inclusiveBeginMarker
value, an inclusiveEndMarker
value, or both. Ranges are UTF-8 binary sorted.on_device_service_configuration(OnDeviceServiceConfiguration)
/set_on_device_service_configuration(Option<OnDeviceServiceConfiguration>)
:
required: falseSpecifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseDefines an optional description of this specific job, for example
Important Photos 2016-08-11
.address_id(impl Into<String>)
/set_address_id(Option<String>)
:
required: falseThe ID for the address that you want the Snow device shipped to.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe
KmsKeyARN
that you want to associate with this job.KmsKeyARN
s are created using the CreateKey Key Management Service (KMS) API action.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe
RoleARN
that you want to associate with this job.RoleArn
s are created using the CreateRole Identity and Access Management (IAM) API action.snowball_capacity_preference(SnowballCapacity)
/set_snowball_capacity_preference(Option<SnowballCapacity>)
:
required: falseIf your job is being created in one of the US regions, you have the option of specifying what size Snow device you’d like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
shipping_option(ShippingOption)
/set_shipping_option(Option<ShippingOption>)
:
required: falseThe shipping speed for this job. This speed doesn’t dictate how soon you’ll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:
-
In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
-
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
-
In India, Snow devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
-
notification(Notification)
/set_notification(Option<Notification>)
:
required: falseDefines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: falseThe ID of a cluster. If you’re creating a job for a node in a cluster, you need to provide only this
clusterId
value. The other job attributes are inherited from the cluster.snowball_type(SnowballType)
/set_snowball_type(Option<SnowballType>)
:
required: falseThe type of Snow Family devices to use for this job.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is
EDGE
.For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.
For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
forwarding_address_id(impl Into<String>)
/set_forwarding_address_id(Option<String>)
:
required: falseThe forwarding address ID for a job. This field is not supported in most Regions.
tax_documents(TaxDocuments)
/set_tax_documents(Option<TaxDocuments>)
:
required: falseThe tax documents required in your Amazon Web Services Region.
device_configuration(DeviceConfiguration)
/set_device_configuration(Option<DeviceConfiguration>)
:
required: falseDefines the device configuration for an Snowcone job.
For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
remote_management(RemoteManagement)
/set_remote_management(Option<RemoteManagement>)
:
required: falseAllows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set toNOT_INSTALLED
, remote management will not be available on the device.long_term_pricing_id(impl Into<String>)
/set_long_term_pricing_id(Option<String>)
:
required: falseThe ID of the long-term pricing type for the device.
impact_level(ImpactLevel)
/set_impact_level(Option<ImpactLevel>)
:
required: falseThe highest impact level of data that will be stored or processed on the device, provided at job creation.
pickup_details(PickupDetails)
/set_pickup_details(Option<PickupDetails>)
:
required: falseInformation identifying the person picking up the device.
- On success, responds with
CreateJobOutput
with field(s):job_id(Option<String>)
:The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On failure, responds with
SdkError<CreateJobError>
source§impl Client
impl Client
sourcepub fn create_long_term_pricing(&self) -> CreateLongTermPricingFluentBuilder
pub fn create_long_term_pricing(&self) -> CreateLongTermPricingFluentBuilder
Constructs a fluent builder for the CreateLongTermPricing
operation.
- The fluent builder is configurable:
long_term_pricing_type(LongTermPricingType)
/set_long_term_pricing_type(Option<LongTermPricingType>)
:
required: trueThe type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
is_long_term_pricing_auto_renew(bool)
/set_is_long_term_pricing_auto_renew(Option<bool>)
:
required: falseSpecifies whether the current long-term pricing type for the device should be renewed.
snowball_type(SnowballType)
/set_snowball_type(Option<SnowballType>)
:
required: trueThe type of Snow Family devices to use for the long-term pricing job.
- On success, responds with
CreateLongTermPricingOutput
with field(s):long_term_pricing_id(Option<String>)
:The ID of the long-term pricing type for the device.
- On failure, responds with
SdkError<CreateLongTermPricingError>
source§impl Client
impl Client
sourcepub fn create_return_shipping_label(
&self
) -> CreateReturnShippingLabelFluentBuilder
pub fn create_return_shipping_label( &self ) -> CreateReturnShippingLabelFluentBuilder
Constructs a fluent builder for the CreateReturnShippingLabel
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID for a job that you want to create the return shipping label for; for example,
JID123e4567-e89b-12d3-a456-426655440000
.shipping_option(ShippingOption)
/set_shipping_option(Option<ShippingOption>)
:
required: falseThe shipping speed for a particular job. This speed doesn’t dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
- On success, responds with
CreateReturnShippingLabelOutput
with field(s):status(Option<ShippingLabelStatus>)
:The status information of the task on a Snow device that is being returned to Amazon Web Services.
- On failure, responds with
SdkError<CreateReturnShippingLabelError>
source§impl Client
impl Client
sourcepub fn describe_address(&self) -> DescribeAddressFluentBuilder
pub fn describe_address(&self) -> DescribeAddressFluentBuilder
Constructs a fluent builder for the DescribeAddress
operation.
- The fluent builder is configurable:
address_id(impl Into<String>)
/set_address_id(Option<String>)
:
required: trueThe automatically generated ID for a specific address.
- On success, responds with
DescribeAddressOutput
with field(s):address(Option<Address>)
:The address that you want the Snow device(s) associated with a specific job to be shipped to.
- On failure, responds with
SdkError<DescribeAddressError>
source§impl Client
impl Client
sourcepub fn describe_addresses(&self) -> DescribeAddressesFluentBuilder
pub fn describe_addresses(&self) -> DescribeAddressesFluentBuilder
Constructs a fluent builder for the DescribeAddresses
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of
ADDRESS
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of
ADDRESS
objects, you have the option of specifying a value forNextToken
as the starting point for your list of returned addresses.
- On success, responds with
DescribeAddressesOutput
with field(s):addresses(Option<Vec::<Address>>)
:The Snow device shipping addresses that were created for this account.
next_token(Option<String>)
:HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextDescribeAddresses
call, your list of returned addresses will start from this point in the array.
- On failure, responds with
SdkError<DescribeAddressesError>
source§impl Client
impl Client
sourcepub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder
Constructs a fluent builder for the DescribeCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe automatically generated ID for a cluster.
- On success, responds with
DescribeClusterOutput
with field(s):cluster_metadata(Option<ClusterMetadata>)
:Information about a specific cluster, including shipping information, cluster status, and other important metadata.
- On failure, responds with
SdkError<DescribeClusterError>
source§impl Client
impl Client
sourcepub fn describe_job(&self) -> DescribeJobFluentBuilder
pub fn describe_job(&self) -> DescribeJobFluentBuilder
Constructs a fluent builder for the DescribeJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
DescribeJobOutput
with field(s):job_metadata(Option<JobMetadata>)
:Information about a specific job, including shipping information, job status, and other important metadata.
sub_job_metadata(Option<Vec::<JobMetadata>>)
:Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
- On failure, responds with
SdkError<DescribeJobError>
source§impl Client
impl Client
sourcepub fn describe_return_shipping_label(
&self
) -> DescribeReturnShippingLabelFluentBuilder
pub fn describe_return_shipping_label( &self ) -> DescribeReturnShippingLabelFluentBuilder
Constructs a fluent builder for the DescribeReturnShippingLabel
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
DescribeReturnShippingLabelOutput
with field(s):status(Option<ShippingLabelStatus>)
:The status information of the task on a Snow device that is being returned to Amazon Web Services.
expiration_date(Option<DateTime>)
:The expiration date of the current return shipping label.
return_shipping_label_uri(Option<String>)
:The pre-signed Amazon S3 URI used to download the return shipping label.
- On failure, responds with
SdkError<DescribeReturnShippingLabelError>
source§impl Client
impl Client
sourcepub fn get_job_manifest(&self) -> GetJobManifestFluentBuilder
pub fn get_job_manifest(&self) -> GetJobManifestFluentBuilder
Constructs a fluent builder for the GetJobManifest
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
GetJobManifestOutput
with field(s):manifest_uri(Option<String>)
:The Amazon S3 presigned URL for the manifest file associated with the specified
JobId
value.
- On failure, responds with
SdkError<GetJobManifestError>
source§impl Client
impl Client
sourcepub fn get_job_unlock_code(&self) -> GetJobUnlockCodeFluentBuilder
pub fn get_job_unlock_code(&self) -> GetJobUnlockCodeFluentBuilder
Constructs a fluent builder for the GetJobUnlockCode
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID for the job that you want to get the
UnlockCode
value for, for exampleJID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
GetJobUnlockCodeOutput
with field(s):unlock_code(Option<String>)
:The
UnlockCode
value for the specified job. TheUnlockCode
value can be accessed for up to 360 days after the job has been created.
- On failure, responds with
SdkError<GetJobUnlockCodeError>
source§impl Client
impl Client
sourcepub fn get_snowball_usage(&self) -> GetSnowballUsageFluentBuilder
pub fn get_snowball_usage(&self) -> GetSnowballUsageFluentBuilder
Constructs a fluent builder for the GetSnowballUsage
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetSnowballUsageOutput
with field(s):snowball_limit(Option<i32>)
:The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one).
snowballs_in_use(Option<i32>)
:The number of Snow devices that this account is currently using.
- On failure, responds with
SdkError<GetSnowballUsageError>
source§impl Client
impl Client
sourcepub fn get_software_updates(&self) -> GetSoftwareUpdatesFluentBuilder
pub fn get_software_updates(&self) -> GetSoftwareUpdatesFluentBuilder
Constructs a fluent builder for the GetSoftwareUpdates
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID for a job that you want to get the software update file for, for example
JID123e4567-e89b-12d3-a456-426655440000
.
- On success, responds with
GetSoftwareUpdatesOutput
with field(s):updates_uri(Option<String>)
:The Amazon S3 presigned URL for the update file associated with the specified
JobId
value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you’ll have to make another call toGetSoftwareUpdates
.
- On failure, responds with
SdkError<GetSoftwareUpdatesError>
source§impl Client
impl Client
sourcepub fn list_cluster_jobs(&self) -> ListClusterJobsFluentBuilder
pub fn list_cluster_jobs(&self) -> ListClusterJobsFluentBuilder
Constructs a fluent builder for the ListClusterJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of
JobListEntry
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of
JobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
- On success, responds with
ListClusterJobsOutput
with field(s):job_list_entries(Option<Vec::<JobListEntry>>)
: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.next_token(Option<String>)
:HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextListClusterJobsResult
call, your list of returned jobs will start from this point in the array.
- On failure, responds with
SdkError<ListClusterJobsError>
source§impl Client
impl Client
sourcepub fn list_clusters(&self) -> ListClustersFluentBuilder
pub fn list_clusters(&self) -> ListClustersFluentBuilder
Constructs a fluent builder for the ListClusters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of
ClusterListEntry
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of
ClusterListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
- On success, responds with
ListClustersOutput
with field(s):cluster_list_entries(Option<Vec::<ClusterListEntry>>)
:Each
ClusterListEntry
object contains a cluster’s state, a cluster’s ID, and other important status information.next_token(Option<String>)
:HTTP requests are stateless. If you use the automatically generated
NextToken
value in your nextClusterListEntry
call, your list of returned clusters will start from this point in the array.
- On failure, responds with
SdkError<ListClustersError>
source§impl Client
impl Client
sourcepub fn list_compatible_images(&self) -> ListCompatibleImagesFluentBuilder
pub fn list_compatible_images(&self) -> ListCompatibleImagesFluentBuilder
Constructs a fluent builder for the ListCompatibleImages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of compatible images, you can specify a value for
NextToken
as the starting point for your list of returned images.
- On success, responds with
ListCompatibleImagesOutput
with field(s):compatible_images(Option<Vec::<CompatibleImage>>)
:A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.
next_token(Option<String>)
:Because HTTP requests are stateless, this is the starting point for your next list of returned images.
- On failure, responds with
SdkError<ListCompatibleImagesError>
source§impl Client
impl Client
sourcepub fn list_jobs(&self) -> ListJobsFluentBuilder
pub fn list_jobs(&self) -> ListJobsFluentBuilder
Constructs a fluent builder for the ListJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe number of
JobListEntry
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of
JobListEntry
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
- On success, responds with
ListJobsOutput
with field(s):job_list_entries(Option<Vec::<JobListEntry>>)
: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.next_token(Option<String>)
:HTTP requests are stateless. If you use this automatically generated
NextToken
value in your nextListJobs
call, your returnedJobListEntry
objects will start from this point in the array.
- On failure, responds with
SdkError<ListJobsError>
source§impl Client
impl Client
sourcepub fn list_long_term_pricing(&self) -> ListLongTermPricingFluentBuilder
pub fn list_long_term_pricing(&self) -> ListLongTermPricingFluentBuilder
Constructs a fluent builder for the ListLongTermPricing
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of
ListLongTermPricing
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseBecause HTTP requests are stateless, this is the starting point for your next list of
ListLongTermPricing
to return.
- On success, responds with
ListLongTermPricingOutput
with field(s):long_term_pricing_entries(Option<Vec::<LongTermPricingListEntry>>)
:Each
LongTermPricingEntry
object contains a status, ID, and other information about theLongTermPricing
type.next_token(Option<String>)
:Because HTTP requests are stateless, this is the starting point for your next list of returned
ListLongTermPricing
list.
- On failure, responds with
SdkError<ListLongTermPricingError>
source§impl Client
impl Client
sourcepub fn list_pickup_locations(&self) -> ListPickupLocationsFluentBuilder
pub fn list_pickup_locations(&self) -> ListPickupLocationsFluentBuilder
Constructs a fluent builder for the ListPickupLocations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of locations to list per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseHTTP requests are stateless. To identify what object comes “next” in the list of
ListPickupLocationsRequest
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
- On success, responds with
ListPickupLocationsOutput
with field(s):addresses(Option<Vec::<Address>>)
:Information about the address of pickup locations.
next_token(Option<String>)
:HTTP requests are stateless. To identify what object comes “next” in the list of
ListPickupLocationsResult
objects, you have the option of specifyingNextToken
as the starting point for your returned list.
- On failure, responds with
SdkError<ListPickupLocationsError>
source§impl Client
impl Client
sourcepub fn list_service_versions(&self) -> ListServiceVersionsFluentBuilder
pub fn list_service_versions(&self) -> ListServiceVersionsFluentBuilder
Constructs a fluent builder for the ListServiceVersions
operation.
- The fluent builder is configurable:
service_name(ServiceName)
/set_service_name(Option<ServiceName>)
:
required: trueThe name of the service for which you’re requesting supported versions.
dependent_services(DependentService)
/set_dependent_services(Option<Vec::<DependentService>>)
:
required: falseA list of names and versions of dependant services of the requested service.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of
ListServiceVersions
objects to return.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseBecause HTTP requests are stateless, this is the starting point for the next list of returned
ListServiceVersionsRequest
versions.
- On success, responds with
ListServiceVersionsOutput
with field(s):service_versions(Vec::<ServiceVersion>)
:A list of supported versions.
service_name(ServiceName)
:The name of the service for which the system provided supported versions.
dependent_services(Option<Vec::<DependentService>>)
:A list of names and versions of dependant services of the service for which the system provided supported versions.
next_token(Option<String>)
:Because HTTP requests are stateless, this is the starting point of the next list of returned
ListServiceVersionsResult
results.
- On failure, responds with
SdkError<ListServiceVersionsError>
source§impl Client
impl Client
sourcepub fn update_cluster(&self) -> UpdateClusterFluentBuilder
pub fn update_cluster(&self) -> UpdateClusterFluentBuilder
Constructs a fluent builder for the UpdateCluster
operation.
- The fluent builder is configurable:
cluster_id(impl Into<String>)
/set_cluster_id(Option<String>)
:
required: trueThe cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM).
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe updated description of this cluster.
resources(JobResource)
/set_resources(Option<JobResource>)
:
required: falseThe updated arrays of
JobResource
objects that can include updatedS3Resource
objects orLambdaResource
objects.on_device_service_configuration(OnDeviceServiceConfiguration)
/set_on_device_service_configuration(Option<OnDeviceServiceConfiguration>)
:
required: falseSpecifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
address_id(impl Into<String>)
/set_address_id(Option<String>)
:
required: falseThe ID of the updated
Address
object.shipping_option(ShippingOption)
/set_shipping_option(Option<ShippingOption>)
:
required: falseThe updated shipping option value of this cluster’s
ShippingDetails
object.notification(Notification)
/set_notification(Option<Notification>)
:
required: falseThe new or updated
Notification
object.forwarding_address_id(impl Into<String>)
/set_forwarding_address_id(Option<String>)
:
required: falseThe updated ID for the forwarding address for a cluster. This field is not supported in most regions.
- On success, responds with
UpdateClusterOutput
- On failure, responds with
SdkError<UpdateClusterError>
source§impl Client
impl Client
sourcepub fn update_job(&self) -> UpdateJobFluentBuilder
pub fn update_job(&self) -> UpdateJobFluentBuilder
Constructs a fluent builder for the UpdateJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
.role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.
notification(Notification)
/set_notification(Option<Notification>)
:
required: falseThe new or updated
Notification
object.resources(JobResource)
/set_resources(Option<JobResource>)
:
required: falseThe updated
JobResource
object, or the updatedJobResource
object.on_device_service_configuration(OnDeviceServiceConfiguration)
/set_on_device_service_configuration(Option<OnDeviceServiceConfiguration>)
:
required: falseSpecifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
address_id(impl Into<String>)
/set_address_id(Option<String>)
:
required: falseThe ID of the updated
Address
object.shipping_option(ShippingOption)
/set_shipping_option(Option<ShippingOption>)
:
required: falseThe updated shipping option value of this job’s
ShippingDetails
object.description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe updated description of this job’s
JobMetadata
object.snowball_capacity_preference(SnowballCapacity)
/set_snowball_capacity_preference(Option<SnowballCapacity>)
:
required: falseThe updated
SnowballCapacityPreference
of this job’sJobMetadata
object. The 50 TB Snowballs are only available in the US regions.For more information, see “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide or “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the Snowcone User Guide.
forwarding_address_id(impl Into<String>)
/set_forwarding_address_id(Option<String>)
:
required: falseThe updated ID for the forwarding address for a job. This field is not supported in most regions.
pickup_details(PickupDetails)
/set_pickup_details(Option<PickupDetails>)
:
required: falseInformation identifying the person picking up the device.
- On success, responds with
UpdateJobOutput
- On failure, responds with
SdkError<UpdateJobError>
source§impl Client
impl Client
sourcepub fn update_job_shipment_state(&self) -> UpdateJobShipmentStateFluentBuilder
pub fn update_job_shipment_state(&self) -> UpdateJobShipmentStateFluentBuilder
Constructs a fluent builder for the UpdateJobShipmentState
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe job ID of the job whose shipment date you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
.shipment_state(ShipmentState)
/set_shipment_state(Option<ShipmentState>)
:
required: trueThe state of a device when it is being shipped.
Set to
RECEIVED
when the device arrives at your location.Set to
RETURNED
when you have returned the device to Amazon Web Services.
- On success, responds with
UpdateJobShipmentStateOutput
- On failure, responds with
SdkError<UpdateJobShipmentStateError>
source§impl Client
impl Client
sourcepub fn update_long_term_pricing(&self) -> UpdateLongTermPricingFluentBuilder
pub fn update_long_term_pricing(&self) -> UpdateLongTermPricingFluentBuilder
Constructs a fluent builder for the UpdateLongTermPricing
operation.
- The fluent builder is configurable:
long_term_pricing_id(impl Into<String>)
/set_long_term_pricing_id(Option<String>)
:
required: trueThe ID of the long-term pricing type for the device.
replacement_job(impl Into<String>)
/set_replacement_job(Option<String>)
:
required: falseSpecifies that a device that is ordered with long-term pricing should be replaced with a new device.
is_long_term_pricing_auto_renew(bool)
/set_is_long_term_pricing_auto_renew(Option<bool>)
:
required: falseIf set to
true
, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.
- On success, responds with
UpdateLongTermPricingOutput
- On failure, responds with
SdkError<UpdateLongTermPricingError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more