{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.SnowDeviceManagement.DescribeExecution
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Checks the status of a remote task running on one or more target
-- devices.
module Amazonka.SnowDeviceManagement.DescribeExecution
( -- * Creating a Request
DescribeExecution (..),
newDescribeExecution,
-- * Request Lenses
describeExecution_managedDeviceId,
describeExecution_taskId,
-- * Destructuring the Response
DescribeExecutionResponse (..),
newDescribeExecutionResponse,
-- * Response Lenses
describeExecutionResponse_executionId,
describeExecutionResponse_lastUpdatedAt,
describeExecutionResponse_managedDeviceId,
describeExecutionResponse_startedAt,
describeExecutionResponse_state,
describeExecutionResponse_taskId,
describeExecutionResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SnowDeviceManagement.Types
-- | /See:/ 'newDescribeExecution' smart constructor.
data DescribeExecution = DescribeExecution'
{ -- | The ID of the managed device.
managedDeviceId :: Prelude.Text,
-- | The ID of the task that the action is describing.
taskId :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeExecution' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'managedDeviceId', 'describeExecution_managedDeviceId' - The ID of the managed device.
--
-- 'taskId', 'describeExecution_taskId' - The ID of the task that the action is describing.
newDescribeExecution ::
-- | 'managedDeviceId'
Prelude.Text ->
-- | 'taskId'
Prelude.Text ->
DescribeExecution
newDescribeExecution pManagedDeviceId_ pTaskId_ =
DescribeExecution'
{ managedDeviceId =
pManagedDeviceId_,
taskId = pTaskId_
}
-- | The ID of the managed device.
describeExecution_managedDeviceId :: Lens.Lens' DescribeExecution Prelude.Text
describeExecution_managedDeviceId = Lens.lens (\DescribeExecution' {managedDeviceId} -> managedDeviceId) (\s@DescribeExecution' {} a -> s {managedDeviceId = a} :: DescribeExecution)
-- | The ID of the task that the action is describing.
describeExecution_taskId :: Lens.Lens' DescribeExecution Prelude.Text
describeExecution_taskId = Lens.lens (\DescribeExecution' {taskId} -> taskId) (\s@DescribeExecution' {} a -> s {taskId = a} :: DescribeExecution)
instance Core.AWSRequest DescribeExecution where
type
AWSResponse DescribeExecution =
DescribeExecutionResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
DescribeExecutionResponse'
Prelude.<$> (x Data..?> "executionId")
Prelude.<*> (x Data..?> "lastUpdatedAt")
Prelude.<*> (x Data..?> "managedDeviceId")
Prelude.<*> (x Data..?> "startedAt")
Prelude.<*> (x Data..?> "state")
Prelude.<*> (x Data..?> "taskId")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable DescribeExecution where
hashWithSalt _salt DescribeExecution' {..} =
_salt
`Prelude.hashWithSalt` managedDeviceId
`Prelude.hashWithSalt` taskId
instance Prelude.NFData DescribeExecution where
rnf DescribeExecution' {..} =
Prelude.rnf managedDeviceId
`Prelude.seq` Prelude.rnf taskId
instance Data.ToHeaders DescribeExecution where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON DescribeExecution where
toJSON = Prelude.const (Data.Object Prelude.mempty)
instance Data.ToPath DescribeExecution where
toPath DescribeExecution' {..} =
Prelude.mconcat
[ "/task/",
Data.toBS taskId,
"/execution/",
Data.toBS managedDeviceId
]
instance Data.ToQuery DescribeExecution where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newDescribeExecutionResponse' smart constructor.
data DescribeExecutionResponse = DescribeExecutionResponse'
{ -- | The ID of the execution.
executionId :: Prelude.Maybe Prelude.Text,
-- | When the status of the execution was last updated.
lastUpdatedAt :: Prelude.Maybe Data.POSIX,
-- | The ID of the managed device that the task is being executed on.
managedDeviceId :: Prelude.Maybe Prelude.Text,
-- | When the execution began.
startedAt :: Prelude.Maybe Data.POSIX,
-- | The current state of the execution.
state :: Prelude.Maybe ExecutionState,
-- | The ID of the task being executed on the device.
taskId :: Prelude.Maybe Prelude.Text,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DescribeExecutionResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'executionId', 'describeExecutionResponse_executionId' - The ID of the execution.
--
-- 'lastUpdatedAt', 'describeExecutionResponse_lastUpdatedAt' - When the status of the execution was last updated.
--
-- 'managedDeviceId', 'describeExecutionResponse_managedDeviceId' - The ID of the managed device that the task is being executed on.
--
-- 'startedAt', 'describeExecutionResponse_startedAt' - When the execution began.
--
-- 'state', 'describeExecutionResponse_state' - The current state of the execution.
--
-- 'taskId', 'describeExecutionResponse_taskId' - The ID of the task being executed on the device.
--
-- 'httpStatus', 'describeExecutionResponse_httpStatus' - The response's http status code.
newDescribeExecutionResponse ::
-- | 'httpStatus'
Prelude.Int ->
DescribeExecutionResponse
newDescribeExecutionResponse pHttpStatus_ =
DescribeExecutionResponse'
{ executionId =
Prelude.Nothing,
lastUpdatedAt = Prelude.Nothing,
managedDeviceId = Prelude.Nothing,
startedAt = Prelude.Nothing,
state = Prelude.Nothing,
taskId = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | The ID of the execution.
describeExecutionResponse_executionId :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe Prelude.Text)
describeExecutionResponse_executionId = Lens.lens (\DescribeExecutionResponse' {executionId} -> executionId) (\s@DescribeExecutionResponse' {} a -> s {executionId = a} :: DescribeExecutionResponse)
-- | When the status of the execution was last updated.
describeExecutionResponse_lastUpdatedAt :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe Prelude.UTCTime)
describeExecutionResponse_lastUpdatedAt = Lens.lens (\DescribeExecutionResponse' {lastUpdatedAt} -> lastUpdatedAt) (\s@DescribeExecutionResponse' {} a -> s {lastUpdatedAt = a} :: DescribeExecutionResponse) Prelude.. Lens.mapping Data._Time
-- | The ID of the managed device that the task is being executed on.
describeExecutionResponse_managedDeviceId :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe Prelude.Text)
describeExecutionResponse_managedDeviceId = Lens.lens (\DescribeExecutionResponse' {managedDeviceId} -> managedDeviceId) (\s@DescribeExecutionResponse' {} a -> s {managedDeviceId = a} :: DescribeExecutionResponse)
-- | When the execution began.
describeExecutionResponse_startedAt :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe Prelude.UTCTime)
describeExecutionResponse_startedAt = Lens.lens (\DescribeExecutionResponse' {startedAt} -> startedAt) (\s@DescribeExecutionResponse' {} a -> s {startedAt = a} :: DescribeExecutionResponse) Prelude.. Lens.mapping Data._Time
-- | The current state of the execution.
describeExecutionResponse_state :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe ExecutionState)
describeExecutionResponse_state = Lens.lens (\DescribeExecutionResponse' {state} -> state) (\s@DescribeExecutionResponse' {} a -> s {state = a} :: DescribeExecutionResponse)
-- | The ID of the task being executed on the device.
describeExecutionResponse_taskId :: Lens.Lens' DescribeExecutionResponse (Prelude.Maybe Prelude.Text)
describeExecutionResponse_taskId = Lens.lens (\DescribeExecutionResponse' {taskId} -> taskId) (\s@DescribeExecutionResponse' {} a -> s {taskId = a} :: DescribeExecutionResponse)
-- | The response's http status code.
describeExecutionResponse_httpStatus :: Lens.Lens' DescribeExecutionResponse Prelude.Int
describeExecutionResponse_httpStatus = Lens.lens (\DescribeExecutionResponse' {httpStatus} -> httpStatus) (\s@DescribeExecutionResponse' {} a -> s {httpStatus = a} :: DescribeExecutionResponse)
instance Prelude.NFData DescribeExecutionResponse where
rnf DescribeExecutionResponse' {..} =
Prelude.rnf executionId
`Prelude.seq` Prelude.rnf lastUpdatedAt
`Prelude.seq` Prelude.rnf managedDeviceId
`Prelude.seq` Prelude.rnf startedAt
`Prelude.seq` Prelude.rnf state
`Prelude.seq` Prelude.rnf taskId
`Prelude.seq` Prelude.rnf httpStatus