Amazonka.WorkSpaces.ModifyWorkspaceState

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.

Creating a Request

data ModifyWorkspaceState

See: newModifyWorkspaceState smart constructor.

Constructors

ModifyWorkspaceState'

Fields

• workspaceId :: Text

  The identifier of the WorkSpace.

• workspaceState :: TargetWorkspaceState

  The WorkSpace state.

Instances

ToJSON ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

toJSON :: ModifyWorkspaceState -> Value

toEncoding :: ModifyWorkspaceState -> Encoding

toJSONList :: [ModifyWorkspaceState] -> Value

toEncodingList :: [ModifyWorkspaceState] -> Encoding

ToHeaders ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

toHeaders :: ModifyWorkspaceState -> [Header]

ToPath ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

toPath :: ModifyWorkspaceState -> ByteString

ToQuery ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

toQuery :: ModifyWorkspaceState -> QueryString

AWSRequest ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Associated Types

type AWSResponse ModifyWorkspaceState

Methods

request :: (Service -> Service) -> ModifyWorkspaceState -> Request ModifyWorkspaceState

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyWorkspaceState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyWorkspaceState)))

Generic ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Associated Types

type Rep ModifyWorkspaceState :: Type -> Type

Methods

from :: ModifyWorkspaceState -> Rep ModifyWorkspaceState x

to :: Rep ModifyWorkspaceState x -> ModifyWorkspaceState

Read ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

readsPrec :: Int -> ReadS ModifyWorkspaceState

readList :: ReadS [ModifyWorkspaceState]

readPrec :: ReadPrec ModifyWorkspaceState

readListPrec :: ReadPrec [ModifyWorkspaceState]

Show ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

showsPrec :: Int -> ModifyWorkspaceState -> ShowS

show :: ModifyWorkspaceState -> String

showList :: [ModifyWorkspaceState] -> ShowS

NFData ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

rnf :: ModifyWorkspaceState -> ()

Eq ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

(==) :: ModifyWorkspaceState -> ModifyWorkspaceState -> Bool

(/=) :: ModifyWorkspaceState -> ModifyWorkspaceState -> Bool

Hashable ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

hashWithSalt :: Int -> ModifyWorkspaceState -> Int

hash :: ModifyWorkspaceState -> Int

type AWSResponse ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

type AWSResponse ModifyWorkspaceState = ModifyWorkspaceStateResponse

type Rep ModifyWorkspaceState

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

type Rep ModifyWorkspaceState = D1 ('MetaData "ModifyWorkspaceState" "Amazonka.WorkSpaces.ModifyWorkspaceState" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ModifyWorkspaceState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workspaceState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TargetWorkspaceState)))

newModifyWorkspaceState

Arguments

:: Text

ModifyWorkspaceState

-> TargetWorkspaceState

$sel:workspaceState:ModifyWorkspaceState'

-> ModifyWorkspaceState

Create a value of ModifyWorkspaceState 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:

ModifyWorkspaceState, modifyWorkspaceState_workspaceId - The identifier of the WorkSpace.

$sel:workspaceState:ModifyWorkspaceState', modifyWorkspaceState_workspaceState - The WorkSpace state.

Request Lenses

modifyWorkspaceState_workspaceId :: Lens' ModifyWorkspaceState Text

The identifier of the WorkSpace.

modifyWorkspaceState_workspaceState :: Lens' ModifyWorkspaceState TargetWorkspaceState

The WorkSpace state.

Destructuring the Response

data ModifyWorkspaceStateResponse

See: newModifyWorkspaceStateResponse smart constructor.

Constructors

ModifyWorkspaceStateResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Associated Types

type Rep ModifyWorkspaceStateResponse :: Type -> Type

Methods

from :: ModifyWorkspaceStateResponse -> Rep ModifyWorkspaceStateResponse x

to :: Rep ModifyWorkspaceStateResponse x -> ModifyWorkspaceStateResponse

Read ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

readsPrec :: Int -> ReadS ModifyWorkspaceStateResponse

readList :: ReadS [ModifyWorkspaceStateResponse]

readPrec :: ReadPrec ModifyWorkspaceStateResponse

readListPrec :: ReadPrec [ModifyWorkspaceStateResponse]

Show ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

showsPrec :: Int -> ModifyWorkspaceStateResponse -> ShowS

show :: ModifyWorkspaceStateResponse -> String

showList :: [ModifyWorkspaceStateResponse] -> ShowS

NFData ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

rnf :: ModifyWorkspaceStateResponse -> ()

Eq ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

Methods

(==) :: ModifyWorkspaceStateResponse -> ModifyWorkspaceStateResponse -> Bool

(/=) :: ModifyWorkspaceStateResponse -> ModifyWorkspaceStateResponse -> Bool

type Rep ModifyWorkspaceStateResponse

Defined in Amazonka.WorkSpaces.ModifyWorkspaceState

type Rep ModifyWorkspaceStateResponse = D1 ('MetaData "ModifyWorkspaceStateResponse" "Amazonka.WorkSpaces.ModifyWorkspaceState" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "ModifyWorkspaceStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyWorkspaceStateResponse

Arguments

:: Int

$sel:httpStatus:ModifyWorkspaceStateResponse'

-> ModifyWorkspaceStateResponse

Create a value of ModifyWorkspaceStateResponse 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:httpStatus:ModifyWorkspaceStateResponse', modifyWorkspaceStateResponse_httpStatus - The response's http status code.

Response Lenses

modifyWorkspaceStateResponse_httpStatus :: Lens' ModifyWorkspaceStateResponse Int

The response's http status code.