# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon Snowball Edge:
+  [Address](API_Address.md) 
+  [ClusterListEntry](API_ClusterListEntry.md) 
+  [ClusterMetadata](API_ClusterMetadata.md) 
+  [CompatibleImage](API_CompatibleImage.md) 
+  [DataTransfer](API_DataTransfer.md) 
+  [DependentService](API_DependentService.md) 
+  [DeviceConfiguration](API_DeviceConfiguration.md) 
+  [Ec2AmiResource](API_Ec2AmiResource.md) 
+  [EKSOnDeviceServiceConfiguration](API_EKSOnDeviceServiceConfiguration.md) 
+  [EventTriggerDefinition](API_EventTriggerDefinition.md) 
+  [INDTaxDocuments](API_INDTaxDocuments.md) 
+  [JobListEntry](API_JobListEntry.md) 
+  [JobLogs](API_JobLogs.md) 
+  [JobMetadata](API_JobMetadata.md) 
+  [JobResource](API_JobResource.md) 
+  [KeyRange](API_KeyRange.md) 
+  [LambdaResource](API_LambdaResource.md) 
+  [LongTermPricingListEntry](API_LongTermPricingListEntry.md) 
+  [NFSOnDeviceServiceConfiguration](API_NFSOnDeviceServiceConfiguration.md) 
+  [Notification](API_Notification.md) 
+  [OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) 
+  [PickupDetails](API_PickupDetails.md) 
+  [S3OnDeviceServiceConfiguration](API_S3OnDeviceServiceConfiguration.md) 
+  [S3Resource](API_S3Resource.md) 
+  [ServiceVersion](API_ServiceVersion.md) 
+  [Shipment](API_Shipment.md) 
+  [ShippingDetails](API_ShippingDetails.md) 
+  [SnowconeDeviceConfiguration](API_SnowconeDeviceConfiguration.md) 
+  [TargetOnDeviceService](API_TargetOnDeviceService.md) 
+  [TaxDocuments](API_TaxDocuments.md) 
+  [TGWOnDeviceServiceConfiguration](API_TGWOnDeviceServiceConfiguration.md) 
+  [WirelessConnection](API_WirelessConnection.md) 

The following data types are supported by Amazon Snowball Edge Device Management:
+  [Capacity](API_devicemanagement_Capacity.md) 
+  [Command](API_devicemanagement_Command.md) 
+  [CpuOptions](API_devicemanagement_CpuOptions.md) 
+  [DeviceSummary](API_devicemanagement_DeviceSummary.md) 
+  [EbsInstanceBlockDevice](API_devicemanagement_EbsInstanceBlockDevice.md) 
+  [ExecutionSummary](API_devicemanagement_ExecutionSummary.md) 
+  [Instance](API_devicemanagement_Instance.md) 
+  [InstanceBlockDeviceMapping](API_devicemanagement_InstanceBlockDeviceMapping.md) 
+  [InstanceState](API_devicemanagement_InstanceState.md) 
+  [InstanceSummary](API_devicemanagement_InstanceSummary.md) 
+  [PhysicalNetworkInterface](API_devicemanagement_PhysicalNetworkInterface.md) 
+  [Reboot](API_devicemanagement_Reboot.md) 
+  [ResourceSummary](API_devicemanagement_ResourceSummary.md) 
+  [SecurityGroupIdentifier](API_devicemanagement_SecurityGroupIdentifier.md) 
+  [SoftwareInformation](API_devicemanagement_SoftwareInformation.md) 
+  [TaskSummary](API_devicemanagement_TaskSummary.md) 
+  [Unlock](API_devicemanagement_Unlock.md) 

# Amazon Snowball Edge
<a name="API_Types_Amazon_Import_Export_Snowball"></a>

The following data types are supported by Amazon Snowball Edge:
+  [Address](API_Address.md) 
+  [ClusterListEntry](API_ClusterListEntry.md) 
+  [ClusterMetadata](API_ClusterMetadata.md) 
+  [CompatibleImage](API_CompatibleImage.md) 
+  [DataTransfer](API_DataTransfer.md) 
+  [DependentService](API_DependentService.md) 
+  [DeviceConfiguration](API_DeviceConfiguration.md) 
+  [Ec2AmiResource](API_Ec2AmiResource.md) 
+  [EKSOnDeviceServiceConfiguration](API_EKSOnDeviceServiceConfiguration.md) 
+  [EventTriggerDefinition](API_EventTriggerDefinition.md) 
+  [INDTaxDocuments](API_INDTaxDocuments.md) 
+  [JobListEntry](API_JobListEntry.md) 
+  [JobLogs](API_JobLogs.md) 
+  [JobMetadata](API_JobMetadata.md) 
+  [JobResource](API_JobResource.md) 
+  [KeyRange](API_KeyRange.md) 
+  [LambdaResource](API_LambdaResource.md) 
+  [LongTermPricingListEntry](API_LongTermPricingListEntry.md) 
+  [NFSOnDeviceServiceConfiguration](API_NFSOnDeviceServiceConfiguration.md) 
+  [Notification](API_Notification.md) 
+  [OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) 
+  [PickupDetails](API_PickupDetails.md) 
+  [S3OnDeviceServiceConfiguration](API_S3OnDeviceServiceConfiguration.md) 
+  [S3Resource](API_S3Resource.md) 
+  [ServiceVersion](API_ServiceVersion.md) 
+  [Shipment](API_Shipment.md) 
+  [ShippingDetails](API_ShippingDetails.md) 
+  [SnowconeDeviceConfiguration](API_SnowconeDeviceConfiguration.md) 
+  [TargetOnDeviceService](API_TargetOnDeviceService.md) 
+  [TaxDocuments](API_TaxDocuments.md) 
+  [TGWOnDeviceServiceConfiguration](API_TGWOnDeviceServiceConfiguration.md) 
+  [WirelessConnection](API_WirelessConnection.md) 

# Address
<a name="API_Address"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the `Address` are required, if the address is invalid or unsupported, then an exception is thrown.

## Contents
<a name="API_Address_Contents"></a>

 ** AddressId **   <a name="Snowball-Type-Address-AddressId"></a>
The unique ID for an address.  
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** City **   <a name="Snowball-Type-Address-City"></a>
The city in an address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Company **   <a name="Snowball-Type-Address-Company"></a>
The name of the company to receive a Snow device at an address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Country **   <a name="Snowball-Type-Address-Country"></a>
The country in an address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** IsRestricted **   <a name="Snowball-Type-Address-IsRestricted"></a>
This field is not supported in your region.  
Type: Boolean  
Required: No

 ** Landmark **   <a name="Snowball-Type-Address-Landmark"></a>
This field is no longer used and the value is ignored.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Name **   <a name="Snowball-Type-Address-Name"></a>
The name of a person to receive a Snow device at an address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** PhoneNumber **   <a name="Snowball-Type-Address-PhoneNumber"></a>
The phone number associated with an address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** PostalCode **   <a name="Snowball-Type-Address-PostalCode"></a>
The postal code in an address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** PrefectureOrDistrict **   <a name="Snowball-Type-Address-PrefectureOrDistrict"></a>
This field is no longer used and the value is ignored.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** StateOrProvince **   <a name="Snowball-Type-Address-StateOrProvince"></a>
The state or province in an address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Street1 **   <a name="Snowball-Type-Address-Street1"></a>
The first line in a street address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Street2 **   <a name="Snowball-Type-Address-Street2"></a>
The second line in a street address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Street3 **   <a name="Snowball-Type-Address-Street3"></a>
The third line in a street address that a Snow device is to be delivered to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Type **   <a name="Snowball-Type-Address-Type"></a>
Differentiates between delivery address and pickup address in the customer account. Provided at job creation.  
Type: String  
Valid Values: `CUST_PICKUP | AWS_SHIP`   
Required: No

## See Also
<a name="API_Address_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/Address) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/Address) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/Address) 

