Amazonka.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 gateway's virtual machine (VM) and not the host 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

data ShutdownGateway

A JSON object containing the Amazon Resource Name (ARN) of the gateway to shut down.

See: newShutdownGateway smart constructor.

Constructors

ShutdownGateway'

Fields

• gatewayARN :: Text

Instances

ToJSON ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

toJSON :: ShutdownGateway -> Value

toEncoding :: ShutdownGateway -> Encoding

toJSONList :: [ShutdownGateway] -> Value

toEncodingList :: [ShutdownGateway] -> Encoding

ToHeaders ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

toHeaders :: ShutdownGateway -> [Header]

ToPath ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

toPath :: ShutdownGateway -> ByteString

ToQuery ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

toQuery :: ShutdownGateway -> QueryString

AWSRequest ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Associated Types

type AWSResponse ShutdownGateway

Methods

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

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

Generic ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Associated Types

type Rep ShutdownGateway :: Type -> Type

Methods

from :: ShutdownGateway -> Rep ShutdownGateway x

to :: Rep ShutdownGateway x -> ShutdownGateway

Read ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

readsPrec :: Int -> ReadS ShutdownGateway

readList :: ReadS [ShutdownGateway]

readPrec :: ReadPrec ShutdownGateway

readListPrec :: ReadPrec [ShutdownGateway]

Show ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

showsPrec :: Int -> ShutdownGateway -> ShowS

show :: ShutdownGateway -> String

showList :: [ShutdownGateway] -> ShowS

NFData ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

rnf :: ShutdownGateway -> ()

Eq ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

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

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

Hashable ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

hashWithSalt :: Int -> ShutdownGateway -> Int

hash :: ShutdownGateway -> Int

type AWSResponse ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

type AWSResponse ShutdownGateway = ShutdownGatewayResponse

type Rep ShutdownGateway

Defined in Amazonka.StorageGateway.ShutdownGateway

type Rep ShutdownGateway = D1 ('MetaData "ShutdownGateway" "Amazonka.StorageGateway.ShutdownGateway" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ShutdownGateway'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newShutdownGateway

Arguments

:: Text

ShutdownGateway

-> ShutdownGateway

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

ShutdownGateway, shutdownGateway_gatewayARN - Undocumented member.

Request Lenses

shutdownGateway_gatewayARN :: Lens' ShutdownGateway Text

Undocumented member.

Destructuring the Response

data ShutdownGatewayResponse

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was shut down.

See: newShutdownGatewayResponse smart constructor.

Constructors

ShutdownGatewayResponse'

Fields

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

Associated Types

type Rep ShutdownGatewayResponse :: Type -> Type

Methods

from :: ShutdownGatewayResponse -> Rep ShutdownGatewayResponse x

to :: Rep ShutdownGatewayResponse x -> ShutdownGatewayResponse

Read ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

readsPrec :: Int -> ReadS ShutdownGatewayResponse

readList :: ReadS [ShutdownGatewayResponse]

readPrec :: ReadPrec ShutdownGatewayResponse

readListPrec :: ReadPrec [ShutdownGatewayResponse]

Show ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

showsPrec :: Int -> ShutdownGatewayResponse -> ShowS

show :: ShutdownGatewayResponse -> String

showList :: [ShutdownGatewayResponse] -> ShowS

NFData ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

rnf :: ShutdownGatewayResponse -> ()

Eq ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

Methods

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

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

type Rep ShutdownGatewayResponse

Defined in Amazonka.StorageGateway.ShutdownGateway

type Rep ShutdownGatewayResponse = D1 ('MetaData "ShutdownGatewayResponse" "Amazonka.StorageGateway.ShutdownGateway" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "ShutdownGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newShutdownGatewayResponse

Arguments

:: Int

$sel:httpStatus:ShutdownGatewayResponse'

-> ShutdownGatewayResponse

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

ShutdownGateway, shutdownGatewayResponse_gatewayARN - Undocumented member.

$sel:httpStatus:ShutdownGatewayResponse', shutdownGatewayResponse_httpStatus - The response's http status code.

Response Lenses

shutdownGatewayResponse_gatewayARN :: Lens' ShutdownGatewayResponse (Maybe Text)

Undocumented member.

shutdownGatewayResponse_httpStatus :: Lens' ShutdownGatewayResponse Int

The response's http status code.