Network.AWS.Lightsail.StopInstance

Stops a specific Amazon Lightsail instance that is currently running.

Creating a Request

stopInstance

Arguments

:: Text

siInstanceName

-> StopInstance

Creates a value of StopInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• siForce - When set to True , forces a Lightsail instance that is stuck in a stopping state to stop. Important: Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.
• siInstanceName - The name of the instance (a virtual private server) to stop.

data StopInstance

See: stopInstance smart constructor.

Instances

Eq StopInstance

Methods

(==) :: StopInstance -> StopInstance -> Bool

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

Data StopInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopInstance -> c StopInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopInstance

toConstr :: StopInstance -> Constr

dataTypeOf :: StopInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StopInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopInstance)

gmapT :: (forall b. Data b => b -> b) -> StopInstance -> StopInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> StopInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StopInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopInstance -> m StopInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopInstance -> m StopInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopInstance -> m StopInstance

Read StopInstance

Methods

readsPrec :: Int -> ReadS StopInstance

readList :: ReadS [StopInstance]

readPrec :: ReadPrec StopInstance

readListPrec :: ReadPrec [StopInstance]

Show StopInstance

Methods

showsPrec :: Int -> StopInstance -> ShowS

show :: StopInstance -> String

showList :: [StopInstance] -> ShowS

Generic StopInstance

Associated Types

type Rep StopInstance :: * -> *

Methods

from :: StopInstance -> Rep StopInstance x

to :: Rep StopInstance x -> StopInstance

Hashable StopInstance

Methods

hashWithSalt :: Int -> StopInstance -> Int

hash :: StopInstance -> Int

ToJSON StopInstance

Methods

toJSON :: StopInstance -> Value

toEncoding :: StopInstance -> Encoding

toJSONList :: [StopInstance] -> Value

toEncodingList :: [StopInstance] -> Encoding

NFData StopInstance

Methods

rnf :: StopInstance -> ()

AWSRequest StopInstance

Associated Types

type Rs StopInstance :: *

Methods

request :: StopInstance -> Request StopInstance

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StopInstance -> ClientResponse -> m (Response StopInstance)

ToHeaders StopInstance

Methods

toHeaders :: StopInstance -> [Header]

ToPath StopInstance

Methods

toPath :: StopInstance -> ByteString

ToQuery StopInstance

Methods

toQuery :: StopInstance -> QueryString

type Rep StopInstance

type Rep StopInstance = D1 * (MetaData "StopInstance" "Network.AWS.Lightsail.StopInstance" "amazonka-lightsail-1.6.0-ARMP2uYvcAnENqDU8iFIes" False) (C1 * (MetaCons "StopInstance'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_siForce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_siInstanceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs StopInstance

type Rs StopInstance = StopInstanceResponse

Request Lenses

siForce :: Lens' StopInstance (Maybe Bool)

When set to True , forces a Lightsail instance that is stuck in a stopping state to stop. Important: Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

siInstanceName :: Lens' StopInstance Text

The name of the instance (a virtual private server) to stop.

Destructuring the Response

stopInstanceResponse

Arguments

:: Int

sirsResponseStatus

-> StopInstanceResponse

Creates a value of StopInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sirsOperations - An array of key-value pairs containing information about the request operation.
• sirsResponseStatus - -- | The response status code.

data StopInstanceResponse

See: stopInstanceResponse smart constructor.

Instances

Eq StopInstanceResponse

Methods

(==) :: StopInstanceResponse -> StopInstanceResponse -> Bool

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

Data StopInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopInstanceResponse -> c StopInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopInstanceResponse

toConstr :: StopInstanceResponse -> Constr

dataTypeOf :: StopInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StopInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> StopInstanceResponse -> StopInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StopInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StopInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopInstanceResponse -> m StopInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopInstanceResponse -> m StopInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopInstanceResponse -> m StopInstanceResponse

Read StopInstanceResponse

Methods

readsPrec :: Int -> ReadS StopInstanceResponse

readList :: ReadS [StopInstanceResponse]

readPrec :: ReadPrec StopInstanceResponse

readListPrec :: ReadPrec [StopInstanceResponse]

Show StopInstanceResponse

Methods

showsPrec :: Int -> StopInstanceResponse -> ShowS

show :: StopInstanceResponse -> String

showList :: [StopInstanceResponse] -> ShowS

Generic StopInstanceResponse

Associated Types

type Rep StopInstanceResponse :: * -> *

Methods

from :: StopInstanceResponse -> Rep StopInstanceResponse x

to :: Rep StopInstanceResponse x -> StopInstanceResponse

NFData StopInstanceResponse

Methods

rnf :: StopInstanceResponse -> ()

type Rep StopInstanceResponse

type Rep StopInstanceResponse = D1 * (MetaData "StopInstanceResponse" "Network.AWS.Lightsail.StopInstance" "amazonka-lightsail-1.6.0-ARMP2uYvcAnENqDU8iFIes" False) (C1 * (MetaCons "StopInstanceResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sirsOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Operation]))) (S1 * (MetaSel (Just Symbol "_sirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sirsOperations :: Lens' StopInstanceResponse [Operation]

An array of key-value pairs containing information about the request operation.

sirsResponseStatus :: Lens' StopInstanceResponse Int

• - | The response status code.