Network.AWS.StorageGateway.ShutdownGateway

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a '200 OK' success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

Creating a Request

shutdownGateway

Arguments

:: Text

sGatewayARN

-> ShutdownGateway

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

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

• sGatewayARN

data ShutdownGateway

A JSON object containing the of the gateway to shut down.

See: shutdownGateway smart constructor.

Instances

Eq ShutdownGateway

Methods

(==) :: ShutdownGateway -> ShutdownGateway -> Bool

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

Data ShutdownGateway

Methods

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

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

toConstr :: ShutdownGateway -> Constr

dataTypeOf :: ShutdownGateway -> DataType

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

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

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

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

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

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

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

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

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

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

Read ShutdownGateway

Methods

readsPrec :: Int -> ReadS ShutdownGateway

readList :: ReadS [ShutdownGateway]

readPrec :: ReadPrec ShutdownGateway

readListPrec :: ReadPrec [ShutdownGateway]

Show ShutdownGateway

Methods

showsPrec :: Int -> ShutdownGateway -> ShowS

show :: ShutdownGateway -> String

showList :: [ShutdownGateway] -> ShowS

Generic ShutdownGateway

Associated Types

type Rep ShutdownGateway :: * -> *

Methods

from :: ShutdownGateway -> Rep ShutdownGateway x

to :: Rep ShutdownGateway x -> ShutdownGateway

Hashable ShutdownGateway

Methods

hashWithSalt :: Int -> ShutdownGateway -> Int

hash :: ShutdownGateway -> Int

ToJSON ShutdownGateway

Methods

toJSON :: ShutdownGateway -> Value

toEncoding :: ShutdownGateway -> Encoding

toJSONList :: [ShutdownGateway] -> Value

toEncodingList :: [ShutdownGateway] -> Encoding

NFData ShutdownGateway

Methods

rnf :: ShutdownGateway -> ()

AWSRequest ShutdownGateway

Associated Types

type Rs ShutdownGateway :: *

Methods

request :: ShutdownGateway -> Request ShutdownGateway

response :: MonadResource m => Logger -> Service -> Proxy * ShutdownGateway -> ClientResponse -> m (Response ShutdownGateway)

ToQuery ShutdownGateway

Methods

toQuery :: ShutdownGateway -> QueryString

ToPath ShutdownGateway

Methods

toPath :: ShutdownGateway -> ByteString

ToHeaders ShutdownGateway

Methods

toHeaders :: ShutdownGateway -> [Header]

type Rep ShutdownGateway

type Rep ShutdownGateway = D1 (MetaData "ShutdownGateway" "Network.AWS.StorageGateway.ShutdownGateway" "amazonka-storagegateway-1.4.1-L8VGb4RzUam2oDN29DqQAk" True) (C1 (MetaCons "ShutdownGateway'" PrefixI True) (S1 (MetaSel (Just Symbol "_sGatewayARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs ShutdownGateway

type Rs ShutdownGateway = ShutdownGatewayResponse

Request Lenses

sGatewayARN :: Lens' ShutdownGateway Text

Undocumented member.

Destructuring the Response

shutdownGatewayResponse

Arguments

:: Int

srsResponseStatus

-> ShutdownGatewayResponse

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

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

• srsGatewayARN
• srsResponseStatus

data ShutdownGatewayResponse

A JSON object containing the of the gateway that was shut down.

See: shutdownGatewayResponse smart constructor.

Instances

Eq ShutdownGatewayResponse

Methods

(==) :: ShutdownGatewayResponse -> ShutdownGatewayResponse -> Bool

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

Data ShutdownGatewayResponse

Methods

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

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

toConstr :: ShutdownGatewayResponse -> Constr

dataTypeOf :: ShutdownGatewayResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ShutdownGatewayResponse

Methods

readsPrec :: Int -> ReadS ShutdownGatewayResponse

readList :: ReadS [ShutdownGatewayResponse]

readPrec :: ReadPrec ShutdownGatewayResponse

readListPrec :: ReadPrec [ShutdownGatewayResponse]

Show ShutdownGatewayResponse

Methods

showsPrec :: Int -> ShutdownGatewayResponse -> ShowS

show :: ShutdownGatewayResponse -> String

showList :: [ShutdownGatewayResponse] -> ShowS

Generic ShutdownGatewayResponse

Associated Types

type Rep ShutdownGatewayResponse :: * -> *

Methods

from :: ShutdownGatewayResponse -> Rep ShutdownGatewayResponse x

to :: Rep ShutdownGatewayResponse x -> ShutdownGatewayResponse

NFData ShutdownGatewayResponse

Methods

rnf :: ShutdownGatewayResponse -> ()

type Rep ShutdownGatewayResponse

type Rep ShutdownGatewayResponse = D1 (MetaData "ShutdownGatewayResponse" "Network.AWS.StorageGateway.ShutdownGateway" "amazonka-storagegateway-1.4.1-L8VGb4RzUam2oDN29DqQAk" False) (C1 (MetaCons "ShutdownGatewayResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_srsGatewayARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_srsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

srsGatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text)

Undocumented member.

srsResponseStatus :: Lens' ShutdownGatewayResponse Int

The response status code.