String addressId
The unique ID for an address.
String name
The name of a person to receive a Snow device at an address.
String company
The name of the company to receive a Snow device at an address.
String street1
The first line in a street address that a Snow device is to be delivered to.
String street2
The second line in a street address that a Snow device is to be delivered to.
String street3
The third line in a street address that a Snow device is to be delivered to.
String city
The city in an address that a Snow device is to be delivered to.
String stateOrProvince
The state or province in an address that a Snow device is to be delivered to.
String prefectureOrDistrict
This field is no longer used and the value is ignored.
String landmark
This field is no longer used and the value is ignored.
String country
The country in an address that a Snow device is to be delivered to.
String postalCode
The postal code in an address that a Snow device is to be delivered to.
String phoneNumber
The phone number associated with an address that a Snow device is to be delivered to.
Boolean isRestricted
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
String type
Differentiates between delivery address and pickup address in the customer account. Provided at job creation.
String clusterId
The 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000.
String jobId
The 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000.
String clusterId
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
String clusterState
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
Date creationDate
The creation date for this cluster.
String description
Defines an optional description of the cluster, for example Environmental Data Cluster-01.
String clusterId
The automatically generated ID for a cluster.
String description
The optional description of the cluster.
String kmsKeyARN
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using
the CreateKey API action in
Key Management Service (KMS.
String roleARN
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
String clusterState
The current status of the cluster.
String jobType
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
String snowballType
The type of Snowcone device to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
Date creationDate
The creation date for this cluster.
JobResource resources
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
String addressId
The automatically generated ID for a specific address.
String shippingOption
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
String forwardingAddressId
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
TaxDocuments taxDocuments
The tax documents required in your Amazon Web Services Region.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
String conflictResource
You get this resource when you call CreateReturnShippingLabel more than once when other requests are
not completed. .
Address address
The address that you want the Snow device shipped to.
String addressId
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.
String jobType
The 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.
JobResource resources
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Specifies 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).
String description
An optional description of this specific cluster, for example Environmental Data Cluster-01.
String addressId
The ID for the address that you want the cluster shipped to.
String kmsKeyARN
The 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).
String roleARN
The 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).
String snowballType
The 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.
String shippingOption
The 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
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
String forwardingAddressId
The forwarding address ID for a cluster. This field is not supported in most regions.
TaxDocuments taxDocuments
The tax documents required in your Amazon Web Services Region.
String remoteManagement
Allows 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.
Integer initialClusterSize
If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
Boolean forceCreateJobs
Force 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.
List<E> longTermPricingIds
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
String snowballCapacityPreference
If 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.
String clusterId
The automatically generated ID for a cluster.
List<E> jobListEntries
List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.
String jobType
Defines the type of job that you're creating.
JobResource resources
Defines 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 a KeyRange value. If you choose to export a range, you define
the length of the range by providing either an inclusive BeginMarker value, an inclusive
EndMarker value, or both. Ranges are UTF-8 binary sorted.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Specifies 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.
String description
Defines an optional description of this specific job, for example Important Photos 2016-08-11.
String addressId
The ID for the address that you want the Snow device shipped to.
String kmsKeyARN
The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using
the CreateKey Key Management
Service (KMS) API action.
String roleARN
The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity and Access
Management (IAM) API action.
String snowballCapacityPreference
If 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.
String shippingOption
The 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
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
String clusterId
The 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.
String snowballType
The 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.
String forwardingAddressId
The forwarding address ID for a job. This field is not supported in most Regions.
TaxDocuments taxDocuments
The tax documents required in your Amazon Web Services Region.
DeviceConfiguration deviceConfiguration
Defines 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.
String remoteManagement
Allows 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 to
NOT_INSTALLED, remote management will not be available on the device.
String longTermPricingId
The ID of the long-term pricing type for the device.
String impactLevel
The highest impact level of data that will be stored or processed on the device, provided at job creation.
PickupDetails pickupDetails
Information identifying the person picking up the device.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String longTermPricingType
The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
Boolean isLongTermPricingAutoRenew
Specifies whether the current long-term pricing type for the device should be renewed.
String snowballType
The type of Snow Family devices to use for the long-term pricing job.
String longTermPricingId
The ID of the long-term pricing type for the device.
String jobId
The ID for a job that you want to create the return shipping label for; for example,
JID123e4567-e89b-12d3-a456-426655440000.
String shippingOption
The 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:
String status
The status information of the task on a Snow device that is being returned to Amazon Web Services.
Long bytesTransferred
The number of bytes transferred between a Snow device and Amazon S3.
Long objectsTransferred
The number of objects transferred between a Snow device and Amazon S3.
Long totalBytes
The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
Long totalObjects
The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
String serviceName
The name of the dependent service.
ServiceVersion serviceVersion
The version of the dependent service.
Integer maxResults
The number of ADDRESS objects to return.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects,
you have the option of specifying a value for NextToken as the starting point for your list of
returned addresses.
List<E> addresses
The Snow device shipping addresses that were created for this account.
String nextToken
HTTP requests are stateless. If you use the automatically generated NextToken value in your next
DescribeAddresses call, your list of returned addresses will start from this point in the array.
String addressId
The automatically generated ID for a specific address.
Address address
The address that you want the Snow device(s) associated with a specific job to be shipped to.
String clusterId
The automatically generated ID for a cluster.
ClusterMetadata clusterMetadata
Information about a specific cluster, including shipping information, cluster status, and other important metadata.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
JobMetadata jobMetadata
Information about a specific job, including shipping information, job status, and other important metadata.
List<E> subJobMetadata
Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String status
The status information of the task on a Snow device that is being returned to Amazon Web Services.
Date expirationDate
The expiration date of the current return shipping label.
String returnShippingLabelURI
The pre-signed Amazon S3 URI used to download the return shipping label.
SnowconeDeviceConfiguration snowconeDeviceConfiguration
Returns information about the device configuration for an Snowcone job.
String eventResourceARN
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
String jobId
The ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000.
String manifestURI
The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
String jobId
The ID for the job that you want to get the UnlockCode value for, for example
JID123e4567-e89b-12d3-a456-426655440000.
String unlockCode
The UnlockCode value for the specified job. The UnlockCode value can be accessed for up
to 360 days after the job has been created.
String jobId
The ID for a job that you want to get the software update file for, for example
JID123e4567-e89b-12d3-a456-426655440000.
String updatesURI
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 to GetSoftwareUpdates.
String gSTIN
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
String resourceType
The provided resource value is invalid.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String jobState
The current state of this job.
Boolean isMaster
A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.
String jobType
The type of job.
String snowballType
The type of device used with this job.
Date creationDate
The creation date for this job.
String description
The optional description of this specific job, for example Important Photos 2016-08-11.
String jobCompletionReportURI
A link to an Amazon S3 presigned URL where the job completion report is located.
String jobSuccessLogURI
A link to an Amazon S3 presigned URL where the job success log is located.
String jobFailureLogURI
A link to an Amazon S3 presigned URL where the job failure log is located.
String jobId
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
String jobState
The current status of the jobs.
String jobType
The type of job.
String snowballType
The type of device used with this job.
Date creationDate
The creation date for this job.
JobResource resources
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket
that your transferred data will be exported from or imported into.
String description
The description of the job, provided at job creation.
String kmsKeyARN
The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS.
String roleARN
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
String addressId
The ID for the address that you want the Snow device shipped to.
ShippingDetails shippingDetails
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
String snowballCapacityPreference
The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.
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.
Notification notification
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notification object is returned as a part of the response syntax of the DescribeJob
action in the JobMetadata data type.
DataTransfer dataTransferProgress
A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web
Services. This data is only available while a job has a JobState value of InProgress,
for both import and export jobs.
JobLogs jobLogInfo
Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.
String clusterId
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.
String forwardingAddressId
The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.
TaxDocuments taxDocuments
The metadata associated with the tax documents required in your Amazon Web Services Region.
DeviceConfiguration deviceConfiguration
String remoteManagement
Allows 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 Client to manage the device.
String longTermPricingId
The ID of the long-term pricing type for the device.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
String impactLevel
The highest impact level of data that will be stored or processed on the device, provided at job creation.
PickupDetails pickupDetails
Information identifying the person picking up the device.
String snowballId
Unique ID associated with a device.
String lambdaArn
An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
List<E> eventTriggers
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
String clusterId
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
Integer maxResults
The number of JobListEntry objects to return.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry
objects, you have the option of specifying NextToken as the starting point for your returned list.
List<E> jobListEntries
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.
String nextToken
HTTP requests are stateless. If you use the automatically generated NextToken value in your next
ListClusterJobsResult call, your list of returned jobs will start from this point in the array.
Integer maxResults
The number of ClusterListEntry objects to return.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry
objects, you have the option of specifying NextToken as the starting point for your returned list.
List<E> clusterListEntries
Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status
information.
String nextToken
HTTP requests are stateless. If you use the automatically generated NextToken value in your next
ClusterListEntry call, your list of returned clusters will start from this point in the array.
Integer maxResults
The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.
String nextToken
HTTP 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.
List<E> jobListEntries
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.
String nextToken
HTTP requests are stateless. If you use this automatically generated NextToken value in your next
ListJobs call, your returned JobListEntry objects will start from this point in the
array.
List<E> longTermPricingEntries
Each LongTermPricingEntry object contains a status, ID, and other information about the
LongTermPricing type.
String nextToken
Because HTTP requests are stateless, this is the starting point for your next list of returned
ListLongTermPricing list.
Integer maxResults
The maximum number of locations to list per page.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of
ListPickupLocationsRequest objects, you have the option of specifying NextToken as the
starting point for your returned list.
List<E> addresses
Information about the address of pickup locations.
String nextToken
HTTP requests are stateless. To identify what object comes "next" in the list of
ListPickupLocationsResult objects, you have the option of specifying NextToken as the
starting point for your returned list.
String serviceName
The name of the service for which you're requesting supported versions.
List<E> dependentServices
A list of names and versions of dependant services of the requested service.
Integer maxResults
The maximum number of ListServiceVersions objects to return.
String nextToken
Because HTTP requests are stateless, this is the starting point for the next list of returned
ListServiceVersionsRequest versions.
List<E> serviceVersions
A list of supported versions.
String serviceName
The name of the service for which the system provided supported versions.
List<E> dependentServices
A list of names and versions of dependant services of the service for which the system provided supported versions.
String nextToken
Because HTTP requests are stateless, this is the starting point of the next list of returned
ListServiceVersionsResult results.
String longTermPricingId
The ID of the long-term pricing type for the device.
Date longTermPricingEndDate
The end date the long-term pricing contract.
Date longTermPricingStartDate
The start date of the long-term pricing contract.
String longTermPricingType
The type of long-term pricing that was selected for the device.
String currentActiveJob
The current active jobs on the device the long-term pricing type.
String replacementJob
A new device that replaces a device that is ordered with long-term pricing.
Boolean isLongTermPricingAutoRenew
If 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.
String longTermPricingStatus
The status of the long-term pricing type.
String snowballType
The type of Snow Family devices associated with this long-term pricing job.
List<E> jobIds
The IDs of the jobs that are associated with a long-term pricing type.
String snsTopicARN
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names
(ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
List<E> jobStatesToNotify
The list of job states that will trigger a notification for this job.
Boolean notifyAll
Any change in job state will trigger a notification for this job.
String devicePickupSnsTopicARN
Used to send SNS notifications for the person picking up the device (identified during job creation).
NFSOnDeviceServiceConfiguration nFSOnDeviceService
Represents the NFS (Network File System) service on a Snow Family device.
TGWOnDeviceServiceConfiguration tGWOnDeviceService
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
EKSOnDeviceServiceConfiguration eKSOnDeviceService
The configuration of EKS Anywhere on the Snow Family device.
S3OnDeviceServiceConfiguration s3OnDeviceService
Configuration for Amazon S3 compatible storage on Snow family devices.
String name
The name of the person picking up the device.
String phoneNumber
The phone number of the person picking up the device.
String email
The email address of the person picking up the device.
String identificationNumber
The number on the credential identifying the person picking up the device.
Date identificationExpirationDate
Expiration date of the credential identifying the person picking up the device.
String identificationIssuingOrg
Organization that issued the credential identifying the person picking up the device.
String devicePickupId
The unique ID for a device that will be picked up.
Double storageLimit
If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.
String storageUnit
Storage unit. Currently the only supported unit is TB.
Integer serviceSize
Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.
Integer faultTolerance
>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading
the performance of the cluster. This additional input helps when the specified StorageLimit matches
more than one Amazon S3 compatible storage on Snow family devices service configuration.
String bucketArn
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
KeyRange keyRange
For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length
of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive
EndMarker, or both. Ranges are UTF-8 binary sorted.
List<E> targetOnDeviceServices
Specifies 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).
String version
The version number of the requested service.
String status
Status information for a shipment.
String trackingNumber
The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
String shippingOption
The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device from the job's creation date. This speed represents how quickly it 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.
Shipment inboundShipment
The Status and TrackingNumber values for a Snow device being returned to Amazon Web
Services for a particular job.
Shipment outboundShipment
The Status and TrackingNumber values for a Snow device being delivered to the address
that you specified for a particular job.
WirelessConnection wirelessConnection
Configures the wireless connection for the Snowcone device.
String serviceName
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
String transferOption
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
INDTaxDocuments iND
String clusterId
The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000.
String roleARN
The 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).
String description
The updated description of this cluster.
JobResource resources
The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Specifies 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).
String addressId
The ID of the updated Address object.
String shippingOption
The updated shipping option value of this cluster's ShippingDetails object.
Notification notification
The new or updated Notification object.
String forwardingAddressId
The updated ID for the forwarding address for a cluster. This field is not supported in most regions.
String jobId
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
String roleARN
The 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
The new or updated Notification object.
JobResource resources
The updated JobResource object, or the updated JobResource object.
OnDeviceServiceConfiguration onDeviceServiceConfiguration
Specifies 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.
String addressId
The ID of the updated Address object.
String shippingOption
The updated shipping option value of this job's ShippingDetails object.
String description
The updated description of this job's JobMetadata object.
String snowballCapacityPreference
The updated SnowballCapacityPreference of this job's JobMetadata 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.
String forwardingAddressId
The updated ID for the forwarding address for a job. This field is not supported in most regions.
PickupDetails pickupDetails
String jobId
The job ID of the job whose shipment date you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000.
String shipmentState
The 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.
String longTermPricingId
The ID of the long-term pricing type for the device.
String replacementJob
Specifies that a device that is ordered with long-term pricing should be replaced with a new device.
Boolean isLongTermPricingAutoRenew
If 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.
Boolean isWifiEnabled
Enables the Wi-Fi adapter on an Snowcone device.
Copyright © 2023. All rights reserved.