Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.
A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.
Instructs one or more devices to start a task, such as unlocking or rebooting.
" + }, + "DescribeDevice":{ + "name":"DescribeDevice", + "http":{ + "method":"POST", + "requestUri":"/managed-device/{managedDeviceId}/describe", + "responseCode":200 + }, + "input":{"shape":"DescribeDeviceInput"}, + "output":{"shape":"DescribeDeviceOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Checks device-specific information, such as the device type, software version, IP addresses, and lock status.
" + }, + "DescribeDeviceEc2Instances":{ + "name":"DescribeDeviceEc2Instances", + "http":{ + "method":"POST", + "requestUri":"/managed-device/{managedDeviceId}/resources/ec2/describe", + "responseCode":200 + }, + "input":{"shape":"DescribeDeviceEc2Input"}, + "output":{"shape":"DescribeDeviceEc2Output"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.
Checks the status of a remote task running on one or more target devices.
" + }, + "DescribeTask":{ + "name":"DescribeTask", + "http":{ + "method":"POST", + "requestUri":"/task/{taskId}", + "responseCode":200 + }, + "input":{"shape":"DescribeTaskInput"}, + "output":{"shape":"DescribeTaskOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Checks the metadata for a given task on a device.
" + }, + "ListDeviceResources":{ + "name":"ListDeviceResources", + "http":{ + "method":"GET", + "requestUri":"/managed-device/{managedDeviceId}/resources", + "responseCode":200 + }, + "input":{"shape":"ListDeviceResourcesInput"}, + "output":{"shape":"ListDeviceResourcesOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.
" + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"GET", + "requestUri":"/managed-devices", + "responseCode":200 + }, + "input":{"shape":"ListDevicesInput"}, + "output":{"shape":"ListDevicesOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.
" + }, + "ListExecutions":{ + "name":"ListExecutions", + "http":{ + "method":"GET", + "requestUri":"/executions", + "responseCode":200 + }, + "input":{"shape":"ListExecutionsInput"}, + "output":{"shape":"ListExecutionsOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns the status of tasks for one or more target devices.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Returns a list of tags for a managed device or task.
" + }, + "ListTasks":{ + "name":"ListTasks", + "http":{ + "method":"GET", + "requestUri":"/tasks", + "responseCode":200 + }, + "input":{"shape":"ListTasksInput"}, + "output":{"shape":"ListTasksOutput"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"Returns a list of tasks that can be filtered by state.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Adds or replaces tags on a device or task.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes a tag from a device or task.
", + "idempotent":true + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"You don't have sufficient access to perform this action.
", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "ATTACHING", + "ATTACHED", + "DETACHING", + "DETACHED" + ] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "CancelTaskInput":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.
The ID of the task that you are attempting to cancel.
" + } + } + }, + "Capacity":{ + "type":"structure", + "members":{ + "available":{ + "shape":"Long", + "documentation":"The amount of capacity available for use on the device.
" + }, + "name":{ + "shape":"CapacityNameString", + "documentation":"The name of the type of capacity, such as memory.
" + }, + "total":{ + "shape":"Long", + "documentation":"The total capacity on the device.
" + }, + "unit":{ + "shape":"CapacityUnitString", + "documentation":"The unit of measure for the type of capacity.
" + }, + "used":{ + "shape":"Long", + "documentation":"The amount of capacity used on the device.
" + } + }, + "documentation":"The physical capacity of the Amazon Web Services Snow Family device.
" + }, + "CapacityList":{ + "type":"list", + "member":{"shape":"Capacity"}, + "max":100, + "min":0 + }, + "CapacityNameString":{ + "type":"string", + "max":100, + "min":0 + }, + "CapacityUnitString":{ + "type":"string", + "max":20, + "min":0 + }, + "Command":{ + "type":"structure", + "members":{ + "reboot":{ + "shape":"Reboot", + "documentation":"Reboots the device.
" + }, + "unlock":{ + "shape":"Unlock", + "documentation":"Unlocks the device.
" + } + }, + "documentation":"The command given to the device to execute.
", + "union":true + }, + "CpuOptions":{ + "type":"structure", + "members":{ + "coreCount":{ + "shape":"Integer", + "documentation":"The number of cores that the CPU can use.
" + }, + "threadsPerCore":{ + "shape":"Integer", + "documentation":"The number of threads per core in the CPU.
" + } + }, + "documentation":"The options for how a device's CPU is configured.
" + }, + "CreateTaskInput":{ + "type":"structure", + "required":[ + "command", + "targets" + ], + "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A token ensuring that the action is called only once with the specified details.
", + "idempotencyToken":true + }, + "command":{ + "shape":"Command", + "documentation":"The task to be performed. Only one task is executed on a device at a time.
" + }, + "description":{ + "shape":"TaskDescriptionString", + "documentation":"A description of the task and its targets.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + }, + "targets":{ + "shape":"TargetList", + "documentation":"A list of managed device IDs.
" + } + } + }, + "CreateTaskOutput":{ + "type":"structure", + "members":{ + "taskArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the task that you created.
" + }, + "taskId":{ + "shape":"String", + "documentation":"The ID of the task that you created.
" + } + } + }, + "DescribeDeviceEc2Input":{ + "type":"structure", + "required":[ + "instanceIds", + "managedDeviceId" + ], + "members":{ + "instanceIds":{ + "shape":"InstanceIdsList", + "documentation":"A list of instance IDs associated with the managed device.
" + }, + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the managed device.
", + "location":"uri", + "locationName":"managedDeviceId" + } + } + }, + "DescribeDeviceEc2Output":{ + "type":"structure", + "members":{ + "instances":{ + "shape":"InstanceSummaryList", + "documentation":"A list of structures containing information about each instance.
" + } + } + }, + "DescribeDeviceInput":{ + "type":"structure", + "required":["managedDeviceId"], + "members":{ + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the device that you are checking the information of.
", + "location":"uri", + "locationName":"managedDeviceId" + } + } + }, + "DescribeDeviceOutput":{ + "type":"structure", + "members":{ + "associatedWithJob":{ + "shape":"String", + "documentation":"The ID of the job used when ordering the device.
" + }, + "deviceCapacities":{ + "shape":"CapacityList", + "documentation":"The hardware specifications of the device.
" + }, + "deviceState":{ + "shape":"UnlockState", + "documentation":"The current state of the device.
" + }, + "deviceType":{ + "shape":"String", + "documentation":"The type of Amazon Web Services Snow Family device.
" + }, + "lastReachedOutAt":{ + "shape":"Timestamp", + "documentation":"When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.
" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.
" + }, + "managedDeviceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the device.
" + }, + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the device that you checked the information for.
" + }, + "physicalNetworkInterfaces":{ + "shape":"PhysicalNetworkInterfaceList", + "documentation":"The network interfaces available on the device.
" + }, + "software":{ + "shape":"SoftwareInformation", + "documentation":"The software installed on the device.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + } + } + }, + "DescribeExecutionInput":{ + "type":"structure", + "required":[ + "managedDeviceId", + "taskId" + ], + "members":{ + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the managed device.
", + "location":"uri", + "locationName":"managedDeviceId" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task that the action is describing.
", + "location":"uri", + "locationName":"taskId" + } + } + }, + "DescribeExecutionOutput":{ + "type":"structure", + "members":{ + "executionId":{ + "shape":"ExecutionId", + "documentation":"The ID of the execution.
" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"When the status of the execution was last updated.
" + }, + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the managed device that the task is being executed on.
" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"When the execution began.
" + }, + "state":{ + "shape":"ExecutionState", + "documentation":"The current state of the execution.
" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task being executed on the device.
" + } + } + }, + "DescribeTaskInput":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task to be described.
", + "location":"uri", + "locationName":"taskId" + } + } + }, + "DescribeTaskOutput":{ + "type":"structure", + "members":{ + "completedAt":{ + "shape":"Timestamp", + "documentation":"When the task was completed.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"When the CreateTask operation was called.
The description provided of the task and managed devices.
" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"When the state of the task was last updated.
" + }, + "state":{ + "shape":"TaskState", + "documentation":"The current state of the task.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + }, + "targets":{ + "shape":"TargetList", + "documentation":"The managed devices that the task was sent to.
" + }, + "taskArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the task.
" + }, + "taskId":{ + "shape":"String", + "documentation":"The ID of the task.
" + } + } + }, + "DeviceSummary":{ + "type":"structure", + "members":{ + "associatedWithJob":{ + "shape":"String", + "documentation":"The ID of the job used to order the device.
" + }, + "managedDeviceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the device.
" + }, + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the device.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + } + }, + "documentation":"Identifying information about the device.
" + }, + "DeviceSummaryList":{ + "type":"list", + "member":{"shape":"DeviceSummary"} + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "attachTime":{ + "shape":"Timestamp", + "documentation":"When the attachment was initiated.
" + }, + "deleteOnTermination":{ + "shape":"Boolean", + "documentation":"A value that indicates whether the volume is deleted on instance termination.
" + }, + "status":{ + "shape":"AttachmentStatus", + "documentation":"The attachment state.
" + }, + "volumeId":{ + "shape":"String", + "documentation":"The ID of the Amazon EBS volume.
" + } + }, + "documentation":"Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.
" + }, + "ExecutionId":{ + "type":"string", + "max":64, + "min":1 + }, + "ExecutionState":{ + "type":"string", + "enum":[ + "QUEUED", + "IN_PROGRESS", + "CANCELED", + "FAILED", + "SUCCEEDED", + "REJECTED", + "TIMED_OUT" + ] + }, + "ExecutionSummary":{ + "type":"structure", + "members":{ + "executionId":{ + "shape":"ExecutionId", + "documentation":"The ID of the execution.
" + }, + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the managed device that the task is being executed on.
" + }, + "state":{ + "shape":"ExecutionState", + "documentation":"The state of the execution.
" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task.
" + } + }, + "documentation":"The summary of a task execution on a specified device.
" + }, + "ExecutionSummaryList":{ + "type":"list", + "member":{"shape":"ExecutionSummary"} + }, + "IdempotencyToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[!-~]+" + }, + "Instance":{ + "type":"structure", + "members":{ + "amiLaunchIndex":{ + "shape":"Integer", + "documentation":"The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.
" + }, + "blockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"Any block device mapping entries for the instance.
" + }, + "cpuOptions":{ + "shape":"CpuOptions", + "documentation":"The CPU options for the instance.
" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"When the instance was created.
" + }, + "imageId":{ + "shape":"String", + "documentation":"The ID of the AMI used to launch the instance.
" + }, + "instanceId":{ + "shape":"String", + "documentation":"The ID of the instance.
" + }, + "instanceType":{ + "shape":"String", + "documentation":"The instance type.
" + }, + "privateIpAddress":{ + "shape":"String", + "documentation":"The private IPv4 address assigned to the instance.
" + }, + "publicIpAddress":{ + "shape":"String", + "documentation":"The public IPv4 address assigned to the instance.
" + }, + "rootDeviceName":{ + "shape":"String", + "documentation":"The device name of the root device volume (for example, /dev/sda1).
The security groups for the instance.
" + }, + "state":{"shape":"InstanceState"}, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"When the instance was last updated.
" + } + }, + "documentation":"The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.
" + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "deviceName":{ + "shape":"String", + "documentation":"The block device name.
" + }, + "ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.
" + } + }, + "documentation":"The description of a block device mapping.
" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{"shape":"InstanceBlockDeviceMapping"} + }, + "InstanceIdsList":{ + "type":"list", + "member":{"shape":"String"} + }, + "InstanceState":{ + "type":"structure", + "members":{ + "code":{ + "shape":"Integer", + "documentation":"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.
" + }, + "name":{ + "shape":"InstanceStateName", + "documentation":"The current state of the instance.
" + } + }, + "documentation":"The description of the current state of an instance.
" + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "SHUTTING_DOWN", + "TERMINATED", + "STOPPING", + "STOPPED" + ] + }, + "InstanceSummary":{ + "type":"structure", + "members":{ + "instance":{ + "shape":"Instance", + "documentation":"A structure containing details about the instance.
" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"When the instance summary was last updated.
" + } + }, + "documentation":"The details about the instance.
" + }, + "InstanceSummaryList":{ + "type":"list", + "member":{"shape":"InstanceSummary"} + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"An unexpected error occurred while processing the request.
", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "retryable":{"throttling":false} + }, + "IpAddressAssignment":{ + "type":"string", + "enum":[ + "DHCP", + "STATIC" + ] + }, + "JobId":{ + "type":"string", + "max":64, + "min":1 + }, + "ListDeviceResourcesInput":{ + "type":"structure", + "required":["managedDeviceId"], + "members":{ + "managedDeviceId":{ + "shape":"ManagedDeviceId", + "documentation":"The ID of the managed device that you are listing the resources of.
", + "location":"uri", + "locationName":"managedDeviceId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of resources per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + }, + "type":{ + "shape":"ListDeviceResourcesInputTypeString", + "documentation":"A structure used to filter the results by type of resource.
", + "location":"querystring", + "locationName":"type" + } + } + }, + "ListDeviceResourcesInputTypeString":{ + "type":"string", + "max":50, + "min":1 + }, + "ListDeviceResourcesOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of results.
" + }, + "resources":{ + "shape":"ResourceSummaryList", + "documentation":"A structure defining the resource's type, Amazon Resource Name (ARN), and ID.
" + } + } + }, + "ListDevicesInput":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"The ID of the job used to order the device.
", + "location":"querystring", + "locationName":"jobId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of devices to list per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDevicesOutput":{ + "type":"structure", + "members":{ + "devices":{ + "shape":"DeviceSummaryList", + "documentation":"A list of device structures that contain information about the device.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of devices.
" + } + } + }, + "ListExecutionsInput":{ + "type":"structure", + "required":["taskId"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of tasks to list per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of tasks.
", + "location":"querystring", + "locationName":"nextToken" + }, + "state":{ + "shape":"ExecutionState", + "documentation":"A structure used to filter the tasks by their current state.
", + "location":"querystring", + "locationName":"state" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The ID of the task.
", + "location":"querystring", + "locationName":"taskId" + } + } + }, + "ListExecutionsOutput":{ + "type":"structure", + "members":{ + "executions":{ + "shape":"ExecutionSummaryList", + "documentation":"A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of executions.
" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the device or task.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The list of tags for the device or task.
" + } + } + }, + "ListTasksInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of tasks per page.
", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of tasks.
", + "location":"querystring", + "locationName":"nextToken" + }, + "state":{ + "shape":"TaskState", + "documentation":"A structure used to filter the list of tasks.
", + "location":"querystring", + "locationName":"state" + } + } + }, + "ListTasksOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"A pagination token to continue to the next page of tasks.
" + }, + "tasks":{ + "shape":"TaskSummaryList", + "documentation":"A list of task structures containing details about each task.
" + } + } + }, + "Long":{ + "type":"long", + "box":true + }, + "ManagedDeviceId":{ + "type":"string", + "max":64, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[a-zA-Z0-9+/=]*" + }, + "PhysicalConnectorType":{ + "type":"string", + "enum":[ + "RJ45", + "SFP_PLUS", + "QSFP", + "RJ45_2", + "WIFI" + ] + }, + "PhysicalNetworkInterface":{ + "type":"structure", + "members":{ + "defaultGateway":{ + "shape":"String", + "documentation":"The default gateway of the device.
" + }, + "ipAddress":{ + "shape":"String", + "documentation":"The IP address of the device.
" + }, + "ipAddressAssignment":{ + "shape":"IpAddressAssignment", + "documentation":"A value that describes whether the IP address is dynamic or persistent.
" + }, + "macAddress":{ + "shape":"String", + "documentation":"The MAC address of the device.
" + }, + "netmask":{ + "shape":"String", + "documentation":"The netmask used to divide the IP address into subnets.
" + }, + "physicalConnectorType":{ + "shape":"PhysicalConnectorType", + "documentation":"The physical connector type.
" + }, + "physicalNetworkInterfaceId":{ + "shape":"String", + "documentation":"The physical network interface ID.
" + } + }, + "documentation":"The details about the physical network interface for the device.
" + }, + "PhysicalNetworkInterfaceList":{ + "type":"list", + "member":{"shape":"PhysicalNetworkInterface"} + }, + "Reboot":{ + "type":"structure", + "members":{ + }, + "documentation":"A structure used to reboot the device.
" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request references a resource that doesn't exist.
", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceSummary":{ + "type":"structure", + "required":["resourceType"], + "members":{ + "arn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource.
" + }, + "id":{ + "shape":"String", + "documentation":"The ID of the resource.
" + }, + "resourceType":{ + "shape":"String", + "documentation":"The resource type.
" + } + }, + "documentation":"A summary of a resource available on the device.
" + }, + "ResourceSummaryList":{ + "type":"list", + "member":{"shape":"ResourceSummary"} + }, + "SecurityGroupIdentifier":{ + "type":"structure", + "members":{ + "groupId":{ + "shape":"String", + "documentation":"The security group ID.
" + }, + "groupName":{ + "shape":"String", + "documentation":"The security group name.
" + } + }, + "documentation":"Information about the device's security group.
" + }, + "SecurityGroupIdentifierList":{ + "type":"list", + "member":{"shape":"SecurityGroupIdentifier"} + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request would cause a service quota to be exceeded.
", + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SoftwareInformation":{ + "type":"structure", + "members":{ + "installState":{ + "shape":"String", + "documentation":"The state of the software that is installed or that is being installed on the device.
" + }, + "installedVersion":{ + "shape":"String", + "documentation":"The version of the software currently installed on the device.
" + }, + "installingVersion":{ + "shape":"String", + "documentation":"The version of the software being installed on the device.
" + } + }, + "documentation":"Information about the software on the device.
" + }, + "String":{"type":"string"}, + "TagKeys":{ + "type":"list", + "member":{"shape":"String"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the device or task.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + } + } + }, + "TargetList":{ + "type":"list", + "member":{"shape":"String"}, + "max":10, + "min":1 + }, + "TaskDescriptionString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z0-9 _.,!#]*" + }, + "TaskId":{ + "type":"string", + "max":64, + "min":1 + }, + "TaskState":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "CANCELED", + "COMPLETED" + ] + }, + "TaskSummary":{ + "type":"structure", + "required":["taskId"], + "members":{ + "state":{ + "shape":"TaskState", + "documentation":"The state of the task assigned to one or many devices.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"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.
" + }, + "taskArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the task.
" + }, + "taskId":{ + "shape":"TaskId", + "documentation":"The task ID.
" + } + }, + "documentation":"Information about the task assigned to one or many devices.
" + }, + "TaskSummaryList":{ + "type":"list", + "member":{"shape":"TaskSummary"} + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The request was denied due to request throttling.
", + "error":{ + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "retryable":{"throttling":true} + }, + "Timestamp":{"type":"timestamp"}, + "Unlock":{ + "type":"structure", + "members":{ + }, + "documentation":"A structure used to unlock a device.
" + }, + "UnlockState":{ + "type":"string", + "enum":[ + "UNLOCKED", + "LOCKED", + "UNLOCKING" + ] + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the device or task.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"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.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + } + }, + "documentation":"Amazon Web Services Snow Device Management documentation.
" +}