# ClusterListEntry
<a name="API_ClusterListEntry"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains a cluster's state, a cluster's ID, and other important information.

## Contents
<a name="API_ClusterListEntry_Contents"></a>

 ** ClusterId **   <a name="Snowball-Type-ClusterListEntry-ClusterId"></a>
The 39-character ID for the cluster that you want to list, for example `CID123e4567-e89b-12d3-a456-426655440000`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** ClusterState **   <a name="Snowball-Type-ClusterListEntry-ClusterState"></a>
The current state of this cluster. For information about the state of a specific node, see [JobListEntry:JobState](API_JobListEntry.md#Snowball-Type-JobListEntry-JobState).  
Type: String  
Valid Values: `AwaitingQuorum | Pending | InUse | Complete | Cancelled`   
Required: No

 ** CreationDate **   <a name="Snowball-Type-ClusterListEntry-CreationDate"></a>
The creation date for this cluster.  
Type: Timestamp  
Required: No

 ** Description **   <a name="Snowball-Type-ClusterListEntry-Description"></a>
Defines an optional description of the cluster, for example `Environmental Data Cluster-01`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_ClusterListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/ClusterListEntry) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/ClusterListEntry) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/ClusterListEntry) 

# ClusterMetadata
<a name="API_ClusterMetadata"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains metadata about a specific cluster.

## Contents
<a name="API_ClusterMetadata_Contents"></a>

 ** AddressId **   <a name="Snowball-Type-ClusterMetadata-AddressId"></a>
The automatically generated ID for a specific address.  
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** ClusterId **   <a name="Snowball-Type-ClusterMetadata-ClusterId"></a>
The automatically generated ID for a cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** ClusterState **   <a name="Snowball-Type-ClusterMetadata-ClusterState"></a>
The current status of the cluster.  
Type: String  
Valid Values: `AwaitingQuorum | Pending | InUse | Complete | Cancelled`   
Required: No

 ** CreationDate **   <a name="Snowball-Type-ClusterMetadata-CreationDate"></a>
The creation date for this cluster.  
Type: Timestamp  
Required: No

 ** Description **   <a name="Snowball-Type-ClusterMetadata-Description"></a>
The optional description of the cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** ForwardingAddressId **   <a name="Snowball-Type-ClusterMetadata-ForwardingAddressId"></a>
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** JobType **   <a name="Snowball-Type-ClusterMetadata-JobType"></a>
The type of job for this cluster. Currently, the only job type supported for clusters is `LOCAL_USE`.  
Type: String  
Valid Values: `IMPORT | EXPORT | LOCAL_USE`   
Required: No

 ** KmsKeyARN **   <a name="Snowball-Type-ClusterMetadata-KmsKeyARN"></a>
