Service: AWS Snowball
An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an AWS Snow Family device.
Contents
StorageLimit
The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
Type: Integer
Valid Range: Minimum value of 0.
Required: No StorageUnit
The scale unit of the virtual tapes on the device.
Type: String Valid Values: TB Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
WirelessConnection
WirelessConnection
Service: AWS Snowball
Configures the wireless connection on an AWS Snowcone device.
Contents
IsWifiEnabled
Enables the Wi-Fi adapter on an AWS Snowcone device.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AWS Snow Device Management
The following data types are supported by AWS Snow Device Management:
• Capacity (p. 154)
• Command (p. 155)
• CpuOptions (p. 156)
• DeviceSummary (p. 157)
• EbsInstanceBlockDevice (p. 158)
• ExecutionSummary (p. 159)
• Instance (p. 160)
• InstanceBlockDeviceMapping (p. 162)
• InstanceState (p. 163)
• InstanceSummary (p. 164)
• PhysicalNetworkInterface (p. 165)
• Reboot (p. 167)
• ResourceSummary (p. 168)
• SecurityGroupIdentifier (p. 169)
• SoftwareInformation (p. 170)
• TaskSummary (p. 171)
• Unlock (p. 172)
Capacity
Service: AWS Snow Device Management
The physical capacity of the AWS Snow Family device.
Contents
available
The amount of capacity available for use on the device.
Type: Long Required: No name
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
The total capacity on the device.
Type: Long Required: No unit
The unit of measure for the type of capacity.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 20.
Required: No used
The amount of capacity used on the device.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Command
Command
Service: AWS Snow Device Management The command given to the device to execute.
Contents
reboot
Reboots the device.
Type: Reboot (p. 167) object Required: No
unlock
Unlocks the device.
Type: Unlock (p. 172) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CpuOptions
Service: AWS Snow Device Management
The options for how a device's CPU is configured.
Contents
coreCount
The number of cores that the CPU can use.
Type: Integer Required: No threadsPerCore
The number of threads per core in the CPU.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DeviceSummary
DeviceSummary
Service: AWS Snow Device Management Identifying information about the device.
Contents
associatedWithJob
The ID of the job used to order the device.
Type: String Required: No managedDeviceArn
The Amazon Resource Name (ARN) of the device.
Type: String Required: No managedDeviceId
The ID of the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No tags
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EbsInstanceBlockDevice
Service: AWS Snow Device Management
Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.
Contents
attachTime
When the attachment was initiated.
Type: Timestamp Required: No deleteOnTermination
A value that indicates whether the volume is deleted on instance termination.
Type: Boolean Required: No status
The attachment state.
Type: String
Valid Values: ATTACHING | ATTACHED | DETACHING | DETACHED Required: No
volumeId
The ID of the Amazon EBS volume.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ExecutionSummary
ExecutionSummary
Service: AWS Snow Device Management
The summary of a task execution on a specified device.
Contents
executionId
The ID of the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No managedDeviceId
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
The state of the execution.
Type: String
Valid Values: QUEUED | IN_PROGRESS | CANCELED | FAILED | SUCCEEDED | REJECTED | TIMED_OUT
Required: No taskId
The ID of the task.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Instance
Service: AWS Snow Device Management
The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.
Contents
amiLaunchIndex
The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.
Type: Integer Required: No blockDeviceMappings
Any block device mapping entries for the instance.
Type: Array of InstanceBlockDeviceMapping (p. 162) objects Required: No
cpuOptions
The CPU options for the instance.
Type: CpuOptions (p. 156) object Required: No
createdAt
When the instance was created.
Type: Timestamp Required: No imageId
The ID of the AMI used to launch the instance.
Type: String Required: No instanceId
The ID of the instance.
Type: String Required: No instanceType
The instance type.
Type: String Required: No
Instance
privateIpAddress
The private IPv4 address assigned to the instance.
Type: String Required: No publicIpAddress
The public IPv4 address assigned to the instance.
Type: String Required: No rootDeviceName
The device name of the root device volume (for example, /dev/sda1).
Type: String Required: No securityGroups
The security groups for the instance.
Type: Array of SecurityGroupIdentifier (p. 169) objects Required: No
state
The description of the current state of an instance.
Type: InstanceState (p. 163) object Required: No
updatedAt
When the instance was last updated.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InstanceBlockDeviceMapping
Service: AWS Snow Device Management The description of a block device mapping.
Contents
deviceName
The block device name.
Type: String Required: No ebs
The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.
Type: EbsInstanceBlockDevice (p. 158) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InstanceState
InstanceState
Service: AWS Snow Device Management
The description of the current state of an instance.
Contents
code
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
The current state of the instance.
Type: String
Valid Values: PENDING | RUNNING | SHUTTING_DOWN | TERMINATED | STOPPING | STOPPED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InstanceSummary
Service: AWS Snow Device Management The details about the instance.
Contents
instance
A structure containing details about the instance.
Type: Instance (p. 160) object Required: No
lastUpdatedAt
When the instance summary was last updated.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PhysicalNetworkInterface
PhysicalNetworkInterface
Service: AWS Snow Device Management
The details about the physical network interface for the device.
Contents
defaultGateway
The default gateway of the device.
Type: String Required: No ipAddress
The IP address of the device.
Type: String Required: No ipAddressAssignment
A value that describes whether the IP address is dynamic or persistent.
Type: String
Valid Values: DHCP | STATIC Required: No
macAddress
The MAC address of the device.
Type: String Required: No netmask
The netmask used to divide the IP address into subnets.
Type: String Required: No physicalConnectorType
The physical connector type.
Type: String
Valid Values: RJ45 | SFP_PLUS | QSFP | RJ45_2 | WIFI Required: No
physicalNetworkInterfaceId
The physical network interface ID.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Reboot
Reboot
Service: AWS Snow Device Management A structure used to reboot the device.
Contents
The members of this structure are context-dependent.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourceSummary
Service: AWS Snow Device Management
A summary of a resource available on the device.
Contents
arn
The Amazon Resource Name (ARN) of the resource.
Type: String Required: No id
The ID of the resource.
Type: String Required: No resourceType
The resource type.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SecurityGroupIdentifier
SecurityGroupIdentifier
Service: AWS Snow Device Management Information about the device's security group.
Contents
groupId
The security group ID.
Type: String Required: No groupName
The security group name.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SoftwareInformation
Service: AWS Snow Device Management Information about the software on the device.
Contents
installedVersion
The version of the software currently installed on the device.
Type: String Required: No installingVersion
The version of the software being installed on the device.
Type: String Required: No installState
The state of the software that is installed or that is being installed on the device.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TaskSummary
TaskSummary
Service: AWS Snow Device Management
Information about the task assigned to one or many devices.
Contents
state
The state of the task assigned to one or many devices.
Type: String
Valid Values: IN_PROGRESS | CANCELED | COMPLETED Required: No
tags
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
The Amazon Resource Name (ARN) of the task.
Type: String Required: No taskId
The task ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Unlock
Service: AWS Snow Device Management A structure used to unlock a device.
Contents
The members of this structure are context-dependent.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3