amazonka-snow-device-management-2.0: Amazon Snow Device Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SnowDeviceManagement.Lens

Description

 
Synopsis

Operations

CancelTask

cancelTask_taskId :: Lens' CancelTask Text Source #

The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.

cancelTaskResponse_taskId :: Lens' CancelTaskResponse (Maybe Text) Source #

The ID of the task that you are attempting to cancel.

CreateTask

createTask_clientToken :: Lens' CreateTask (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createTask_description :: Lens' CreateTask (Maybe Text) Source #

A description of the task and its targets.

createTask_tags :: Lens' CreateTask (Maybe (HashMap Text Text)) Source #

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.

createTask_command :: Lens' CreateTask Command Source #

The task to be performed. Only one task is executed on a device at a time.

createTask_targets :: Lens' CreateTask (NonEmpty Text) Source #

A list of managed device IDs.

createTaskResponse_taskArn :: Lens' CreateTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task that you created.

createTaskResponse_taskId :: Lens' CreateTaskResponse (Maybe Text) Source #

The ID of the task that you created.

DescribeDevice

describeDevice_managedDeviceId :: Lens' DescribeDevice Text Source #

The ID of the device that you are checking the information of.

describeDeviceResponse_associatedWithJob :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The ID of the job used when ordering the device.

describeDeviceResponse_deviceType :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The type of Amazon Web Services Snow Family device.

describeDeviceResponse_lastReachedOutAt :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

describeDeviceResponse_lastUpdatedAt :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

describeDeviceResponse_managedDeviceArn :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

describeDeviceResponse_managedDeviceId :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The ID of the device that you checked the information for.

describeDeviceResponse_tags :: Lens' DescribeDeviceResponse (Maybe (HashMap Text Text)) Source #

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.

DescribeDeviceEc2Instances

describeDeviceEc2Instances_instanceIds :: Lens' DescribeDeviceEc2Instances [Text] Source #

A list of instance IDs associated with the managed device.

describeDeviceEc2InstancesResponse_instances :: Lens' DescribeDeviceEc2InstancesResponse (Maybe [InstanceSummary]) Source #

A list of structures containing information about each instance.

DescribeExecution

describeExecution_taskId :: Lens' DescribeExecution Text Source #

The ID of the task that the action is describing.

describeExecutionResponse_lastUpdatedAt :: Lens' DescribeExecutionResponse (Maybe UTCTime) Source #

When the status of the execution was last updated.

describeExecutionResponse_managedDeviceId :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The ID of the managed device that the task is being executed on.

describeExecutionResponse_taskId :: Lens' DescribeExecutionResponse (Maybe Text) Source #

The ID of the task being executed on the device.

DescribeTask

describeTask_taskId :: Lens' DescribeTask Text Source #

The ID of the task to be described.

describeTaskResponse_createdAt :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

When the CreateTask operation was called.

describeTaskResponse_description :: Lens' DescribeTaskResponse (Maybe Text) Source #

The description provided of the task and managed devices.

describeTaskResponse_lastUpdatedAt :: Lens' DescribeTaskResponse (Maybe UTCTime) Source #

When the state of the task was last updated.

describeTaskResponse_tags :: Lens' DescribeTaskResponse (Maybe (HashMap Text Text)) Source #

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.

describeTaskResponse_targets :: Lens' DescribeTaskResponse (Maybe (NonEmpty Text)) Source #

The managed devices that the task was sent to.

describeTaskResponse_taskArn :: Lens' DescribeTaskResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

ListDeviceResources

listDeviceResources_maxResults :: Lens' ListDeviceResources (Maybe Natural) Source #

The maximum number of resources per page.

listDeviceResources_nextToken :: Lens' ListDeviceResources (Maybe Text) Source #

A pagination token to continue to the next page of results.

listDeviceResources_type :: Lens' ListDeviceResources (Maybe Text) Source #

A structure used to filter the results by type of resource.

listDeviceResources_managedDeviceId :: Lens' ListDeviceResources Text Source #

The ID of the managed device that you are listing the resources of.

listDeviceResourcesResponse_nextToken :: Lens' ListDeviceResourcesResponse (Maybe Text) Source #

A pagination token to continue to the next page of results.

listDeviceResourcesResponse_resources :: Lens' ListDeviceResourcesResponse (Maybe [ResourceSummary]) Source #

A structure defining the resource's type, Amazon Resource Name (ARN), and ID.

ListDevices

listDevices_jobId :: Lens' ListDevices (Maybe Text) Source #

The ID of the job used to order the device.

listDevices_maxResults :: Lens' ListDevices (Maybe Natural) Source #

The maximum number of devices to list per page.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

A pagination token to continue to the next page of results.

listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [DeviceSummary]) Source #

A list of device structures that contain information about the device.

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

A pagination token to continue to the next page of devices.

ListExecutions

listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural) Source #

The maximum number of tasks to list per page.

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #

A pagination token to continue to the next page of tasks.

listExecutions_state :: Lens' ListExecutions (Maybe ExecutionState) Source #

A structure used to filter the tasks by their current state.

listExecutionsResponse_executions :: Lens' ListExecutionsResponse (Maybe [ExecutionSummary]) Source #

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.

listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #

A pagination token to continue to the next page of executions.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the device or task.

ListTasks

listTasks_maxResults :: Lens' ListTasks (Maybe Natural) Source #

The maximum number of tasks per page.

listTasks_nextToken :: Lens' ListTasks (Maybe Text) Source #