The `KmsKeyARN` Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the [CreateKey](https://docs.amazonaws.cn/kms/latest/APIReference/API_CreateKey.html) API action in Amazon Key Management Service (Amazon KMS.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Required: No

 ** Notification **   <a name="Snowball-Type-ClusterMetadata-Notification"></a>
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.  
Type: [Notification](API_Notification.md) object  
Required: No

 ** OnDeviceServiceConfiguration **   <a name="Snowball-Type-ClusterMetadata-OnDeviceServiceConfiguration"></a>
Represents metadata and configuration settings for services on an Amazon Snowball Edge device.  
Type: [OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) object  
Required: No

 ** Resources **   <a name="Snowball-Type-ClusterMetadata-Resources"></a>
The arrays of [JobResource](API_JobResource.md) objects that can include updated [S3Resource](API_S3Resource.md) objects or [LambdaResource](API_LambdaResource.md) objects.  
Type: [JobResource](API_JobResource.md) object  
Required: No

 ** RoleARN **   <a name="Snowball-Type-ClusterMetadata-RoleARN"></a>
The role ARN associated with this cluster. This ARN was created using the [CreateRole](https://docs.amazonaws.cn/IAM/latest/APIReference/API_CreateRole.html) API action in Amazon Identity and Access Management (IAM).  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:iam::[0-9]{12}:role/.*`   
Required: No

 ** ShippingOption **   <a name="Snowball-Type-ClusterMetadata-ShippingOption"></a>
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.
Type: String  
Valid Values: `SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD`   
Required: No

 ** SnowballType **   <a name="Snowball-Type-ClusterMetadata-SnowballType"></a>
The type of Snowball Edge device to use for this cluster.   
For cluster jobs, Amazon Snowball Edge currently supports only the `EDGE` device type.
Type: String  
Valid Values: `STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
Required: No

 ** TaxDocuments **   <a name="Snowball-Type-ClusterMetadata-TaxDocuments"></a>
The tax documents required in your Amazon Web Services Region.  
Type: [TaxDocuments](API_TaxDocuments.md) object  
Required: No

## See Also
<a name="API_ClusterMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/ClusterMetadata) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/ClusterMetadata) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/ClusterMetadata) 

# CompatibleImage
<a name="API_CompatibleImage"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

## Contents
<a name="API_CompatibleImage_Contents"></a>

 ** AmiId **   <a name="Snowball-Type-CompatibleImage-AmiId"></a>
The unique identifier for an individual Snow device AMI.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Name **   <a name="Snowball-Type-CompatibleImage-Name"></a>
The optional name of a compatible image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_CompatibleImage_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/CompatibleImage) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/CompatibleImage) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/CompatibleImage) 

# DataTransfer
<a name="API_DataTransfer"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Defines the real-time status of a Snow device's data transfer while the device is at Amazon. This data is only available while a job has a `JobState` value of `InProgress`, for both import and export jobs.

## Contents
<a name="API_DataTransfer_Contents"></a>

 ** BytesTransferred **   <a name="Snowball-Type-DataTransfer-BytesTransferred"></a>
The number of bytes transferred between a Snow device and Amazon S3.  
Type: Long  
Required: No

 ** ObjectsTransferred **   <a name="Snowball-Type-DataTransfer-ObjectsTransferred"></a>
The number of objects transferred between a Snow device and Amazon S3.  
Type: Long  
Required: No

 ** TotalBytes **   <a name="Snowball-Type-DataTransfer-TotalBytes"></a>
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.  
Type: Long  
Required: No

 ** TotalObjects **   <a name="Snowball-Type-DataTransfer-TotalObjects"></a>
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.  
Type: Long  
Required: No

## See Also
<a name="API_DataTransfer_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/DataTransfer) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/DataTransfer) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/DataTransfer) 

# DependentService
<a name="API_DependentService"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The name and version of the service dependant on the requested service.

## Contents
<a name="API_DependentService_Contents"></a>

 ** ServiceName **   <a name="Snowball-Type-DependentService-ServiceName"></a>
The name of the dependent service.  
Type: String  
Valid Values: `KUBERNETES | EKS_ANYWHERE`   
Required: No

 ** ServiceVersion **   <a name="Snowball-Type-DependentService-ServiceVersion"></a>
The version of the dependent service.  
Type: [ServiceVersion](API_ServiceVersion.md) object  
Required: No

## See Also
<a name="API_DependentService_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/DependentService) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/DependentService) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/DependentService) 

# DeviceConfiguration
<a name="API_DeviceConfiguration"></a>

The container for `SnowconeDeviceConfiguration`. 

## Contents
<a name="API_DeviceConfiguration_Contents"></a>

 ** SnowconeDeviceConfiguration **   <a name="Snowball-Type-DeviceConfiguration-SnowconeDeviceConfiguration"></a>
Returns information about the device configuration for an Amazon Snowball Edge job.  
Type: [SnowconeDeviceConfiguration](API_SnowconeDeviceConfiguration.md) object  
Required: No

## See Also
<a name="API_DeviceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/DeviceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/DeviceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/DeviceConfiguration) 

# Ec2AmiResource
<a name="API_Ec2AmiResource"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.

## Contents
<a name="API_Ec2AmiResource_Contents"></a>

 ** AmiId **   <a name="Snowball-Type-Ec2AmiResource-AmiId"></a>
The ID of the AMI in Amazon EC2.  
Type: String  
Length Constraints: Minimum length of 12. Maximum length of 21.  
Pattern: `(ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})`   
Required: Yes

 ** SnowballAmiId **   <a name="Snowball-Type-Ec2AmiResource-SnowballAmiId"></a>
The ID of the AMI on the Snow device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_Ec2AmiResource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/Ec2AmiResource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/Ec2AmiResource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/Ec2AmiResource) 

# EKSOnDeviceServiceConfiguration
<a name="API_EKSOnDeviceServiceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

An object representing the metadata and configuration settings of EKS Anywhere on the Snowball Edge device.

## Contents
<a name="API_EKSOnDeviceServiceConfiguration_Contents"></a>

 ** EKSAnywhereVersion **   <a name="Snowball-Type-EKSOnDeviceServiceConfiguration-EKSAnywhereVersion"></a>
The optional version of EKS Anywhere on the Snowball Edge device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** KubernetesVersion **   <a name="Snowball-Type-EKSOnDeviceServiceConfiguration-KubernetesVersion"></a>
The Kubernetes version for EKS Anywhere on the Snowball Edge device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_EKSOnDeviceServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/EKSOnDeviceServiceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/EKSOnDeviceServiceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/EKSOnDeviceServiceConfiguration) 

# EventTriggerDefinition
<a name="API_EventTriggerDefinition"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The container for the [EventTriggerDefinition:EventResourceARN](#Snowball-Type-EventTriggerDefinition-EventResourceARN).

## Contents
<a name="API_EventTriggerDefinition_Contents"></a>

 ** EventResourceARN **   <a name="Snowball-Type-EventTriggerDefinition-EventResourceARN"></a>
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Amazon Lambda function's event trigger associated with this job.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:*`   
Required: No

## See Also
<a name="API_EventTriggerDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/EventTriggerDefinition) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/EventTriggerDefinition) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/EventTriggerDefinition) 

# INDTaxDocuments
<a name="API_INDTaxDocuments"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The tax documents required in Amazon Web Services Region in India.

## Contents
<a name="API_INDTaxDocuments_Contents"></a>

 ** GSTIN **   <a name="Snowball-Type-INDTaxDocuments-GSTIN"></a>
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.  
Type: String  
Length Constraints: Fixed length of 15.  
Pattern: `\d{2}[A-Z]{5}\d{4}[A-Z]{1}[A-Z\d]{1}[Z]{1}[A-Z\d]{1}`   
Required: No

## See Also
<a name="API_INDTaxDocuments_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/INDTaxDocuments) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/INDTaxDocuments) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/INDTaxDocuments) 

# JobListEntry
<a name="API_JobListEntry"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

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 an export job.

## Contents
<a name="API_JobListEntry_Contents"></a>

 ** CreationDate **   <a name="Snowball-Type-JobListEntry-CreationDate"></a>
The creation date for this job.  
Type: Timestamp  
Required: No

 ** Description **   <a name="Snowball-Type-JobListEntry-Description"></a>
The optional description of this specific job, for example `Important Photos 2016-08-11`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** IsMaster **   <a name="Snowball-Type-JobListEntry-IsMaster"></a>
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.  
Type: Boolean  
Required: No

 ** JobId **   <a name="Snowball-Type-JobListEntry-JobId"></a>
The automatically generated ID for a job, for example `JID123e4567-e89b-12d3-a456-426655440000`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** JobState **   <a name="Snowball-Type-JobListEntry-JobState"></a>
The current state of this job.  
Type: String  
Valid Values: `New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending`   
Required: No

 ** JobType **   <a name="Snowball-Type-JobListEntry-JobType"></a>
The type of job.  
Type: String  
Valid Values: `IMPORT | EXPORT | LOCAL_USE`   
Required: No

 ** SnowballType **   <a name="Snowball-Type-JobListEntry-SnowballType"></a>
The type of device used with this job.  
Type: String  
Valid Values: `STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
Required: No

## See Also
<a name="API_JobListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/JobListEntry) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/JobListEntry) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/JobListEntry) 

# JobLogs
<a name="API_JobLogs"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains job logs. Whenever a Snow device is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the `DescribeJob` action in the `JobMetadata` data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the `DescribeJob` action.

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.

The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.

For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

## Contents
<a name="API_JobLogs_Contents"></a>

 ** JobCompletionReportURI **   <a name="Snowball-Type-JobLogs-JobCompletionReportURI"></a>
A link to an Amazon S3 presigned URL where the job completion report is located.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** JobFailureLogURI **   <a name="Snowball-Type-JobLogs-JobFailureLogURI"></a>
A link to an Amazon S3 presigned URL where the job failure log is located.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** JobSuccessLogURI **   <a name="Snowball-Type-JobLogs-JobSuccessLogURI"></a>
A link to an Amazon S3 presigned URL where the job success log is located.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_JobLogs_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/JobLogs) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/JobLogs) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/JobLogs) 

# JobMetadata
<a name="API_JobMetadata"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the `DescribeJob` action.

## Contents
<a name="API_JobMetadata_Contents"></a>

 ** AddressId **   <a name="Snowball-Type-JobMetadata-AddressId"></a>
The ID for the address that you want the Snow device shipped to.  
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** ClusterId **   <a name="Snowball-Type-JobMetadata-ClusterId"></a>
The 39-character ID for the cluster, for example `CID123e4567-e89b-12d3-a456-426655440000`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** CreationDate **   <a name="Snowball-Type-JobMetadata-CreationDate"></a>
The creation date for this job.  
Type: Timestamp  
Required: No

 ** DataTransferProgress **   <a name="Snowball-Type-JobMetadata-DataTransferProgress"></a>
A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon. This data is only available while a job has a `JobState` value of `InProgress`, for both import and export jobs.  
Type: [DataTransfer](API_DataTransfer.md) object  
Required: No

 ** Description **   <a name="Snowball-Type-JobMetadata-Description"></a>
The description of the job, provided at job creation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** DeviceConfiguration **   <a name="Snowball-Type-JobMetadata-DeviceConfiguration"></a>
The container for `SnowconeDeviceConfiguration`.   
Type: [DeviceConfiguration](API_DeviceConfiguration.md) object  
Required: No

 ** ForwardingAddressId **   <a name="Snowball-Type-JobMetadata-ForwardingAddressId"></a>
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** ImpactLevel **   <a name="Snowball-Type-JobMetadata-ImpactLevel"></a>
The highest impact level of data that will be stored or processed on the device, provided at job creation.  
Type: String  
Valid Values: `IL2 | IL4 | IL5 | IL6 | IL99`   
Required: No

 ** JobId **   <a name="Snowball-Type-JobMetadata-JobId"></a>
The automatically generated ID for a job, for example `JID123e4567-e89b-12d3-a456-426655440000`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** JobLogInfo **   <a name="Snowball-Type-JobMetadata-JobLogInfo"></a>
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.  
Type: [JobLogs](API_JobLogs.md) object  
Required: No

 ** JobState **   <a name="Snowball-Type-JobMetadata-JobState"></a>
The current status of the jobs.  
Type: String  
Valid Values: `New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending`   
Required: No

 ** JobType **   <a name="Snowball-Type-JobMetadata-JobType"></a>
The type of job.  
Type: String  
Valid Values: `IMPORT | EXPORT | LOCAL_USE`   
Required: No

 ** KmsKeyARN **   <a name="Snowball-Type-JobMetadata-KmsKeyARN"></a>
The Amazon Resource Name (ARN) for the Amazon Key Management Service (Amazon KMS) key associated with this job. This ARN was created using the [CreateKey](https://docs.amazonaws.cn/kms/latest/APIReference/API_CreateKey.html) API action in Amazon KMS.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
Required: No

 ** LongTermPricingId **   <a name="Snowball-Type-JobMetadata-LongTermPricingId"></a>
The ID of the long-term pricing type for the device.  
Type: String  
Length Constraints: Fixed length of 41.  
Pattern: `LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** Notification **   <a name="Snowball-Type-JobMetadata-Notification"></a>
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.  
Type: [Notification](API_Notification.md) object  
Required: No

 ** OnDeviceServiceConfiguration **   <a name="Snowball-Type-JobMetadata-OnDeviceServiceConfiguration"></a>
Represents metadata and configuration settings for services on an Amazon Snowball Edge device.  
Type: [OnDeviceServiceConfiguration](API_OnDeviceServiceConfiguration.md) object  
Required: No

 ** PickupDetails **   <a name="Snowball-Type-JobMetadata-PickupDetails"></a>
Information identifying the person picking up the device.  
Type: [PickupDetails](API_PickupDetails.md) object  
Required: No

 ** RemoteManagement **   <a name="Snowball-Type-JobMetadata-RemoteManagement"></a>
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.  
Type: String  
Valid Values: `INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED`   
Required: No

 ** Resources **   <a name="Snowball-Type-JobMetadata-Resources"></a>
An array of `S3Resource` objects. Each `S3Resource` object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.  
Type: [JobResource](API_JobResource.md) object  
Required: No

 ** RoleARN **   <a name="Snowball-Type-JobMetadata-RoleARN"></a>
The role ARN associated with this job. This ARN was created using the [CreateRole](https://docs.amazonaws.cn/IAM/latest/APIReference/API_CreateRole.html) API action in Amazon Identity and Access Management.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:iam::[0-9]{12}:role/.*`   
Required: No

 ** ShippingDetails **   <a name="Snowball-Type-JobMetadata-ShippingDetails"></a>
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.  
Type: [ShippingDetails](API_ShippingDetails.md) object  
Required: No

 ** SnowballCapacityPreference **   <a name="Snowball-Type-JobMetadata-SnowballCapacityPreference"></a>
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 information about Snowball Edge device types, see [Device hardware differences](https://docs.amazonaws.cn/snowball/latest/developer-guide/device-differences.html) in the Snowball Edge Developer Guide.  
Type: String  
Valid Values: `T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13`   
Required: No

 ** SnowballId **   <a name="Snowball-Type-JobMetadata-SnowballId"></a>
Unique ID associated with a device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** SnowballType **   <a name="Snowball-Type-JobMetadata-SnowballType"></a>
The type of device used with this job.  
Type: String  
Valid Values: `STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
Required: No

 ** TaxDocuments **   <a name="Snowball-Type-JobMetadata-TaxDocuments"></a>
The metadata associated with the tax documents required in your Amazon Web Services Region.  
Type: [TaxDocuments](API_TaxDocuments.md) object  
Required: No

## See Also
<a name="API_JobMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/JobMetadata) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/JobMetadata) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/JobMetadata) 

# JobResource
<a name="API_JobResource"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains an array of Amazon resource objects. Each object represents an Amazon S3 bucket, an Amazon Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.

## Contents
<a name="API_JobResource_Contents"></a>

 ** Ec2AmiResources **   <a name="Snowball-Type-JobResource-Ec2AmiResources"></a>
The Amazon Machine Images (AMIs) associated with this job.  
Type: Array of [Ec2AmiResource](API_Ec2AmiResource.md) objects  
Required: No

 ** LambdaResources **   <a name="Snowball-Type-JobResource-LambdaResources"></a>
The Python-language Lambda functions for this job.  
Type: Array of [LambdaResource](API_LambdaResource.md) objects  
Required: No

 ** S3Resources **   <a name="Snowball-Type-JobResource-S3Resources"></a>
An array of `S3Resource` objects.  
Type: Array of [S3Resource](API_S3Resource.md) objects  
Required: No

## See Also
<a name="API_JobResource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/JobResource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/JobResource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/JobResource) 

# KeyRange
<a name="API_KeyRange"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Contains a key range. For export jobs, a `S3Resource` object can have an optional `KeyRange` value. 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.

## Contents
<a name="API_KeyRange_Contents"></a>

 ** BeginMarker **   <a name="Snowball-Type-KeyRange-BeginMarker"></a>
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** EndMarker **   <a name="Snowball-Type-KeyRange-EndMarker"></a>
The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_KeyRange_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/KeyRange) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/KeyRange) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/KeyRange) 

# LambdaResource
<a name="API_LambdaResource"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Identifies 

## Contents
<a name="API_LambdaResource_Contents"></a>

 ** EventTriggers **   <a name="Snowball-Type-LambdaResource-EventTriggers"></a>
The array of ARNs for [S3Resource](API_S3Resource.md) objects to trigger the [LambdaResource](#API_LambdaResource) objects associated with this job.  
Type: Array of [EventTriggerDefinition](API_EventTriggerDefinition.md) objects  
Required: No

 ** LambdaArn **   <a name="Snowball-Type-LambdaResource-LambdaArn"></a>
An Amazon Resource Name (ARN) that represents an Amazon Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:*`   
Required: No

## See Also
<a name="API_LambdaResource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/LambdaResource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/LambdaResource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/LambdaResource) 

# LongTermPricingListEntry
<a name="API_LongTermPricingListEntry"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Each `LongTermPricingListEntry` object contains information about a long-term pricing type.

## Contents
<a name="API_LongTermPricingListEntry_Contents"></a>

 ** CurrentActiveJob **   <a name="Snowball-Type-LongTermPricingListEntry-CurrentActiveJob"></a>
The current active jobs on the device the long-term pricing type.  
Type: String  
Length Constraints: Fixed length of 39.  
Pattern: `(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** IsLongTermPricingAutoRenew **   <a name="Snowball-Type-LongTermPricingListEntry-IsLongTermPricingAutoRenew"></a>
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.  
Type: Boolean  
Required: No

 ** JobIds **   <a name="Snowball-Type-LongTermPricingListEntry-JobIds"></a>
The IDs of the jobs that are associated with a long-term pricing type.  
Type: Array of strings  
Length Constraints: Fixed length of 39.  
Pattern: `(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** LongTermPricingEndDate **   <a name="Snowball-Type-LongTermPricingListEntry-LongTermPricingEndDate"></a>
The end date the long-term pricing contract.  
Type: Timestamp  
Required: No

 ** LongTermPricingId **   <a name="Snowball-Type-LongTermPricingListEntry-LongTermPricingId"></a>
The ID of the long-term pricing type for the device.  
Type: String  
Length Constraints: Fixed length of 41.  
Pattern: `LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** LongTermPricingStartDate **   <a name="Snowball-Type-LongTermPricingListEntry-LongTermPricingStartDate"></a>
The start date of the long-term pricing contract.  
Type: Timestamp  
Required: No

 ** LongTermPricingStatus **   <a name="Snowball-Type-LongTermPricingListEntry-LongTermPricingStatus"></a>
The status of the long-term pricing type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** LongTermPricingType **   <a name="Snowball-Type-LongTermPricingListEntry-LongTermPricingType"></a>
The type of long-term pricing that was selected for the device.  
Type: String  
Valid Values: `OneYear | ThreeYear | OneMonth`   
Required: No

 ** ReplacementJob **   <a name="Snowball-Type-LongTermPricingListEntry-ReplacementJob"></a>
A new device that replaces a device that is ordered with long-term pricing.  
Type: String  
Length Constraints: Fixed length of 39.  
Pattern: `(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** SnowballType **   <a name="Snowball-Type-LongTermPricingListEntry-SnowballType"></a>
The type of Snow Family devices associated with this long-term pricing job.  
Type: String  
Valid Values: `STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C`   
Required: No

## See Also
<a name="API_LongTermPricingListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/LongTermPricingListEntry) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/LongTermPricingListEntry) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/LongTermPricingListEntry) 

# NFSOnDeviceServiceConfiguration
<a name="API_NFSOnDeviceServiceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Snowball Edge device.

## Contents
<a name="API_NFSOnDeviceServiceConfiguration_Contents"></a>

 ** StorageLimit **   <a name="Snowball-Type-NFSOnDeviceServiceConfiguration-StorageLimit"></a>
The maximum NFS storage for one Snowball Edge device.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** StorageUnit **   <a name="Snowball-Type-NFSOnDeviceServiceConfiguration-StorageUnit"></a>
The scale unit of the NFS storage on the device.  
Valid values: TB.  
Type: String  
Valid Values: `TB`   
Required: No

## See Also
<a name="API_NFSOnDeviceServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/NFSOnDeviceServiceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/NFSOnDeviceServiceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/NFSOnDeviceServiceConfiguration) 

# Notification
<a name="API_Notification"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

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.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the `JobStatesToNotify` array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with `NotifyAll` set to true.

## Contents
<a name="API_Notification_Contents"></a>

 ** DevicePickupSnsTopicARN **   <a name="Snowball-Type-Notification-DevicePickupSnsTopicARN"></a>
Used to send SNS notifications for the person picking up the device (identified during job creation).  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:sns:.*:[0-9]{12}:.*`   
Required: No

 ** JobStatesToNotify **   <a name="Snowball-Type-Notification-JobStatesToNotify"></a>
The list of job states that will trigger a notification for this job.  
Type: Array of strings  
Valid Values: `New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending`   
Required: No

 ** NotifyAll **   <a name="Snowball-Type-Notification-NotifyAll"></a>
Any change in job state will trigger a notification for this job.  
Type: Boolean  
Required: No

 ** SnsTopicARN **   <a name="Snowball-Type-Notification-SnsTopicARN"></a>
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](https://docs.amazonaws.cn/sns/latest/api/API_CreateTopic.html) 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](https://docs.amazonaws.cn/sns/latest/api/API_Subscribe.html) Amazon Simple Notification Service (Amazon SNS) API action.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:sns:.*:[0-9]{12}:.*`   
Required: No

## See Also
<a name="API_Notification_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/Notification) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/Notification) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/Notification) 

# OnDeviceServiceConfiguration
<a name="API_OnDeviceServiceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

An object that represents the metadata and configuration settings for services on an Amazon Snowball Edge device.

## Contents
<a name="API_OnDeviceServiceConfiguration_Contents"></a>

 ** EKSOnDeviceService **   <a name="Snowball-Type-OnDeviceServiceConfiguration-EKSOnDeviceService"></a>
The configuration of EKS Anywhere on the Snowball Edge device.  
Type: [EKSOnDeviceServiceConfiguration](API_EKSOnDeviceServiceConfiguration.md) object  
Required: No

 ** NFSOnDeviceService **   <a name="Snowball-Type-OnDeviceServiceConfiguration-NFSOnDeviceService"></a>
Represents the NFS (Network File System) service on a Snowball Edge device.  
Type: [NFSOnDeviceServiceConfiguration](API_NFSOnDeviceServiceConfiguration.md) object  
Required: No

 ** S3OnDeviceService **   <a name="Snowball-Type-OnDeviceServiceConfiguration-S3OnDeviceService"></a>
Configuration for Amazon S3 compatible storage on Snowball Edge devices.  
Type: [S3OnDeviceServiceConfiguration](API_S3OnDeviceServiceConfiguration.md) object  
Required: No

 ** TGWOnDeviceService **   <a name="Snowball-Type-OnDeviceServiceConfiguration-TGWOnDeviceService"></a>
Represents the Storage Gateway service Tape Gateway type on a Snow Family device.  
The Tape Gateway service is no longer available on Snowball Edge devices.
Type: [TGWOnDeviceServiceConfiguration](API_TGWOnDeviceServiceConfiguration.md) object  
Required: No

## See Also
<a name="API_OnDeviceServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/OnDeviceServiceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/OnDeviceServiceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/OnDeviceServiceConfiguration) 

# PickupDetails
<a name="API_PickupDetails"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Information identifying the person picking up the device.

## Contents
<a name="API_PickupDetails_Contents"></a>

 ** DevicePickupId **   <a name="Snowball-Type-PickupDetails-DevicePickupId"></a>
The unique ID for a device that will be picked up.  
Type: String  
Length Constraints: Fixed length of 40.  
Pattern: `DPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: No

 ** Email **   <a name="Snowball-Type-PickupDetails-Email"></a>
The email address of the person picking up the device.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 320.  
Pattern: `^(?=.{3,100}$).+@.+[.].+$`   
Required: No

 ** IdentificationExpirationDate **   <a name="Snowball-Type-PickupDetails-IdentificationExpirationDate"></a>
Expiration date of the credential identifying the person picking up the device.  
Type: Timestamp  
Required: No

 ** IdentificationIssuingOrg **   <a name="Snowball-Type-PickupDetails-IdentificationIssuingOrg"></a>
Organization that issued the credential identifying the person picking up the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** IdentificationNumber **   <a name="Snowball-Type-PickupDetails-IdentificationNumber"></a>
The number on the credential identifying the person picking up the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** Name **   <a name="Snowball-Type-PickupDetails-Name"></a>
The name of the person picking up the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** PhoneNumber **   <a name="Snowball-Type-PickupDetails-PhoneNumber"></a>
The phone number of the person picking up the device.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 30.  
Pattern: `^\s*(?:\+?(\d{1,3}))?[-. (]*(\d{3})[-. )]*(\d{3})[-. ]*(\d{4})(?: *x(\d+))?\s*$`   
Required: No

## See Also
<a name="API_PickupDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/PickupDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/PickupDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/PickupDetails) 

# S3OnDeviceServiceConfiguration
<a name="API_S3OnDeviceServiceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Amazon S3 compatible storage on Snowball Edge devices configuration items.

## Contents
<a name="API_S3OnDeviceServiceConfiguration_Contents"></a>

 ** FaultTolerance **   <a name="Snowball-Type-S3OnDeviceServiceConfiguration-FaultTolerance"></a>
>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 Snowball Edge devices service configuration.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 4.  
Required: No

 ** ServiceSize **   <a name="Snowball-Type-S3OnDeviceServiceConfiguration-ServiceSize"></a>
Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snowball Edge devices. If specified, the other input can be omitted.  
Type: Integer  
Valid Range: Minimum value of 3. Maximum value of 16.  
Required: No

 ** StorageLimit **   <a name="Snowball-Type-S3OnDeviceServiceConfiguration-StorageLimit"></a>
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.  
Type: Double  
Valid Range: Minimum value of 0.0.  
Required: No

 ** StorageUnit **   <a name="Snowball-Type-S3OnDeviceServiceConfiguration-StorageUnit"></a>
Storage unit. Currently the only supported unit is TB.  
Type: String  
Valid Values: `TB`   
Required: No

## See Also
<a name="API_S3OnDeviceServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/S3OnDeviceServiceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/S3OnDeviceServiceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/S3OnDeviceServiceConfiguration) 

# S3Resource
<a name="API_S3Resource"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Each `S3Resource` object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional `KeyRange` value. 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.

## Contents
<a name="API_S3Resource_Contents"></a>

 ** BucketArn **   <a name="Snowball-Type-S3Resource-BucketArn"></a>
The Amazon Resource Name (ARN) of an Amazon S3 bucket.  
Type: String  
Length Constraints: Maximum length of 255.  
Pattern: `arn:aws.*:*`   
Required: No

 ** KeyRange **   <a name="Snowball-Type-S3Resource-KeyRange"></a>
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.  
Type: [KeyRange](API_KeyRange.md) object  
Required: No

 ** TargetOnDeviceServices **   <a name="Snowball-Type-S3Resource-TargetOnDeviceServices"></a>
Specifies the service or services on the Snowball Edge device that your transferred data will be exported from or imported into. Amazon Snowball Edge supports Amazon S3 and NFS (Network File System).  
Type: Array of [TargetOnDeviceService](API_TargetOnDeviceService.md) objects  
Required: No

## See Also
<a name="API_S3Resource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/S3Resource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/S3Resource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/S3Resource) 

# ServiceVersion
<a name="API_ServiceVersion"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The version of the requested service.

## Contents
<a name="API_ServiceVersion_Contents"></a>

 ** Version **   <a name="Snowball-Type-ServiceVersion-Version"></a>
The version number of the requested service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_ServiceVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/ServiceVersion) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/ServiceVersion) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/ServiceVersion) 

# Shipment
<a name="API_Shipment"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The `Status` and `TrackingNumber` information for an inbound or outbound shipment.

## Contents
<a name="API_Shipment_Contents"></a>

 ** Status **   <a name="Snowball-Type-Shipment-Status"></a>
Status information for a shipment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

 ** TrackingNumber **   <a name="Snowball-Type-Shipment-TrackingNumber"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_Shipment_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/Shipment) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/Shipment) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/Shipment) 

# ShippingDetails
<a name="API_ShippingDetails"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

## Contents
<a name="API_ShippingDetails_Contents"></a>

 ** InboundShipment **   <a name="Snowball-Type-ShippingDetails-InboundShipment"></a>
The `Status` and `TrackingNumber` values for a Snow device being returned to Amazon for a particular job.  
Type: [Shipment](API_Shipment.md) object  
Required: No

 ** OutboundShipment **   <a name="Snowball-Type-ShippingDetails-OutboundShipment"></a>
The `Status` and `TrackingNumber` values for a Snow device being delivered to the address that you specified for a particular job.  
Type: [Shipment](API_Shipment.md) object  
Required: No

 ** ShippingOption **   <a name="Snowball-Type-ShippingDetails-ShippingOption"></a>
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.
Type: String  
Valid Values: `SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD`   
Required: No

## See Also
<a name="API_ShippingDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/ShippingDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/ShippingDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/ShippingDetails) 

# SnowconeDeviceConfiguration
<a name="API_SnowconeDeviceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Specifies the device configuration for an Amazon Snowball Edge job.

## Contents
<a name="API_SnowconeDeviceConfiguration_Contents"></a>

 ** WirelessConnection **   <a name="Snowball-Type-SnowconeDeviceConfiguration-WirelessConnection"></a>
Configures the wireless connection for the Snowball Edge device.  
Type: [WirelessConnection](API_WirelessConnection.md) object  
Required: No

## See Also
<a name="API_SnowconeDeviceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/SnowconeDeviceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/SnowconeDeviceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/SnowconeDeviceConfiguration) 

# TargetOnDeviceService
<a name="API_TargetOnDeviceService"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

An object that represents the service or services on the Snowball Edge device that your transferred data will be exported from or imported into. Amazon Snowball Edge supports Amazon S3 and NFS (Network File System).

## Contents
<a name="API_TargetOnDeviceService_Contents"></a>

 ** ServiceName **   <a name="Snowball-Type-TargetOnDeviceService-ServiceName"></a>
Specifies the name of the service on the Snowball Edge device that your transferred data will be exported from or imported into.  
Type: String  
Valid Values: `NFS_ON_DEVICE_SERVICE | S3_ON_DEVICE_SERVICE`   
Required: No

 ** TransferOption **   <a name="Snowball-Type-TargetOnDeviceService-TransferOption"></a>
Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.  
Type: String  
Valid Values: `IMPORT | EXPORT | LOCAL_USE`   
Required: No

## See Also
<a name="API_TargetOnDeviceService_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/TargetOnDeviceService) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/TargetOnDeviceService) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/TargetOnDeviceService) 

# TaxDocuments
<a name="API_TaxDocuments"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

The tax documents required in your Amazon Web Services Region.

## Contents
<a name="API_TaxDocuments_Contents"></a>

 ** IND **   <a name="Snowball-Type-TaxDocuments-IND"></a>
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).
The tax documents required in Amazon Web Services Region in India.  
Type: [INDTaxDocuments](API_INDTaxDocuments.md) object  
Required: No

## See Also
<a name="API_TaxDocuments_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/TaxDocuments) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/TaxDocuments) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/TaxDocuments) 

# TGWOnDeviceServiceConfiguration
<a name="API_TGWOnDeviceServiceConfiguration"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an Amazon Snowball Edge device.

**Note**  
The Tape Gateway service is no longer available on Snow Family devices.

## Contents
<a name="API_TGWOnDeviceServiceConfiguration_Contents"></a>

 ** StorageLimit **   <a name="Snowball-Type-TGWOnDeviceServiceConfiguration-StorageLimit"></a>
The maximum number of virtual tapes to store on one Snowball Edge device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.  
The Tape Gateway service is no longer available on Snow Family devices.
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** StorageUnit **   <a name="Snowball-Type-TGWOnDeviceServiceConfiguration-StorageUnit"></a>
The scale unit of the virtual tapes on the device.  
The Tape Gateway service is no longer available on Snow Family devices.
Type: String  
Valid Values: `TB`   
Required: No

## See Also
<a name="API_TGWOnDeviceServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/TGWOnDeviceServiceConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/TGWOnDeviceServiceConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/TGWOnDeviceServiceConfiguration) 

# WirelessConnection
<a name="API_WirelessConnection"></a>

**Note**  
 Amazon Snowball Edge is no longer available to new customers. New customers should explore [Amazon DataSync](https://aws.amazon.com/datasync/) for online transfers, [Amazon Data Transfer Terminal](https://aws.amazon.com/data-transfer-terminal/) for secure physical transfers, or Amazon Partner solutions. For edge computing, explore [Amazon Outposts](https://aws.amazon.com/outposts/).

Configures the wireless connection on an Amazon Snowball Edge device.

## Contents
<a name="API_WirelessConnection_Contents"></a>

 ** IsWifiEnabled **   <a name="Snowball-Type-WirelessConnection-IsWifiEnabled"></a>
Enables the Wi-Fi adapter on an Amazon Snowball Edge device.  
Type: Boolean  
Required: No

## See Also
<a name="API_WirelessConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snowball-2016-06-30/WirelessConnection) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snowball-2016-06-30/WirelessConnection) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snowball-2016-06-30/WirelessConnection) 

# Amazon Snowball Edge Device Management
<a name="API_Types_AWS_Snow_Device_Management"></a>

The following data types are supported by Amazon Snowball Edge Device Management:
+  [Capacity](API_devicemanagement_Capacity.md) 
+  [Command](API_devicemanagement_Command.md) 
+  [CpuOptions](API_devicemanagement_CpuOptions.md) 
+  [DeviceSummary](API_devicemanagement_DeviceSummary.md) 
+  [EbsInstanceBlockDevice](API_devicemanagement_EbsInstanceBlockDevice.md) 
+  [ExecutionSummary](API_devicemanagement_ExecutionSummary.md) 
+  [Instance](API_devicemanagement_Instance.md) 
+  [InstanceBlockDeviceMapping](API_devicemanagement_InstanceBlockDeviceMapping.md) 
+  [InstanceState](API_devicemanagement_InstanceState.md) 
+  [InstanceSummary](API_devicemanagement_InstanceSummary.md) 
+  [PhysicalNetworkInterface](API_devicemanagement_PhysicalNetworkInterface.md) 
+  [Reboot](API_devicemanagement_Reboot.md) 
+  [ResourceSummary](API_devicemanagement_ResourceSummary.md) 
+  [SecurityGroupIdentifier](API_devicemanagement_SecurityGroupIdentifier.md) 
+  [SoftwareInformation](API_devicemanagement_SoftwareInformation.md) 
+  [TaskSummary](API_devicemanagement_TaskSummary.md) 
+  [Unlock](API_devicemanagement_Unlock.md) 

# Capacity
<a name="API_devicemanagement_Capacity"></a>

The physical capacity of the Amazon Snow Family device. 

## Contents
<a name="API_devicemanagement_Capacity_Contents"></a>

 ** available **   <a name="Snowball-Type-devicemanagement_Capacity-available"></a>
The amount of capacity available for use on the device.  
Type: Long  
Required: No

 ** name **   <a name="Snowball-Type-devicemanagement_Capacity-name"></a>
The name of the type of capacity, such as memory.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: No

 ** total **   <a name="Snowball-Type-devicemanagement_Capacity-total"></a>
The total capacity on the device.  
Type: Long  
Required: No

 ** unit **   <a name="Snowball-Type-devicemanagement_Capacity-unit"></a>
The unit of measure for the type of capacity.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 20.  
Required: No

 ** used **   <a name="Snowball-Type-devicemanagement_Capacity-used"></a>
The amount of capacity used on the device.  
Type: Long  
Required: No

## See Also
<a name="API_devicemanagement_Capacity_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/Capacity) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/Capacity) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/Capacity) 

# Command
<a name="API_devicemanagement_Command"></a>

The command given to the device to execute.

## Contents
<a name="API_devicemanagement_Command_Contents"></a>

**Important**  
This data type is a UNION, so only one of the following members can be specified when used or returned.

 ** reboot **   <a name="Snowball-Type-devicemanagement_Command-reboot"></a>
Reboots the device.  
Type: [Reboot](API_devicemanagement_Reboot.md) object  
Required: No

 ** unlock **   <a name="Snowball-Type-devicemanagement_Command-unlock"></a>
Unlocks the device.  
Type: [Unlock](API_devicemanagement_Unlock.md) object  
Required: No

## See Also
<a name="API_devicemanagement_Command_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/Command) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/Command) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/Command) 

# CpuOptions
<a name="API_devicemanagement_CpuOptions"></a>

The options for how a device's CPU is configured.

## Contents
<a name="API_devicemanagement_CpuOptions_Contents"></a>

 ** coreCount **   <a name="Snowball-Type-devicemanagement_CpuOptions-coreCount"></a>
The number of cores that the CPU can use.  
Type: Integer  
Required: No

 ** threadsPerCore **   <a name="Snowball-Type-devicemanagement_CpuOptions-threadsPerCore"></a>
The number of threads per core in the CPU.  
Type: Integer  
Required: No

## See Also
<a name="API_devicemanagement_CpuOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/CpuOptions) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/CpuOptions) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/CpuOptions) 

# DeviceSummary
<a name="API_devicemanagement_DeviceSummary"></a>

Identifying information about the device.

## Contents
<a name="API_devicemanagement_DeviceSummary_Contents"></a>

 ** associatedWithJob **   <a name="Snowball-Type-devicemanagement_DeviceSummary-associatedWithJob"></a>
The ID of the job used to order the device.  
Type: String  
Required: No

 ** managedDeviceArn **   <a name="Snowball-Type-devicemanagement_DeviceSummary-managedDeviceArn"></a>
The Amazon Resource Name (ARN) of the device.  
Type: String  
Required: No

 ** managedDeviceId **   <a name="Snowball-Type-devicemanagement_DeviceSummary-managedDeviceId"></a>
The ID of the device.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** tags **   <a name="Snowball-Type-devicemanagement_DeviceSummary-tags"></a>
Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.  
Type: String to string map  
Required: No

## See Also
<a name="API_devicemanagement_DeviceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/DeviceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/DeviceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/DeviceSummary) 

# EbsInstanceBlockDevice
<a name="API_devicemanagement_EbsInstanceBlockDevice"></a>

Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.

## Contents
<a name="API_devicemanagement_EbsInstanceBlockDevice_Contents"></a>

 ** attachTime **   <a name="Snowball-Type-devicemanagement_EbsInstanceBlockDevice-attachTime"></a>
When the attachment was initiated.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   <a name="Snowball-Type-devicemanagement_EbsInstanceBlockDevice-deleteOnTermination"></a>
A value that indicates whether the volume is deleted on instance termination.  
Type: Boolean  
Required: No

 ** status **   <a name="Snowball-Type-devicemanagement_EbsInstanceBlockDevice-status"></a>
The attachment state.  
Type: String  
Valid Values: `ATTACHING | ATTACHED | DETACHING | DETACHED`   
Required: No

 ** volumeId **   <a name="Snowball-Type-devicemanagement_EbsInstanceBlockDevice-volumeId"></a>
The ID of the Amazon EBS volume.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_EbsInstanceBlockDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/EbsInstanceBlockDevice) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/EbsInstanceBlockDevice) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/EbsInstanceBlockDevice) 

# ExecutionSummary
<a name="API_devicemanagement_ExecutionSummary"></a>

The summary of a task execution on a specified device.

## Contents
<a name="API_devicemanagement_ExecutionSummary_Contents"></a>

 ** executionId **   <a name="Snowball-Type-devicemanagement_ExecutionSummary-executionId"></a>
The ID of the execution.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** managedDeviceId **   <a name="Snowball-Type-devicemanagement_ExecutionSummary-managedDeviceId"></a>
The ID of the managed device that the task is being executed on.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** state **   <a name="Snowball-Type-devicemanagement_ExecutionSummary-state"></a>
The state of the execution.  
Type: String  
Valid Values: `QUEUED | IN_PROGRESS | CANCELED | FAILED | SUCCEEDED | REJECTED | TIMED_OUT`   
Required: No

 ** taskId **   <a name="Snowball-Type-devicemanagement_ExecutionSummary-taskId"></a>
The ID of the task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_devicemanagement_ExecutionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/ExecutionSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/ExecutionSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/ExecutionSummary) 

# Instance
<a name="API_devicemanagement_Instance"></a>

The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.

## Contents
<a name="API_devicemanagement_Instance_Contents"></a>

 ** amiLaunchIndex **   <a name="Snowball-Type-devicemanagement_Instance-amiLaunchIndex"></a>
The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.   
Type: Integer  
Required: No

 ** blockDeviceMappings **   <a name="Snowball-Type-devicemanagement_Instance-blockDeviceMappings"></a>
Any block device mapping entries for the instance.  
Type: Array of [InstanceBlockDeviceMapping](API_devicemanagement_InstanceBlockDeviceMapping.md) objects  
Required: No

 ** cpuOptions **   <a name="Snowball-Type-devicemanagement_Instance-cpuOptions"></a>
The CPU options for the instance.  
Type: [CpuOptions](API_devicemanagement_CpuOptions.md) object  
Required: No

 ** createdAt **   <a name="Snowball-Type-devicemanagement_Instance-createdAt"></a>
When the instance was created.  
Type: Timestamp  
Required: No

 ** imageId **   <a name="Snowball-Type-devicemanagement_Instance-imageId"></a>
The ID of the AMI used to launch the instance.  
Type: String  
Required: No

 ** instanceId **   <a name="Snowball-Type-devicemanagement_Instance-instanceId"></a>
The ID of the instance.  
Type: String  
Required: No

 ** instanceType **   <a name="Snowball-Type-devicemanagement_Instance-instanceType"></a>
The instance type.  
Type: String  
Required: No

 ** privateIpAddress **   <a name="Snowball-Type-devicemanagement_Instance-privateIpAddress"></a>
The private IPv4 address assigned to the instance.  
Type: String  
Required: No

 ** publicIpAddress **   <a name="Snowball-Type-devicemanagement_Instance-publicIpAddress"></a>
The public IPv4 address assigned to the instance.  
Type: String  
Required: No

 ** rootDeviceName **   <a name="Snowball-Type-devicemanagement_Instance-rootDeviceName"></a>
The device name of the root device volume (for example, `/dev/sda1`).   
Type: String  
Required: No

 ** securityGroups **   <a name="Snowball-Type-devicemanagement_Instance-securityGroups"></a>
The security groups for the instance.  
Type: Array of [SecurityGroupIdentifier](API_devicemanagement_SecurityGroupIdentifier.md) objects  
Required: No

 ** state **   <a name="Snowball-Type-devicemanagement_Instance-state"></a>
The description of the current state of an instance.  
Type: [InstanceState](API_devicemanagement_InstanceState.md) object  
Required: No

 ** updatedAt **   <a name="Snowball-Type-devicemanagement_Instance-updatedAt"></a>
When the instance was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_devicemanagement_Instance_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/Instance) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/Instance) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/Instance) 

# InstanceBlockDeviceMapping
<a name="API_devicemanagement_InstanceBlockDeviceMapping"></a>

The description of a block device mapping.

## Contents
<a name="API_devicemanagement_InstanceBlockDeviceMapping_Contents"></a>

 ** deviceName **   <a name="Snowball-Type-devicemanagement_InstanceBlockDeviceMapping-deviceName"></a>
The block device name.  
Type: String  
Required: No

 ** ebs **   <a name="Snowball-Type-devicemanagement_InstanceBlockDeviceMapping-ebs"></a>
The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.   
Type: [EbsInstanceBlockDevice](API_devicemanagement_EbsInstanceBlockDevice.md) object  
Required: No

## See Also
<a name="API_devicemanagement_InstanceBlockDeviceMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/InstanceBlockDeviceMapping) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/InstanceBlockDeviceMapping) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/InstanceBlockDeviceMapping) 

# InstanceState
<a name="API_devicemanagement_InstanceState"></a>

The description of the current state of an instance.

## Contents
<a name="API_devicemanagement_InstanceState_Contents"></a>

 ** code **   <a name="Snowball-Type-devicemanagement_InstanceState-code"></a>
The state of the instance as a 16-bit unsigned integer.   
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.   
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.   
The valid values for the instance state code are all in the range of the low byte. These values are:   
+  `0` : `pending` 
+  `16` : `running` 
+  `32` : `shutting-down` 
+  `48` : `terminated` 
+  `64` : `stopping` 
+  `80` : `stopped` 
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.   
Type: Integer  
Required: No

 ** name **   <a name="Snowball-Type-devicemanagement_InstanceState-name"></a>
The current state of the instance.  
Type: String  
Valid Values: `PENDING | RUNNING | SHUTTING_DOWN | TERMINATED | STOPPING | STOPPED`   
Required: No

## See Also
<a name="API_devicemanagement_InstanceState_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/InstanceState) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/InstanceState) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/InstanceState) 

# InstanceSummary
<a name="API_devicemanagement_InstanceSummary"></a>

The details about the instance.

## Contents
<a name="API_devicemanagement_InstanceSummary_Contents"></a>

 ** instance **   <a name="Snowball-Type-devicemanagement_InstanceSummary-instance"></a>
A structure containing details about the instance.  
Type: [Instance](API_devicemanagement_Instance.md) object  
Required: No

 ** lastUpdatedAt **   <a name="Snowball-Type-devicemanagement_InstanceSummary-lastUpdatedAt"></a>
When the instance summary was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_devicemanagement_InstanceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/InstanceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/InstanceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/InstanceSummary) 

# PhysicalNetworkInterface
<a name="API_devicemanagement_PhysicalNetworkInterface"></a>

The details about the physical network interface for the device.

## Contents
<a name="API_devicemanagement_PhysicalNetworkInterface_Contents"></a>

 ** defaultGateway **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-defaultGateway"></a>
The default gateway of the device.  
Type: String  
Required: No

 ** ipAddress **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-ipAddress"></a>
The IP address of the device.  
Type: String  
Required: No

 ** ipAddressAssignment **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-ipAddressAssignment"></a>
A value that describes whether the IP address is dynamic or persistent.  
Type: String  
Valid Values: `DHCP | STATIC`   
Required: No

 ** macAddress **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-macAddress"></a>
The MAC address of the device.  
Type: String  
Required: No

 ** netmask **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-netmask"></a>
The netmask used to divide the IP address into subnets.  
Type: String  
Required: No

 ** physicalConnectorType **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-physicalConnectorType"></a>
The physical connector type.  
Type: String  
Valid Values: `RJ45 | SFP_PLUS | QSFP | RJ45_2 | WIFI`   
Required: No

 ** physicalNetworkInterfaceId **   <a name="Snowball-Type-devicemanagement_PhysicalNetworkInterface-physicalNetworkInterfaceId"></a>
The physical network interface ID.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_PhysicalNetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/PhysicalNetworkInterface) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/PhysicalNetworkInterface) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/PhysicalNetworkInterface) 

# Reboot
<a name="API_devicemanagement_Reboot"></a>

A structure used to reboot the device.

## Contents
<a name="API_devicemanagement_Reboot_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_devicemanagement_Reboot_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/Reboot) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/Reboot) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/Reboot) 

# ResourceSummary
<a name="API_devicemanagement_ResourceSummary"></a>

A summary of a resource available on the device.

## Contents
<a name="API_devicemanagement_ResourceSummary_Contents"></a>

 ** resourceType **   <a name="Snowball-Type-devicemanagement_ResourceSummary-resourceType"></a>
The resource type.  
Type: String  
Required: Yes

 ** arn **   <a name="Snowball-Type-devicemanagement_ResourceSummary-arn"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Required: No

 ** id **   <a name="Snowball-Type-devicemanagement_ResourceSummary-id"></a>
The ID of the resource.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_ResourceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/ResourceSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/ResourceSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/ResourceSummary) 

# SecurityGroupIdentifier
<a name="API_devicemanagement_SecurityGroupIdentifier"></a>

Information about the device's security group.

## Contents
<a name="API_devicemanagement_SecurityGroupIdentifier_Contents"></a>

 ** groupId **   <a name="Snowball-Type-devicemanagement_SecurityGroupIdentifier-groupId"></a>
The security group ID.  
Type: String  
Required: No

 ** groupName **   <a name="Snowball-Type-devicemanagement_SecurityGroupIdentifier-groupName"></a>
The security group name.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_SecurityGroupIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/SecurityGroupIdentifier) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/SecurityGroupIdentifier) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/SecurityGroupIdentifier) 

# SoftwareInformation
<a name="API_devicemanagement_SoftwareInformation"></a>

Information about the software on the device.

## Contents
<a name="API_devicemanagement_SoftwareInformation_Contents"></a>

 ** installedVersion **   <a name="Snowball-Type-devicemanagement_SoftwareInformation-installedVersion"></a>
The version of the software currently installed on the device.  
Type: String  
Required: No

 ** installingVersion **   <a name="Snowball-Type-devicemanagement_SoftwareInformation-installingVersion"></a>
The version of the software being installed on the device.  
Type: String  
Required: No

 ** installState **   <a name="Snowball-Type-devicemanagement_SoftwareInformation-installState"></a>
The state of the software that is installed or that is being installed on the device.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_SoftwareInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/SoftwareInformation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/SoftwareInformation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/SoftwareInformation) 

# TaskSummary
<a name="API_devicemanagement_TaskSummary"></a>

Information about the task assigned to one or many devices.

## Contents
<a name="API_devicemanagement_TaskSummary_Contents"></a>

 ** taskId **   <a name="Snowball-Type-devicemanagement_TaskSummary-taskId"></a>
The task ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** state **   <a name="Snowball-Type-devicemanagement_TaskSummary-state"></a>
The state of the task assigned to one or many devices.  
Type: String  
Valid Values: `IN_PROGRESS | CANCELED | COMPLETED`   
Required: No

 ** tags **   <a name="Snowball-Type-devicemanagement_TaskSummary-tags"></a>
Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.  
Type: String to string map  
Required: No

 ** taskArn **   <a name="Snowball-Type-devicemanagement_TaskSummary-taskArn"></a>
The Amazon Resource Name (ARN) of the task.  
Type: String  
Required: No

## See Also
<a name="API_devicemanagement_TaskSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/TaskSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/TaskSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/TaskSummary) 

# Unlock
<a name="API_devicemanagement_Unlock"></a>

A structure used to unlock a device.

## Contents
<a name="API_devicemanagement_Unlock_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_devicemanagement_Unlock_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/snow-device-management-2021-08-04/Unlock) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/snow-device-management-2021-08-04/Unlock) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/snow-device-management-2021-08-04/Unlock)