The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "taskId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
taskId (p. 79)
The ID of the task that you are attempting to cancel.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 175).
AccessDeniedException
You don't have sufficient access to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
The request references a resource that doesn't exist.
HTTP Status Code: 404 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateTask
CreateTask
Service: AWS Snow Device Management
Instructs one or more devices to start a task, such as unlocking or rebooting.
Request Syntax
POST /task HTTP/1.1
Content-type: application/json { "clientToken": "string", "command": {
"description": "string", "tags": {
"string" : "string"
},
"targets": [ "string" ] }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
clientToken (p. 81)
A token ensuring that the action is called only once with the specified details.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [!-~]+
Required: No command (p. 81)
The task to be performed. Only one task is executed on a device at a time.
Type: Command (p. 155) object Required: Yes
description (p. 81)
A description of the task and its targets.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [A-Za-z0-9 _.,!#]*
Required: No tags (p. 81)
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
targets (p. 81)
A list of managed device IDs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"taskArn": "string", "taskId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
taskArn (p. 82)
The Amazon Resource Name (ARN) of the task that you created.
Type: String taskId (p. 82)
The ID of the task that you created.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 175).
AccessDeniedException
You don't have sufficient access to perform this action.
HTTP Status Code: 403
CreateTask
InternalServerException
An unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
The request references a resource that doesn't exist.
HTTP Status Code: 404 ServiceQuotaExceededException
The request would cause a service quota to be exceeded.
HTTP Status Code: 402 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDevice
Service: AWS Snow Device Management
Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
Request Syntax
POST /managed-device/managedDeviceId/describe HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
managedDeviceId (p. 84)
The ID of the device that you are checking the information of.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "associatedWithJob": "string", "deviceCapacities": [
{
"deviceState": "string", "deviceType": "string", "lastReachedOutAt": number, "lastUpdatedAt": number, "managedDeviceArn": "string", "managedDeviceId": "string", "physicalNetworkInterfaces": [ {
"defaultGateway": "string", "ipAddress": "string",
"ipAddressAssignment": "string", "macAddress": "string",
"netmask": "string",
"physicalConnectorType": "string", "physicalNetworkInterfaceId": "string"
}
DescribeDevice
],
"software": {
"installedVersion": "string", "installingVersion": "string", "installState": "string"
},
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
associatedWithJob (p. 84)
The ID of the job used when ordering the device.
Type: String deviceCapacities (p. 84)
The hardware specifications of the device.
Type: Array of Capacity (p. 154) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
deviceState (p. 84)
The current state of the device.
Type: String
Valid Values: UNLOCKED | LOCKED | UNLOCKING deviceType (p. 84)
The type of AWS Snow Family device.
Type: String
lastReachedOutAt (p. 84)
When the device last contacted the AWS Cloud. Indicates that the device is online.
Type: Timestamp lastUpdatedAt (p. 84)
When the device last pushed an update to the AWS Cloud. Indicates when the device cache was refreshed.
Type: Timestamp managedDeviceArn (p. 84)
The Amazon Resource Name (ARN) of the device.
Type: String
managedDeviceId (p. 84)
The ID of the device that you checked the information for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
physicalNetworkInterfaces (p. 84)
The network interfaces available on the device.
Type: Array of PhysicalNetworkInterface (p. 165) objects software (p. 84)
The software installed on the device.
Type: SoftwareInformation (p. 170) object tags (p. 84)
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
Errors
For information about the errors that are common to all actions, see Common Errors (p. 175).
AccessDeniedException
You don't have sufficient access to perform this action.
HTTP Status Code: 403 InternalServerException
An unexpected error occurred while processing the request.
HTTP Status Code: 500 ResourceNotFoundException
The request references a resource that doesn't exist.
HTTP Status Code: 404 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 429 ValidationException
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
DescribeDevice
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3