A pagination token to continue to the next page of tasks.

listTasks_state :: Lens' ListTasks (Maybe TaskState) Source #

A structure used to filter the list of tasks.

listTasksResponse_nextToken :: Lens' ListTasksResponse (Maybe Text) Source #

A pagination token to continue to the next page of tasks.

listTasksResponse_tasks :: Lens' ListTasksResponse (Maybe [TaskSummary]) Source #

A list of task structures containing details about each task.

listTasksResponse_httpStatus :: Lens' ListTasksResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the device or task.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the device or task.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

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.

Types

Capacity

capacity_available :: Lens' Capacity (Maybe Integer) Source #

The amount of capacity available for use on the device.

capacity_name :: Lens' Capacity (Maybe Text) Source #

The name of the type of capacity, such as memory.

capacity_total :: Lens' Capacity (Maybe Integer) Source #

The total capacity on the device.

capacity_unit :: Lens' Capacity (Maybe Text) Source #

The unit of measure for the type of capacity.

capacity_used :: Lens' Capacity (Maybe Integer) Source #

The amount of capacity used on the device.

Command

command_reboot :: Lens' Command (Maybe Reboot) Source #

Reboots the device.

command_unlock :: Lens' Command (Maybe Unlock) Source #

Unlocks the device.

CpuOptions

cpuOptions_coreCount :: Lens' CpuOptions (Maybe Int) Source #

The number of cores that the CPU can use.

cpuOptions_threadsPerCore :: Lens' CpuOptions (Maybe Int) Source #

The number of threads per core in the CPU.

DeviceSummary

deviceSummary_associatedWithJob :: Lens' DeviceSummary (Maybe Text) Source #

The ID of the job used to order the device.

deviceSummary_managedDeviceArn :: Lens' DeviceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

deviceSummary_tags :: Lens' DeviceSummary (Maybe (HashMap Text Text)) Source #

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.

EbsInstanceBlockDevice

ebsInstanceBlockDevice_deleteOnTermination :: Lens' EbsInstanceBlockDevice (Maybe Bool) Source #

A value that indicates whether the volume is deleted on instance termination.

ExecutionSummary

executionSummary_managedDeviceId :: Lens' ExecutionSummary (Maybe Text) Source #

The ID of the managed device that the task is being executed on.

Instance

instance_amiLaunchIndex :: Lens' Instance (Maybe Int) Source #

The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

instance_blockDeviceMappings :: Lens' Instance (Maybe [InstanceBlockDeviceMapping]) Source #

Any block device mapping entries for the instance.

instance_cpuOptions :: Lens' Instance (Maybe CpuOptions) Source #

The CPU options for the instance.

instance_createdAt :: Lens' Instance (Maybe UTCTime) Source #

When the instance was created.

instance_imageId :: Lens' Instance (Maybe Text) Source #

The ID of the AMI used to launch the instance.

instance_instanceId :: Lens' Instance (Maybe Text) Source #

The ID of the instance.

instance_privateIpAddress :: Lens' Instance (Maybe Text) Source #

The private IPv4 address assigned to the instance.

instance_publicIpAddress :: Lens' Instance (Maybe Text) Source #

The public IPv4 address assigned to the instance.

instance_rootDeviceName :: Lens' Instance (Maybe Text) Source #

The device name of the root device volume (for example, /dev/sda1).

instance_securityGroups :: Lens' Instance (Maybe [SecurityGroupIdentifier]) Source #

The security groups for the instance.

instance_updatedAt :: Lens' Instance (Maybe UTCTime) Source #

When the instance was last updated.

InstanceBlockDeviceMapping

instanceBlockDeviceMapping_ebs :: Lens' InstanceBlockDeviceMapping (Maybe EbsInstanceBlockDevice) Source #

The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.

InstanceState

instanceState_code :: Lens' InstanceState (Maybe Int) Source #

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.

instanceState_name :: Lens' InstanceState (Maybe InstanceStateName) Source #

The current state of the instance.

InstanceSummary

instanceSummary_instance :: Lens' InstanceSummary (Maybe Instance) Source #

A structure containing details about the instance.

instanceSummary_lastUpdatedAt :: Lens' InstanceSummary (Maybe UTCTime) Source #

When the instance summary was last updated.

PhysicalNetworkInterface

physicalNetworkInterface_ipAddressAssignment :: Lens' PhysicalNetworkInterface (Maybe IpAddressAssignment) Source #

A value that describes whether the IP address is dynamic or persistent.

physicalNetworkInterface_netmask :: Lens' PhysicalNetworkInterface (Maybe Text) Source #

The netmask used to divide the IP address into subnets.

Reboot

ResourceSummary

resourceSummary_arn :: Lens' ResourceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

SecurityGroupIdentifier

SoftwareInformation

softwareInformation_installState :: Lens' SoftwareInformation (Maybe Text) Source #

The state of the software that is installed or that is being installed on the device.

softwareInformation_installedVersion :: Lens' SoftwareInformation (Maybe Text) Source #

The version of the software currently installed on the device.

softwareInformation_installingVersion :: Lens' SoftwareInformation (Maybe Text) Source #

The version of the software being installed on the device.

TaskSummary

taskSummary_state :: Lens' TaskSummary (Maybe TaskState) Source #

The state of the task assigned to one or many devices.

taskSummary_tags :: Lens' TaskSummary (Maybe (HashMap Text Text)) Source #

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.

taskSummary_taskArn :: Lens' TaskSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the task.

Unlock