amazonka-workspaces-2.0: gen/Amazonka/WorkSpaces/ModifyWorkspaceState.hs
{-# 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.WorkSpaces.ModifyWorkspaceState
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Sets the state of the specified WorkSpace.
--
-- To maintain a WorkSpace without being interrupted, set the WorkSpace
-- state to @ADMIN_MAINTENANCE@. WorkSpaces in this state do not respond to
-- requests to reboot, stop, start, rebuild, or restore. An AutoStop
-- WorkSpace in this state is not stopped. Users cannot log into a
-- WorkSpace in the @ADMIN_MAINTENANCE@ state.
module Amazonka.WorkSpaces.ModifyWorkspaceState
( -- * Creating a Request
ModifyWorkspaceState (..),
newModifyWorkspaceState,
-- * Request Lenses
modifyWorkspaceState_workspaceId,
modifyWorkspaceState_workspaceState,
-- * Destructuring the Response
ModifyWorkspaceStateResponse (..),
newModifyWorkspaceStateResponse,
-- * Response Lenses
modifyWorkspaceStateResponse_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.WorkSpaces.Types
-- | /See:/ 'newModifyWorkspaceState' smart constructor.
data ModifyWorkspaceState = ModifyWorkspaceState'
{ -- | The identifier of the WorkSpace.
workspaceId :: Prelude.Text,
-- | The WorkSpace state.
workspaceState :: TargetWorkspaceState
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ModifyWorkspaceState' 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:
--
-- 'workspaceId', 'modifyWorkspaceState_workspaceId' - The identifier of the WorkSpace.
--
-- 'workspaceState', 'modifyWorkspaceState_workspaceState' - The WorkSpace state.
newModifyWorkspaceState ::
-- | 'workspaceId'
Prelude.Text ->
-- | 'workspaceState'
TargetWorkspaceState ->
ModifyWorkspaceState
newModifyWorkspaceState
pWorkspaceId_
pWorkspaceState_ =
ModifyWorkspaceState'
{ workspaceId = pWorkspaceId_,
workspaceState = pWorkspaceState_
}
-- | The identifier of the WorkSpace.
modifyWorkspaceState_workspaceId :: Lens.Lens' ModifyWorkspaceState Prelude.Text
modifyWorkspaceState_workspaceId = Lens.lens (\ModifyWorkspaceState' {workspaceId} -> workspaceId) (\s@ModifyWorkspaceState' {} a -> s {workspaceId = a} :: ModifyWorkspaceState)
-- | The WorkSpace state.
modifyWorkspaceState_workspaceState :: Lens.Lens' ModifyWorkspaceState TargetWorkspaceState
modifyWorkspaceState_workspaceState = Lens.lens (\ModifyWorkspaceState' {workspaceState} -> workspaceState) (\s@ModifyWorkspaceState' {} a -> s {workspaceState = a} :: ModifyWorkspaceState)
instance Core.AWSRequest ModifyWorkspaceState where
type
AWSResponse ModifyWorkspaceState =
ModifyWorkspaceStateResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveEmpty
( \s h x ->
ModifyWorkspaceStateResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable ModifyWorkspaceState where
hashWithSalt _salt ModifyWorkspaceState' {..} =
_salt
`Prelude.hashWithSalt` workspaceId
`Prelude.hashWithSalt` workspaceState
instance Prelude.NFData ModifyWorkspaceState where
rnf ModifyWorkspaceState' {..} =
Prelude.rnf workspaceId
`Prelude.seq` Prelude.rnf workspaceState
instance Data.ToHeaders ModifyWorkspaceState where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "WorkspacesService.ModifyWorkspaceState" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON ModifyWorkspaceState where
toJSON ModifyWorkspaceState' {..} =
Data.object
( Prelude.catMaybes
[ Prelude.Just ("WorkspaceId" Data..= workspaceId),
Prelude.Just
("WorkspaceState" Data..= workspaceState)
]
)
instance Data.ToPath ModifyWorkspaceState where
toPath = Prelude.const "/"
instance Data.ToQuery ModifyWorkspaceState where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newModifyWorkspaceStateResponse' smart constructor.
data ModifyWorkspaceStateResponse = ModifyWorkspaceStateResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ModifyWorkspaceStateResponse' 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:
--
-- 'httpStatus', 'modifyWorkspaceStateResponse_httpStatus' - The response's http status code.
newModifyWorkspaceStateResponse ::
-- | 'httpStatus'
Prelude.Int ->
ModifyWorkspaceStateResponse
newModifyWorkspaceStateResponse pHttpStatus_ =
ModifyWorkspaceStateResponse'
{ httpStatus =
pHttpStatus_
}
-- | The response's http status code.
modifyWorkspaceStateResponse_httpStatus :: Lens.Lens' ModifyWorkspaceStateResponse Prelude.Int
modifyWorkspaceStateResponse_httpStatus = Lens.lens (\ModifyWorkspaceStateResponse' {httpStatus} -> httpStatus) (\s@ModifyWorkspaceStateResponse' {} a -> s {httpStatus = a} :: ModifyWorkspaceStateResponse)
instance Prelude.NFData ModifyWorkspaceStateResponse where
rnf ModifyWorkspaceStateResponse' {..} =
Prelude.rnf httpStatus