| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SnowDeviceManagement.Types
Contents
- Service Configuration
- Errors
- AttachmentStatus
- ExecutionState
- InstanceStateName
- IpAddressAssignment
- PhysicalConnectorType
- TaskState
- UnlockState
- Capacity
- Command
- CpuOptions
- DeviceSummary
- EbsInstanceBlockDevice
- ExecutionSummary
- Instance
- InstanceBlockDeviceMapping
- InstanceState
- InstanceSummary
- PhysicalNetworkInterface
- Reboot
- ResourceSummary
- SecurityGroupIdentifier
- SoftwareInformation
- TaskSummary
- Unlock
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AttachmentStatus where
- AttachmentStatus' { }
- pattern AttachmentStatus_ATTACHED :: AttachmentStatus
- pattern AttachmentStatus_ATTACHING :: AttachmentStatus
- pattern AttachmentStatus_DETACHED :: AttachmentStatus
- pattern AttachmentStatus_DETACHING :: AttachmentStatus
- newtype ExecutionState where
- ExecutionState' { }
- pattern ExecutionState_CANCELED :: ExecutionState
- pattern ExecutionState_FAILED :: ExecutionState
- pattern ExecutionState_IN_PROGRESS :: ExecutionState
- pattern ExecutionState_QUEUED :: ExecutionState
- pattern ExecutionState_REJECTED :: ExecutionState
- pattern ExecutionState_SUCCEEDED :: ExecutionState
- pattern ExecutionState_TIMED_OUT :: ExecutionState
- newtype InstanceStateName where
- InstanceStateName' { }
- pattern InstanceStateName_PENDING :: InstanceStateName
- pattern InstanceStateName_RUNNING :: InstanceStateName
- pattern InstanceStateName_SHUTTING_DOWN :: InstanceStateName
- pattern InstanceStateName_STOPPED :: InstanceStateName
- pattern InstanceStateName_STOPPING :: InstanceStateName
- pattern InstanceStateName_TERMINATED :: InstanceStateName
- newtype IpAddressAssignment where
- newtype PhysicalConnectorType where
- PhysicalConnectorType' { }
- pattern PhysicalConnectorType_QSFP :: PhysicalConnectorType
- pattern PhysicalConnectorType_RJ45 :: PhysicalConnectorType
- pattern PhysicalConnectorType_RJ45_2 :: PhysicalConnectorType
- pattern PhysicalConnectorType_SFP_PLUS :: PhysicalConnectorType
- pattern PhysicalConnectorType_WIFI :: PhysicalConnectorType
- newtype TaskState where
- TaskState' { }
- pattern TaskState_CANCELED :: TaskState
- pattern TaskState_COMPLETED :: TaskState
- pattern TaskState_IN_PROGRESS :: TaskState
- newtype UnlockState where
- UnlockState' { }
- pattern UnlockState_LOCKED :: UnlockState
- pattern UnlockState_UNLOCKED :: UnlockState
- pattern UnlockState_UNLOCKING :: UnlockState
- data Capacity = Capacity' {}
- newCapacity :: Capacity
- capacity_used :: Lens' Capacity (Maybe Integer)
- capacity_name :: Lens' Capacity (Maybe Text)
- capacity_total :: Lens' Capacity (Maybe Integer)
- capacity_unit :: Lens' Capacity (Maybe Text)
- capacity_available :: Lens' Capacity (Maybe Integer)
- data Command = Command' {}
- newCommand :: Command
- command_unlock :: Lens' Command (Maybe Unlock)
- command_reboot :: Lens' Command (Maybe Reboot)
- data CpuOptions = CpuOptions' {}
- newCpuOptions :: CpuOptions
- cpuOptions_coreCount :: Lens' CpuOptions (Maybe Int)
- cpuOptions_threadsPerCore :: Lens' CpuOptions (Maybe Int)
- data DeviceSummary = DeviceSummary' {}
- newDeviceSummary :: DeviceSummary
- deviceSummary_associatedWithJob :: Lens' DeviceSummary (Maybe Text)
- deviceSummary_managedDeviceId :: Lens' DeviceSummary (Maybe Text)
- deviceSummary_managedDeviceArn :: Lens' DeviceSummary (Maybe Text)
- deviceSummary_tags :: Lens' DeviceSummary (Maybe (HashMap Text Text))
- data EbsInstanceBlockDevice = EbsInstanceBlockDevice' {}
- newEbsInstanceBlockDevice :: EbsInstanceBlockDevice
- ebsInstanceBlockDevice_deleteOnTermination :: Lens' EbsInstanceBlockDevice (Maybe Bool)
- ebsInstanceBlockDevice_status :: Lens' EbsInstanceBlockDevice (Maybe AttachmentStatus)
- ebsInstanceBlockDevice_volumeId :: Lens' EbsInstanceBlockDevice (Maybe Text)
- ebsInstanceBlockDevice_attachTime :: Lens' EbsInstanceBlockDevice (Maybe UTCTime)
- data ExecutionSummary = ExecutionSummary' {}
- newExecutionSummary :: ExecutionSummary
- executionSummary_executionId :: Lens' ExecutionSummary (Maybe Text)
- executionSummary_state :: Lens' ExecutionSummary (Maybe ExecutionState)
- executionSummary_taskId :: Lens' ExecutionSummary (Maybe Text)
- executionSummary_managedDeviceId :: Lens' ExecutionSummary (Maybe Text)
- data Instance = Instance' {
- instanceId :: Maybe Text
- state :: Maybe InstanceState
- securityGroups :: Maybe [SecurityGroupIdentifier]
- createdAt :: Maybe POSIX
- cpuOptions :: Maybe CpuOptions
- rootDeviceName :: Maybe Text
- instanceType :: Maybe Text
- imageId :: Maybe Text
- privateIpAddress :: Maybe Text
- updatedAt :: Maybe POSIX
- blockDeviceMappings :: Maybe [InstanceBlockDeviceMapping]
- publicIpAddress :: Maybe Text
- amiLaunchIndex :: Maybe Int
- newInstance :: Instance
- instance_instanceId :: Lens' Instance (Maybe Text)
- instance_state :: Lens' Instance (Maybe InstanceState)
- instance_securityGroups :: Lens' Instance (Maybe [SecurityGroupIdentifier])
- instance_createdAt :: Lens' Instance (Maybe UTCTime)
- instance_cpuOptions :: Lens' Instance (Maybe CpuOptions)
- instance_rootDeviceName :: Lens' Instance (Maybe Text)
- instance_instanceType :: Lens' Instance (Maybe Text)
- instance_imageId :: Lens' Instance (Maybe Text)
- instance_privateIpAddress :: Lens' Instance (Maybe Text)
- instance_updatedAt :: Lens' Instance (Maybe UTCTime)
- instance_blockDeviceMappings :: Lens' Instance (Maybe [InstanceBlockDeviceMapping])
- instance_publicIpAddress :: Lens' Instance (Maybe Text)
- instance_amiLaunchIndex :: Lens' Instance (Maybe Int)
- data InstanceBlockDeviceMapping = InstanceBlockDeviceMapping' {}
- newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping
- instanceBlockDeviceMapping_ebs :: Lens' InstanceBlockDeviceMapping (Maybe EbsInstanceBlockDevice)
- instanceBlockDeviceMapping_deviceName :: Lens' InstanceBlockDeviceMapping (Maybe Text)
- data InstanceState = InstanceState' {}
- newInstanceState :: InstanceState
- instanceState_name :: Lens' InstanceState (Maybe InstanceStateName)
- instanceState_code :: Lens' InstanceState (Maybe Int)
- data InstanceSummary = InstanceSummary' {}
- newInstanceSummary :: InstanceSummary
- instanceSummary_lastUpdatedAt :: Lens' InstanceSummary (Maybe UTCTime)
- instanceSummary_instance :: Lens' InstanceSummary (Maybe Instance)
- data PhysicalNetworkInterface = PhysicalNetworkInterface' {}
- newPhysicalNetworkInterface :: PhysicalNetworkInterface
- physicalNetworkInterface_ipAddress :: Lens' PhysicalNetworkInterface (Maybe Text)
- physicalNetworkInterface_macAddress :: Lens' PhysicalNetworkInterface (Maybe Text)
- physicalNetworkInterface_ipAddressAssignment :: Lens' PhysicalNetworkInterface (Maybe IpAddressAssignment)
- physicalNetworkInterface_defaultGateway :: Lens' PhysicalNetworkInterface (Maybe Text)
- physicalNetworkInterface_physicalNetworkInterfaceId :: Lens' PhysicalNetworkInterface (Maybe Text)
- physicalNetworkInterface_netmask :: Lens' PhysicalNetworkInterface (Maybe Text)
- physicalNetworkInterface_physicalConnectorType :: Lens' PhysicalNetworkInterface (Maybe PhysicalConnectorType)
- data Reboot = Reboot' {
- newReboot :: Reboot
- data ResourceSummary = ResourceSummary' {}
- newResourceSummary :: Text -> ResourceSummary
- resourceSummary_arn :: Lens' ResourceSummary (Maybe Text)
- resourceSummary_id :: Lens' ResourceSummary (Maybe Text)
- resourceSummary_resourceType :: Lens' ResourceSummary Text
- data SecurityGroupIdentifier = SecurityGroupIdentifier' {}
- newSecurityGroupIdentifier :: SecurityGroupIdentifier
- securityGroupIdentifier_groupId :: Lens' SecurityGroupIdentifier (Maybe Text)
- securityGroupIdentifier_groupName :: Lens' SecurityGroupIdentifier (Maybe Text)
- data SoftwareInformation = SoftwareInformation' {}
- newSoftwareInformation :: SoftwareInformation
- softwareInformation_installedVersion :: Lens' SoftwareInformation (Maybe Text)
- softwareInformation_installState :: Lens' SoftwareInformation (Maybe Text)
- softwareInformation_installingVersion :: Lens' SoftwareInformation (Maybe Text)
- data TaskSummary = TaskSummary' {}
- newTaskSummary :: Text -> TaskSummary
- taskSummary_state :: Lens' TaskSummary (Maybe TaskState)
- taskSummary_taskArn :: Lens' TaskSummary (Maybe Text)
- taskSummary_tags :: Lens' TaskSummary (Maybe (HashMap Text Text))
- taskSummary_taskId :: Lens' TaskSummary Text
- data Unlock = Unlock' {
- newUnlock :: Unlock
Service Configuration
defaultService :: Service Source #
API version 2021-08-04 of the Amazon Snow Device Management SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You don't have sufficient access to perform this action.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would cause a service quota to be exceeded.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected error occurred while processing the request.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request references a resource that doesn't exist.
AttachmentStatus
newtype AttachmentStatus Source #
Constructors
| AttachmentStatus' | |
Fields | |
Bundled Patterns
| pattern AttachmentStatus_ATTACHED :: AttachmentStatus | |
| pattern AttachmentStatus_ATTACHING :: AttachmentStatus | |
| pattern AttachmentStatus_DETACHED :: AttachmentStatus | |
| pattern AttachmentStatus_DETACHING :: AttachmentStatus |
Instances
ExecutionState
newtype ExecutionState Source #
Constructors
| ExecutionState' | |
Fields | |
Bundled Patterns
| pattern ExecutionState_CANCELED :: ExecutionState | |
| pattern ExecutionState_FAILED :: ExecutionState | |
| pattern ExecutionState_IN_PROGRESS :: ExecutionState | |
| pattern ExecutionState_QUEUED :: ExecutionState | |
| pattern ExecutionState_REJECTED :: ExecutionState | |
| pattern ExecutionState_SUCCEEDED :: ExecutionState | |
| pattern ExecutionState_TIMED_OUT :: ExecutionState |
Instances
InstanceStateName
newtype InstanceStateName Source #
Constructors
| InstanceStateName' | |
Fields | |
Bundled Patterns
| pattern InstanceStateName_PENDING :: InstanceStateName | |
| pattern InstanceStateName_RUNNING :: InstanceStateName | |
| pattern InstanceStateName_SHUTTING_DOWN :: InstanceStateName | |
| pattern InstanceStateName_STOPPED :: InstanceStateName | |
| pattern InstanceStateName_STOPPING :: InstanceStateName | |
| pattern InstanceStateName_TERMINATED :: InstanceStateName |
Instances
IpAddressAssignment
newtype IpAddressAssignment Source #
Constructors
| IpAddressAssignment' | |
Fields | |
Bundled Patterns
| pattern IpAddressAssignment_DHCP :: IpAddressAssignment | |
| pattern IpAddressAssignment_STATIC :: IpAddressAssignment |
Instances
PhysicalConnectorType
newtype PhysicalConnectorType Source #
Constructors
| PhysicalConnectorType' | |
Fields | |
Bundled Patterns
| pattern PhysicalConnectorType_QSFP :: PhysicalConnectorType | |
| pattern PhysicalConnectorType_RJ45 :: PhysicalConnectorType | |
| pattern PhysicalConnectorType_RJ45_2 :: PhysicalConnectorType | |
| pattern PhysicalConnectorType_SFP_PLUS :: PhysicalConnectorType | |
| pattern PhysicalConnectorType_WIFI :: PhysicalConnectorType |
Instances
TaskState
Constructors
| TaskState' | |
Fields | |
Bundled Patterns
| pattern TaskState_CANCELED :: TaskState | |
| pattern TaskState_COMPLETED :: TaskState | |
| pattern TaskState_IN_PROGRESS :: TaskState |
Instances
UnlockState
newtype UnlockState Source #
Constructors
| UnlockState' | |
Fields | |
Bundled Patterns
| pattern UnlockState_LOCKED :: UnlockState | |
| pattern UnlockState_UNLOCKED :: UnlockState | |
| pattern UnlockState_UNLOCKING :: UnlockState |
Instances
Capacity
The physical capacity of the Amazon Web Services Snow Family device.
See: newCapacity smart constructor.
Constructors
| Capacity' | |
Fields
| |
Instances
newCapacity :: Capacity Source #
Create a value of Capacity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:used:Capacity', capacity_used - The amount of capacity used on the device.
$sel:name:Capacity', capacity_name - The name of the type of capacity, such as memory.
$sel:total:Capacity', capacity_total - The total capacity on the device.
$sel:unit:Capacity', capacity_unit - The unit of measure for the type of capacity.
$sel:available:Capacity', capacity_available - 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_available :: Lens' Capacity (Maybe Integer) Source #
The amount of capacity available for use on the device.
Command
The command given to the device to execute.
See: newCommand smart constructor.
Constructors
| Command' | |
Instances
| Eq Command Source # | |
| Read Command Source # | |
| Show Command Source # | |
| Generic Command Source # | |
| NFData Command Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Command | |
| Hashable Command Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Command | |
| ToJSON Command Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Command | |
| type Rep Command Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Command type Rep Command = D1 ('MetaData "Command" "Amazonka.SnowDeviceManagement.Types.Command" "libZSservicesZSamazonka-snow-device-managementZSamazonka-snow-device-management" 'False) (C1 ('MetaCons "Command'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Unlock)) :*: S1 ('MetaSel ('Just "reboot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Reboot)))) | |
newCommand :: Command Source #
Create a value of Command with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unlock:Command', command_unlock - Unlocks the device.
$sel:reboot:Command', command_reboot - Reboots the device.
CpuOptions
data CpuOptions Source #
The options for how a device's CPU is configured.
See: newCpuOptions smart constructor.
Constructors
| CpuOptions' | |
Instances
newCpuOptions :: CpuOptions Source #
Create a value of CpuOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:coreCount:CpuOptions', cpuOptions_coreCount - The number of cores that the CPU can use.
$sel:threadsPerCore:CpuOptions', cpuOptions_threadsPerCore - The number of threads per core in the CPU.
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
data DeviceSummary Source #
Identifying information about the device.
See: newDeviceSummary smart constructor.
Constructors
| DeviceSummary' | |
Fields
| |
Instances
newDeviceSummary :: DeviceSummary Source #
Create a value of DeviceSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedWithJob:DeviceSummary', deviceSummary_associatedWithJob - The ID of the job used to order the device.
$sel:managedDeviceId:DeviceSummary', deviceSummary_managedDeviceId - The ID of the device.
$sel:managedDeviceArn:DeviceSummary', deviceSummary_managedDeviceArn - The Amazon Resource Name (ARN) of the device.
$sel:tags:DeviceSummary', deviceSummary_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.
deviceSummary_associatedWithJob :: Lens' DeviceSummary (Maybe Text) Source #
The ID of the job used to order the device.
deviceSummary_managedDeviceId :: Lens' DeviceSummary (Maybe Text) Source #
The ID of 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
data EbsInstanceBlockDevice Source #
Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.
See: newEbsInstanceBlockDevice smart constructor.
Constructors
| EbsInstanceBlockDevice' | |
Fields
| |
Instances
newEbsInstanceBlockDevice :: EbsInstanceBlockDevice Source #
Create a value of EbsInstanceBlockDevice with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteOnTermination:EbsInstanceBlockDevice', ebsInstanceBlockDevice_deleteOnTermination - A value that indicates whether the volume is deleted on instance
termination.
$sel:status:EbsInstanceBlockDevice', ebsInstanceBlockDevice_status - The attachment state.
$sel:volumeId:EbsInstanceBlockDevice', ebsInstanceBlockDevice_volumeId - The ID of the Amazon EBS volume.
$sel:attachTime:EbsInstanceBlockDevice', ebsInstanceBlockDevice_attachTime - When the attachment was initiated.
ebsInstanceBlockDevice_deleteOnTermination :: Lens' EbsInstanceBlockDevice (Maybe Bool) Source #
A value that indicates whether the volume is deleted on instance termination.
ebsInstanceBlockDevice_status :: Lens' EbsInstanceBlockDevice (Maybe AttachmentStatus) Source #
The attachment state.
ebsInstanceBlockDevice_volumeId :: Lens' EbsInstanceBlockDevice (Maybe Text) Source #
The ID of the Amazon EBS volume.
ebsInstanceBlockDevice_attachTime :: Lens' EbsInstanceBlockDevice (Maybe UTCTime) Source #
When the attachment was initiated.
ExecutionSummary
data ExecutionSummary Source #
The summary of a task execution on a specified device.
See: newExecutionSummary smart constructor.
Constructors
| ExecutionSummary' | |
Fields
| |
Instances
newExecutionSummary :: ExecutionSummary Source #
Create a value of ExecutionSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:executionId:ExecutionSummary', executionSummary_executionId - The ID of the execution.
$sel:state:ExecutionSummary', executionSummary_state - The state of the execution.
$sel:taskId:ExecutionSummary', executionSummary_taskId - The ID of the task.
$sel:managedDeviceId:ExecutionSummary', executionSummary_managedDeviceId - The ID of the managed device that the task is being executed on.
executionSummary_executionId :: Lens' ExecutionSummary (Maybe Text) Source #
The ID of the execution.
executionSummary_state :: Lens' ExecutionSummary (Maybe ExecutionState) Source #
The state of the execution.
executionSummary_taskId :: Lens' ExecutionSummary (Maybe Text) Source #
The ID of the task.
executionSummary_managedDeviceId :: Lens' ExecutionSummary (Maybe Text) Source #
The ID of the managed device that the task is being executed on.
Instance
The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.
See: newInstance smart constructor.
Constructors
| Instance' | |
Fields
| |
Instances
newInstance :: Instance Source #
Create a value of Instance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceId:Instance', instance_instanceId - The ID of the instance.
$sel:state:Instance', instance_state - Undocumented member.
$sel:securityGroups:Instance', instance_securityGroups - The security groups for the instance.
$sel:createdAt:Instance', instance_createdAt - When the instance was created.
$sel:cpuOptions:Instance', instance_cpuOptions - The CPU options for the instance.
$sel:rootDeviceName:Instance', instance_rootDeviceName - The device name of the root device volume (for example, /dev/sda1).
$sel:instanceType:Instance', instance_instanceType - The instance type.
$sel:imageId:Instance', instance_imageId - The ID of the AMI used to launch the instance.
$sel:privateIpAddress:Instance', instance_privateIpAddress - The private IPv4 address assigned to the instance.
$sel:updatedAt:Instance', instance_updatedAt - When the instance was last updated.
$sel:blockDeviceMappings:Instance', instance_blockDeviceMappings - Any block device mapping entries for the instance.
$sel:publicIpAddress:Instance', instance_publicIpAddress - The public IPv4 address assigned to the instance.
$sel:amiLaunchIndex:Instance', instance_amiLaunchIndex - The Amazon Machine Image (AMI) launch index, which you can use to find
this instance in the launch group.
instance_state :: Lens' Instance (Maybe InstanceState) Source #
Undocumented member.
instance_securityGroups :: Lens' Instance (Maybe [SecurityGroupIdentifier]) Source #
The security groups for the instance.
instance_cpuOptions :: Lens' Instance (Maybe CpuOptions) Source #
The CPU options for the instance.
instance_rootDeviceName :: Lens' Instance (Maybe Text) Source #
The device name of the root device volume (for example, /dev/sda1).
instance_imageId :: Lens' Instance (Maybe Text) Source #
The ID of the AMI used to launch the instance.
instance_privateIpAddress :: Lens' Instance (Maybe Text) Source #
The private IPv4 address assigned to the instance.
instance_blockDeviceMappings :: Lens' Instance (Maybe [InstanceBlockDeviceMapping]) Source #
Any block device mapping entries for the instance.
instance_publicIpAddress :: Lens' Instance (Maybe Text) Source #
The public IPv4 address assigned to the 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.
InstanceBlockDeviceMapping
data InstanceBlockDeviceMapping Source #
The description of a block device mapping.
See: newInstanceBlockDeviceMapping smart constructor.
Constructors
| InstanceBlockDeviceMapping' | |
Fields
| |
Instances
newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping Source #
Create a value of InstanceBlockDeviceMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ebs:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_ebs - The parameters used to automatically set up Amazon Elastic Block Store
(Amazon EBS) volumes when the instance is launched.
$sel:deviceName:InstanceBlockDeviceMapping', instanceBlockDeviceMapping_deviceName - The block device name.
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.
instanceBlockDeviceMapping_deviceName :: Lens' InstanceBlockDeviceMapping (Maybe Text) Source #
The block device name.
InstanceState
data InstanceState Source #
The description of the current state of an instance.
See: newInstanceState smart constructor.
Constructors
| InstanceState' | |
Fields
| |
Instances
newInstanceState :: InstanceState Source #
Create a value of InstanceState with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:InstanceState', instanceState_name - The current state of the instance.
$sel:code:InstanceState', instanceState_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:pending16:running32:shutting-down48:terminated64:stopping80: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.
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:pending16:running32:shutting-down48:terminated64:stopping80:stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
InstanceSummary
data InstanceSummary Source #
The details about the instance.
See: newInstanceSummary smart constructor.
Constructors
| InstanceSummary' | |
Instances
newInstanceSummary :: InstanceSummary Source #
Create a value of InstanceSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdatedAt:InstanceSummary', instanceSummary_lastUpdatedAt - When the instance summary was last updated.
$sel:instance':InstanceSummary', instanceSummary_instance - A structure containing details about the instance.
instanceSummary_lastUpdatedAt :: Lens' InstanceSummary (Maybe UTCTime) Source #
When the instance summary was last updated.
instanceSummary_instance :: Lens' InstanceSummary (Maybe Instance) Source #
A structure containing details about the instance.
PhysicalNetworkInterface
data PhysicalNetworkInterface Source #
The details about the physical network interface for the device.
See: newPhysicalNetworkInterface smart constructor.
Constructors
| PhysicalNetworkInterface' | |
Fields
| |
Instances
newPhysicalNetworkInterface :: PhysicalNetworkInterface Source #
Create a value of PhysicalNetworkInterface with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipAddress:PhysicalNetworkInterface', physicalNetworkInterface_ipAddress - The IP address of the device.
$sel:macAddress:PhysicalNetworkInterface', physicalNetworkInterface_macAddress - The MAC address of the device.
$sel:ipAddressAssignment:PhysicalNetworkInterface', physicalNetworkInterface_ipAddressAssignment - A value that describes whether the IP address is dynamic or persistent.
$sel:defaultGateway:PhysicalNetworkInterface', physicalNetworkInterface_defaultGateway - The default gateway of the device.
$sel:physicalNetworkInterfaceId:PhysicalNetworkInterface', physicalNetworkInterface_physicalNetworkInterfaceId - The physical network interface ID.
$sel:netmask:PhysicalNetworkInterface', physicalNetworkInterface_netmask - The netmask used to divide the IP address into subnets.
$sel:physicalConnectorType:PhysicalNetworkInterface', physicalNetworkInterface_physicalConnectorType - The physical connector type.
physicalNetworkInterface_ipAddress :: Lens' PhysicalNetworkInterface (Maybe Text) Source #
The IP address of the device.
physicalNetworkInterface_macAddress :: Lens' PhysicalNetworkInterface (Maybe Text) Source #
The MAC address of the device.
physicalNetworkInterface_ipAddressAssignment :: Lens' PhysicalNetworkInterface (Maybe IpAddressAssignment) Source #
A value that describes whether the IP address is dynamic or persistent.
physicalNetworkInterface_defaultGateway :: Lens' PhysicalNetworkInterface (Maybe Text) Source #
The default gateway of the device.
physicalNetworkInterface_physicalNetworkInterfaceId :: Lens' PhysicalNetworkInterface (Maybe Text) Source #
The physical network interface ID.
physicalNetworkInterface_netmask :: Lens' PhysicalNetworkInterface (Maybe Text) Source #
The netmask used to divide the IP address into subnets.
physicalNetworkInterface_physicalConnectorType :: Lens' PhysicalNetworkInterface (Maybe PhysicalConnectorType) Source #
The physical connector type.
Reboot
A structure used to reboot the device.
See: newReboot smart constructor.
Constructors
| Reboot' | |
Instances
| Eq Reboot Source # | |
| Read Reboot Source # | |
| Show Reboot Source # | |
| Generic Reboot Source # | |
| NFData Reboot Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Reboot | |
| Hashable Reboot Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Reboot | |
| ToJSON Reboot Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Reboot | |
| type Rep Reboot Source # | |
Create a value of Reboot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ResourceSummary
data ResourceSummary Source #
A summary of a resource available on the device.
See: newResourceSummary smart constructor.
Constructors
| ResourceSummary' | |
Instances
Arguments
| :: Text | |
| -> ResourceSummary |
Create a value of ResourceSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ResourceSummary', resourceSummary_arn - The Amazon Resource Name (ARN) of the resource.
$sel:id:ResourceSummary', resourceSummary_id - The ID of the resource.
$sel:resourceType:ResourceSummary', resourceSummary_resourceType - The resource type.
resourceSummary_arn :: Lens' ResourceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource.
resourceSummary_id :: Lens' ResourceSummary (Maybe Text) Source #
The ID of the resource.
resourceSummary_resourceType :: Lens' ResourceSummary Text Source #
The resource type.
SecurityGroupIdentifier
data SecurityGroupIdentifier Source #
Information about the device's security group.
See: newSecurityGroupIdentifier smart constructor.
Constructors
| SecurityGroupIdentifier' | |
Instances
newSecurityGroupIdentifier :: SecurityGroupIdentifier Source #
Create a value of SecurityGroupIdentifier with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupId:SecurityGroupIdentifier', securityGroupIdentifier_groupId - The security group ID.
$sel:groupName:SecurityGroupIdentifier', securityGroupIdentifier_groupName - The security group name.
securityGroupIdentifier_groupId :: Lens' SecurityGroupIdentifier (Maybe Text) Source #
The security group ID.
securityGroupIdentifier_groupName :: Lens' SecurityGroupIdentifier (Maybe Text) Source #
The security group name.
SoftwareInformation
data SoftwareInformation Source #
Information about the software on the device.
See: newSoftwareInformation smart constructor.
Constructors
| SoftwareInformation' | |
Fields
| |
Instances
newSoftwareInformation :: SoftwareInformation Source #
Create a value of SoftwareInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:installedVersion:SoftwareInformation', softwareInformation_installedVersion - The version of the software currently installed on the device.
$sel:installState:SoftwareInformation', softwareInformation_installState - The state of the software that is installed or that is being installed
on the device.
$sel:installingVersion:SoftwareInformation', softwareInformation_installingVersion - The version of the software being installed on the device.
softwareInformation_installedVersion :: Lens' SoftwareInformation (Maybe Text) Source #
The version of the software currently installed on the device.
softwareInformation_installState :: Lens' SoftwareInformation (Maybe Text) Source #
The state of the software that is installed or that is being installed on the device.
softwareInformation_installingVersion :: Lens' SoftwareInformation (Maybe Text) Source #
The version of the software being installed on the device.
TaskSummary
data TaskSummary Source #
Information about the task assigned to one or many devices.
See: newTaskSummary smart constructor.
Constructors
| TaskSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> TaskSummary |
Create a value of TaskSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:TaskSummary', taskSummary_state - The state of the task assigned to one or many devices.
$sel:taskArn:TaskSummary', taskSummary_taskArn - The Amazon Resource Name (ARN) of the task.
$sel:tags:TaskSummary', taskSummary_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.
$sel:taskId:TaskSummary', taskSummary_taskId - The task ID.
taskSummary_state :: Lens' TaskSummary (Maybe TaskState) Source #
The state of the task assigned to one or many devices.
taskSummary_taskArn :: Lens' TaskSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the task.
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_taskId :: Lens' TaskSummary Text Source #
The task ID.
Unlock
A structure used to unlock a device.
See: newUnlock smart constructor.
Constructors
| Unlock' | |
Instances
| Eq Unlock Source # | |
| Read Unlock Source # | |
| Show Unlock Source # | |
| Generic Unlock Source # | |
| NFData Unlock Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Unlock | |
| Hashable Unlock Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Unlock | |
| ToJSON Unlock Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.Unlock | |
| type Rep Unlock Source # | |