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.WorkSpaces.StopWorkspaces

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Creating a Request

data StopWorkspaces Source #

See: newStopWorkspaces smart constructor.

Constructors

StopWorkspaces'
Fields stopWorkspaceRequests :: NonEmpty StopRequest The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

Instances

Instances details

Eq StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods (==) :: StopWorkspaces -> StopWorkspaces -> Bool # (/=) :: StopWorkspaces -> StopWorkspaces -> Bool #
Read StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods readsPrec :: Int -> ReadS StopWorkspaces # readList :: ReadS [StopWorkspaces] # readPrec :: ReadPrec StopWorkspaces # readListPrec :: ReadPrec [StopWorkspaces] #
Show StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods showsPrec :: Int -> StopWorkspaces -> ShowS # show :: StopWorkspaces -> String # showList :: [StopWorkspaces] -> ShowS #
Generic StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Associated Types type Rep StopWorkspaces :: Type -> Type # Methods from :: StopWorkspaces -> Rep StopWorkspaces x # to :: Rep StopWorkspaces x -> StopWorkspaces #
NFData StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods rnf :: StopWorkspaces -> () #
Hashable StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods hashWithSalt :: Int -> StopWorkspaces -> Int # hash :: StopWorkspaces -> Int #
ToJSON StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods toJSON :: StopWorkspaces -> Value # toEncoding :: StopWorkspaces -> Encoding # toJSONList :: [StopWorkspaces] -> Value # toEncodingList :: [StopWorkspaces] -> Encoding #
AWSRequest StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Associated Types type AWSResponse StopWorkspaces # Methods request :: StopWorkspaces -> Request StopWorkspaces # response :: MonadResource m => Logger -> Service -> Proxy StopWorkspaces -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopWorkspaces))) #
ToHeaders StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods toHeaders :: StopWorkspaces -> [Header] #
ToPath StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods toPath :: StopWorkspaces -> ByteString #
ToQuery StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods toQuery :: StopWorkspaces -> QueryString #
type Rep StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces type Rep StopWorkspaces = D1 ('MetaData "StopWorkspaces" "Amazonka.WorkSpaces.StopWorkspaces" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "StopWorkspaces'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stopWorkspaceRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty StopRequest))))
type AWSResponse StopWorkspaces Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces type AWSResponse StopWorkspaces = StopWorkspacesResponse

newStopWorkspaces Source #

Arguments

:: NonEmpty StopRequest	`$sel:stopWorkspaceRequests:StopWorkspaces'`
-> StopWorkspaces

Create a value of StopWorkspaces 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:stopWorkspaceRequests:StopWorkspaces', stopWorkspaces_stopWorkspaceRequests - The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

Request Lenses

stopWorkspaces_stopWorkspaceRequests :: Lens' StopWorkspaces (NonEmpty StopRequest) Source #

The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

Destructuring the Response

data StopWorkspacesResponse Source #

See: newStopWorkspacesResponse smart constructor.

Constructors

StopWorkspacesResponse'
Fields failedRequests :: Maybe [FailedWorkspaceChangeRequest] Information about the WorkSpaces that could not be stopped. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods (==) :: StopWorkspacesResponse -> StopWorkspacesResponse -> Bool # (/=) :: StopWorkspacesResponse -> StopWorkspacesResponse -> Bool #
Read StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods readsPrec :: Int -> ReadS StopWorkspacesResponse # readList :: ReadS [StopWorkspacesResponse] # readPrec :: ReadPrec StopWorkspacesResponse # readListPrec :: ReadPrec [StopWorkspacesResponse] #
Show StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods showsPrec :: Int -> StopWorkspacesResponse -> ShowS # show :: StopWorkspacesResponse -> String # showList :: [StopWorkspacesResponse] -> ShowS #
Generic StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Associated Types type Rep StopWorkspacesResponse :: Type -> Type # Methods from :: StopWorkspacesResponse -> Rep StopWorkspacesResponse x # to :: Rep StopWorkspacesResponse x -> StopWorkspacesResponse #
NFData StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces Methods rnf :: StopWorkspacesResponse -> () #
type Rep StopWorkspacesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.StopWorkspaces type Rep StopWorkspacesResponse = D1 ('MetaData "StopWorkspacesResponse" "Amazonka.WorkSpaces.StopWorkspaces" "libZSservicesZSamazonka-workspacesZSamazonka-workspaces" 'False) (C1 ('MetaCons "StopWorkspacesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedRequests") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FailedWorkspaceChangeRequest])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopWorkspacesResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopWorkspacesResponse'`
-> StopWorkspacesResponse

Create a value of StopWorkspacesResponse 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:failedRequests:StopWorkspacesResponse', stopWorkspacesResponse_failedRequests - Information about the WorkSpaces that could not be stopped.

$sel:httpStatus:StopWorkspacesResponse', stopWorkspacesResponse_httpStatus - The response's http status code.

Response Lenses

stopWorkspacesResponse_failedRequests :: Lens' StopWorkspacesResponse (Maybe [FailedWorkspaceChangeRequest]) Source #

Information about the WorkSpaces that could not be stopped.

stopWorkspacesResponse_httpStatus :: Lens' StopWorkspacesResponse Int Source #

The response's http status code.