| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- 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
Derived from API version 2021-08-04 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services Snow Device Management documentation.
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
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribeTask = DescribeTask' Text
- newDescribeTask :: Text -> DescribeTask
- data DescribeTaskResponse = DescribeTaskResponse' (Maybe TaskState) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribeTaskResponse :: Int -> DescribeTaskResponse
- data ListDeviceResources = ListDeviceResources' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListDeviceResources :: Text -> ListDeviceResources
- data ListDeviceResourcesResponse = ListDeviceResourcesResponse' (Maybe [ResourceSummary]) (Maybe Text) Int
- newListDeviceResourcesResponse :: Int -> ListDeviceResourcesResponse
- data ListExecutions = ListExecutions' (Maybe ExecutionState) (Maybe Text) (Maybe Natural) Text
- newListExecutions :: Text -> ListExecutions
- data ListExecutionsResponse = ListExecutionsResponse' (Maybe [ExecutionSummary]) (Maybe Text) Int
- newListExecutionsResponse :: Int -> ListExecutionsResponse
- data DescribeDeviceEc2Instances = DescribeDeviceEc2Instances' [Text] Text
- newDescribeDeviceEc2Instances :: Text -> DescribeDeviceEc2Instances
- data DescribeDeviceEc2InstancesResponse = DescribeDeviceEc2InstancesResponse' (Maybe [InstanceSummary]) Int
- newDescribeDeviceEc2InstancesResponse :: Int -> DescribeDeviceEc2InstancesResponse
- data CreateTask = CreateTask' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Command (NonEmpty Text)
- newCreateTask :: Command -> NonEmpty Text -> CreateTask
- data CreateTaskResponse = CreateTaskResponse' (Maybe Text) (Maybe Text) Int
- newCreateTaskResponse :: Int -> CreateTaskResponse
- data ListTasks = ListTasks' (Maybe TaskState) (Maybe Text) (Maybe Natural)
- newListTasks :: ListTasks
- data ListTasksResponse = ListTasksResponse' (Maybe [TaskSummary]) (Maybe Text) Int
- newListTasksResponse :: Int -> ListTasksResponse
- data DescribeExecution = DescribeExecution' Text Text
- newDescribeExecution :: Text -> Text -> DescribeExecution
- data DescribeExecutionResponse = DescribeExecutionResponse' (Maybe Text) (Maybe ExecutionState) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newDescribeExecutionResponse :: Int -> DescribeExecutionResponse
- data DescribeDevice = DescribeDevice' Text
- newDescribeDevice :: Text -> DescribeDevice
- data DescribeDeviceResponse = DescribeDeviceResponse' (Maybe UnlockState) (Maybe [Capacity]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe SoftwareInformation) (Maybe [PhysicalNetworkInterface]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribeDeviceResponse :: Int -> DescribeDeviceResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data CancelTask = CancelTask' Text
- newCancelTask :: Text -> CancelTask
- data CancelTaskResponse = CancelTaskResponse' (Maybe Text) Int
- newCancelTaskResponse :: Int -> CancelTaskResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data ListDevices = ListDevices' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListDevices :: ListDevices
- data ListDevicesResponse = ListDevicesResponse' (Maybe Text) (Maybe [DeviceSummary]) Int
- newListDevicesResponse :: Int -> ListDevicesResponse
- 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' (Maybe Integer) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Integer)
- newCapacity :: Capacity
- data Command = Command' (Maybe Unlock) (Maybe Reboot)
- newCommand :: Command
- data CpuOptions = CpuOptions' (Maybe Int) (Maybe Int)
- newCpuOptions :: CpuOptions
- data DeviceSummary = DeviceSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text))
- newDeviceSummary :: DeviceSummary
- data EbsInstanceBlockDevice = EbsInstanceBlockDevice' (Maybe Bool) (Maybe AttachmentStatus) (Maybe Text) (Maybe POSIX)
- newEbsInstanceBlockDevice :: EbsInstanceBlockDevice
- data ExecutionSummary = ExecutionSummary' (Maybe Text) (Maybe ExecutionState) (Maybe Text) (Maybe Text)
- newExecutionSummary :: ExecutionSummary
- data Instance = Instance' (Maybe Text) (Maybe InstanceState) (Maybe [SecurityGroupIdentifier]) (Maybe POSIX) (Maybe CpuOptions) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [InstanceBlockDeviceMapping]) (Maybe Text) (Maybe Int)
- newInstance :: Instance
- data InstanceBlockDeviceMapping = InstanceBlockDeviceMapping' (Maybe EbsInstanceBlockDevice) (Maybe Text)
- newInstanceBlockDeviceMapping :: InstanceBlockDeviceMapping
- data InstanceState = InstanceState' (Maybe InstanceStateName) (Maybe Int)
- newInstanceState :: InstanceState
- data InstanceSummary = InstanceSummary' (Maybe POSIX) (Maybe Instance)
- newInstanceSummary :: InstanceSummary
- data PhysicalNetworkInterface = PhysicalNetworkInterface' (Maybe Text) (Maybe Text) (Maybe IpAddressAssignment) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PhysicalConnectorType)
- newPhysicalNetworkInterface :: PhysicalNetworkInterface
- data Reboot = Reboot' {
- newReboot :: Reboot
- data ResourceSummary = ResourceSummary' (Maybe Text) (Maybe Text) Text
- newResourceSummary :: Text -> ResourceSummary
- data SecurityGroupIdentifier = SecurityGroupIdentifier' (Maybe Text) (Maybe Text)
- newSecurityGroupIdentifier :: SecurityGroupIdentifier
- data SoftwareInformation = SoftwareInformation' (Maybe Text) (Maybe Text) (Maybe Text)
- newSoftwareInformation :: SoftwareInformation
- data TaskSummary = TaskSummary' (Maybe TaskState) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newTaskSummary :: Text -> TaskSummary
- data Unlock = Unlock' {
- newUnlock :: Unlock
Service Configuration
defaultService :: Service Source #
API version 2021-08-04 of the Amazon Snow Device Management SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by SnowDeviceManagement.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You don't have sufficient access to perform this action.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was denied due to request throttling.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An unexpected error occurred while processing the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request references a resource that doesn't exist.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the device or task.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags for the device or task.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DescribeTask
data DescribeTask Source #
See: newDescribeTask smart constructor.
Constructors
| DescribeTask' Text |
Instances
Arguments
| :: Text | |
| -> DescribeTask |
Create a value of DescribeTask 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:taskId:DescribeTask', describeTask_taskId - The ID of the task to be described.
data DescribeTaskResponse Source #
See: newDescribeTaskResponse smart constructor.
Constructors
| DescribeTaskResponse' (Maybe TaskState) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeTaskResponse Source #
Arguments
| :: Int | |
| -> DescribeTaskResponse |
Create a value of DescribeTaskResponse 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:DescribeTaskResponse', describeTaskResponse_state - The current state of the task.
$sel:lastUpdatedAt:DescribeTaskResponse', describeTaskResponse_lastUpdatedAt - When the state of the task was last updated.
$sel:createdAt:DescribeTaskResponse', describeTaskResponse_createdAt - When the CreateTask operation was called.
$sel:taskId:DescribeTask', describeTaskResponse_taskId - The ID of the task.
$sel:taskArn:DescribeTaskResponse', describeTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task.
$sel:targets:DescribeTaskResponse', describeTaskResponse_targets - The managed devices that the task was sent to.
$sel:completedAt:DescribeTaskResponse', describeTaskResponse_completedAt - When the task was completed.
$sel:description:DescribeTaskResponse', describeTaskResponse_description - The description provided of the task and managed devices.
$sel:tags:DescribeTaskResponse', describeTaskResponse_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:httpStatus:DescribeTaskResponse', describeTaskResponse_httpStatus - The response's http status code.
ListDeviceResources (Paginated)
data ListDeviceResources Source #
See: newListDeviceResources smart constructor.
Instances
newListDeviceResources Source #
Create a value of ListDeviceResources 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:nextToken:ListDeviceResources', listDeviceResources_nextToken - A pagination token to continue to the next page of results.
$sel:type':ListDeviceResources', listDeviceResources_type - A structure used to filter the results by type of resource.
$sel:maxResults:ListDeviceResources', listDeviceResources_maxResults - The maximum number of resources per page.
$sel:managedDeviceId:ListDeviceResources', listDeviceResources_managedDeviceId - The ID of the managed device that you are listing the resources of.
data ListDeviceResourcesResponse Source #
See: newListDeviceResourcesResponse smart constructor.
Constructors
| ListDeviceResourcesResponse' (Maybe [ResourceSummary]) (Maybe Text) Int |
Instances
newListDeviceResourcesResponse Source #
Create a value of ListDeviceResourcesResponse 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:resources:ListDeviceResourcesResponse', listDeviceResourcesResponse_resources - A structure defining the resource's type, Amazon Resource Name (ARN),
and ID.
$sel:nextToken:ListDeviceResources', listDeviceResourcesResponse_nextToken - A pagination token to continue to the next page of results.
$sel:httpStatus:ListDeviceResourcesResponse', listDeviceResourcesResponse_httpStatus - The response's http status code.
ListExecutions (Paginated)
data ListExecutions Source #
See: newListExecutions smart constructor.
Constructors
| ListExecutions' (Maybe ExecutionState) (Maybe Text) (Maybe Natural) Text |
Instances
Arguments
| :: Text | |
| -> ListExecutions |
Create a value of ListExecutions 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:ListExecutions', listExecutions_state - A structure used to filter the tasks by their current state.
$sel:nextToken:ListExecutions', listExecutions_nextToken - A pagination token to continue to the next page of tasks.
$sel:maxResults:ListExecutions', listExecutions_maxResults - The maximum number of tasks to list per page.
$sel:taskId:ListExecutions', listExecutions_taskId - The ID of the task.
data ListExecutionsResponse Source #
See: newListExecutionsResponse smart constructor.
Constructors
| ListExecutionsResponse' (Maybe [ExecutionSummary]) (Maybe Text) Int |
Instances
newListExecutionsResponse Source #
Create a value of ListExecutionsResponse 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:executions:ListExecutionsResponse', listExecutionsResponse_executions - 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.
$sel:nextToken:ListExecutions', listExecutionsResponse_nextToken - A pagination token to continue to the next page of executions.
$sel:httpStatus:ListExecutionsResponse', listExecutionsResponse_httpStatus - The response's http status code.
DescribeDeviceEc2Instances
data DescribeDeviceEc2Instances Source #
See: newDescribeDeviceEc2Instances smart constructor.
Constructors
| DescribeDeviceEc2Instances' [Text] Text |
Instances
newDescribeDeviceEc2Instances Source #
Create a value of DescribeDeviceEc2Instances 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:instanceIds:DescribeDeviceEc2Instances', describeDeviceEc2Instances_instanceIds - A list of instance IDs associated with the managed device.
$sel:managedDeviceId:DescribeDeviceEc2Instances', describeDeviceEc2Instances_managedDeviceId - The ID of the managed device.
data DescribeDeviceEc2InstancesResponse Source #
See: newDescribeDeviceEc2InstancesResponse smart constructor.
Constructors
| DescribeDeviceEc2InstancesResponse' (Maybe [InstanceSummary]) Int |
Instances
newDescribeDeviceEc2InstancesResponse Source #
Arguments
| :: Int | |
| -> DescribeDeviceEc2InstancesResponse |
Create a value of DescribeDeviceEc2InstancesResponse 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:instances:DescribeDeviceEc2InstancesResponse', describeDeviceEc2InstancesResponse_instances - A list of structures containing information about each instance.
$sel:httpStatus:DescribeDeviceEc2InstancesResponse', describeDeviceEc2InstancesResponse_httpStatus - The response's http status code.
CreateTask
data CreateTask Source #
See: newCreateTask smart constructor.
Constructors
| CreateTask' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Command (NonEmpty Text) |
Instances
Create a value of CreateTask 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:clientToken:CreateTask', createTask_clientToken - A token ensuring that the action is called only once with the specified
details.
$sel:description:CreateTask', createTask_description - A description of the task and its targets.
$sel:tags:CreateTask', createTask_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:command:CreateTask', createTask_command - The task to be performed. Only one task is executed on a device at a
time.
$sel:targets:CreateTask', createTask_targets - A list of managed device IDs.
data CreateTaskResponse Source #
See: newCreateTaskResponse smart constructor.
Instances
newCreateTaskResponse Source #
Arguments
| :: Int | |
| -> CreateTaskResponse |
Create a value of CreateTaskResponse 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:taskId:CreateTaskResponse', createTaskResponse_taskId - The ID of the task that you created.
$sel:taskArn:CreateTaskResponse', createTaskResponse_taskArn - The Amazon Resource Name (ARN) of the task that you created.
$sel:httpStatus:CreateTaskResponse', createTaskResponse_httpStatus - The response's http status code.
ListTasks (Paginated)
See: newListTasks smart constructor.
Instances
newListTasks :: ListTasks Source #
Create a value of ListTasks 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:ListTasks', listTasks_state - A structure used to filter the list of tasks.
$sel:nextToken:ListTasks', listTasks_nextToken - A pagination token to continue to the next page of tasks.
$sel:maxResults:ListTasks', listTasks_maxResults - The maximum number of tasks per page.
data ListTasksResponse Source #
See: newListTasksResponse smart constructor.
Constructors
| ListTasksResponse' (Maybe [TaskSummary]) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> ListTasksResponse |
Create a value of ListTasksResponse 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:tasks:ListTasksResponse', listTasksResponse_tasks - A list of task structures containing details about each task.
$sel:nextToken:ListTasks', listTasksResponse_nextToken - A pagination token to continue to the next page of tasks.
$sel:httpStatus:ListTasksResponse', listTasksResponse_httpStatus - The response's http status code.
DescribeExecution
data DescribeExecution Source #
See: newDescribeExecution smart constructor.
Constructors
| DescribeExecution' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeExecution |
Create a value of DescribeExecution 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:managedDeviceId:DescribeExecution', describeExecution_managedDeviceId - The ID of the managed device.
$sel:taskId:DescribeExecution', describeExecution_taskId - The ID of the task that the action is describing.
data DescribeExecutionResponse Source #
See: newDescribeExecutionResponse smart constructor.
Constructors
| DescribeExecutionResponse' (Maybe Text) (Maybe ExecutionState) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newDescribeExecutionResponse Source #
Create a value of DescribeExecutionResponse 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:DescribeExecutionResponse', describeExecutionResponse_executionId - The ID of the execution.
$sel:state:DescribeExecutionResponse', describeExecutionResponse_state - The current state of the execution.
$sel:lastUpdatedAt:DescribeExecutionResponse', describeExecutionResponse_lastUpdatedAt - When the status of the execution was last updated.
$sel:taskId:DescribeExecution', describeExecutionResponse_taskId - The ID of the task being executed on the device.
$sel:startedAt:DescribeExecutionResponse', describeExecutionResponse_startedAt - When the execution began.
$sel:managedDeviceId:DescribeExecution', describeExecutionResponse_managedDeviceId - The ID of the managed device that the task is being executed on.
$sel:httpStatus:DescribeExecutionResponse', describeExecutionResponse_httpStatus - The response's http status code.
DescribeDevice
data DescribeDevice Source #
See: newDescribeDevice smart constructor.
Constructors
| DescribeDevice' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDevice |
Create a value of DescribeDevice 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:managedDeviceId:DescribeDevice', describeDevice_managedDeviceId - The ID of the device that you are checking the information of.
data DescribeDeviceResponse Source #
See: newDescribeDeviceResponse smart constructor.
Constructors
| DescribeDeviceResponse' (Maybe UnlockState) (Maybe [Capacity]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe SoftwareInformation) (Maybe [PhysicalNetworkInterface]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeDeviceResponse Source #
Create a value of DescribeDeviceResponse 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:deviceState:DescribeDeviceResponse', describeDeviceResponse_deviceState - The current state of the device.
$sel:deviceCapacities:DescribeDeviceResponse', describeDeviceResponse_deviceCapacities - The hardware specifications of the device.
$sel:lastUpdatedAt:DescribeDeviceResponse', describeDeviceResponse_lastUpdatedAt - When the device last pushed an update to the Amazon Web Services Cloud.
Indicates when the device cache was refreshed.
$sel:associatedWithJob:DescribeDeviceResponse', describeDeviceResponse_associatedWithJob - The ID of the job used when ordering the device.
$sel:lastReachedOutAt:DescribeDeviceResponse', describeDeviceResponse_lastReachedOutAt - When the device last contacted the Amazon Web Services Cloud. Indicates
that the device is online.
$sel:software:DescribeDeviceResponse', describeDeviceResponse_software - The software installed on the device.
$sel:physicalNetworkInterfaces:DescribeDeviceResponse', describeDeviceResponse_physicalNetworkInterfaces - The network interfaces available on the device.
$sel:managedDeviceId:DescribeDevice', describeDeviceResponse_managedDeviceId - The ID of the device that you checked the information for.
$sel:managedDeviceArn:DescribeDeviceResponse', describeDeviceResponse_managedDeviceArn - The Amazon Resource Name (ARN) of the device.
$sel:deviceType:DescribeDeviceResponse', describeDeviceResponse_deviceType - The type of Amazon Web Services Snow Family device.
$sel:tags:DescribeDeviceResponse', describeDeviceResponse_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:httpStatus:DescribeDeviceResponse', describeDeviceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the device or task.
$sel:tags:TagResource', tagResource_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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CancelTask
data CancelTask Source #
See: newCancelTask smart constructor.
Constructors
| CancelTask' Text |
Instances
Arguments
| :: Text | |
| -> CancelTask |
Create a value of CancelTask 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:taskId:CancelTask', cancelTask_taskId - The ID of the task that you are attempting to cancel. You can retrieve a
task ID by using the ListTasks operation.
data CancelTaskResponse Source #
See: newCancelTaskResponse smart constructor.
Constructors
| CancelTaskResponse' (Maybe Text) Int |
Instances
newCancelTaskResponse Source #
Arguments
| :: Int | |
| -> CancelTaskResponse |
Create a value of CancelTaskResponse 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:taskId:CancelTask', cancelTaskResponse_taskId - The ID of the task that you are attempting to cancel.
$sel:httpStatus:CancelTaskResponse', cancelTaskResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the device or task.
$sel:tagKeys:UntagResource', untagResource_tagKeys - 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.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDevices (Paginated)
data ListDevices Source #
See: newListDevices smart constructor.
Instances
newListDevices :: ListDevices Source #
Create a value of ListDevices 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:jobId:ListDevices', listDevices_jobId - The ID of the job used to order the device.
$sel:nextToken:ListDevices', listDevices_nextToken - A pagination token to continue to the next page of results.
$sel:maxResults:ListDevices', listDevices_maxResults - The maximum number of devices to list per page.
data ListDevicesResponse Source #
See: newListDevicesResponse smart constructor.
Constructors
| ListDevicesResponse' (Maybe Text) (Maybe [DeviceSummary]) Int |
Instances
newListDevicesResponse Source #
Arguments
| :: Int | |
| -> ListDevicesResponse |
Create a value of ListDevicesResponse 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:nextToken:ListDevices', listDevicesResponse_nextToken - A pagination token to continue to the next page of devices.
$sel:devices:ListDevicesResponse', listDevicesResponse_devices - A list of device structures that contain information about the device.
$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.
Types
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.
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.
Command
The command given to the device to execute.
See: newCommand smart constructor.
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' (Maybe Int) (Maybe Int) |
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.
DeviceSummary
data DeviceSummary Source #
Identifying information about the device.
See: newDeviceSummary smart constructor.
Instances
| Eq DeviceSummary Source # | |
Defined in Amazonka.SnowDeviceManagement.Types.DeviceSummary Methods (==) :: DeviceSummary -> DeviceSummary -> Bool # (/=) :: DeviceSummary -> DeviceSummary -> Bool # | |
| Read DeviceSummary Source # | |