Amazonka.StorageGateway.StartGateway

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

Creating a Request

data StartGateway

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

See: newStartGateway smart constructor.

Constructors

StartGateway'

Fields

• gatewayARN :: Text

Instances

ToJSON StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

toJSON :: StartGateway -> Value

toEncoding :: StartGateway -> Encoding

toJSONList :: [StartGateway] -> Value

toEncodingList :: [StartGateway] -> Encoding

ToHeaders StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

toHeaders :: StartGateway -> [Header]

ToPath StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

toPath :: StartGateway -> ByteString

ToQuery StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

toQuery :: StartGateway -> QueryString

AWSRequest StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type AWSResponse StartGateway

Methods

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

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

Generic StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type Rep StartGateway :: Type -> Type

Methods

from :: StartGateway -> Rep StartGateway x

to :: Rep StartGateway x -> StartGateway

Read StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

readsPrec :: Int -> ReadS StartGateway

readList :: ReadS [StartGateway]

readPrec :: ReadPrec StartGateway

readListPrec :: ReadPrec [StartGateway]

Show StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

showsPrec :: Int -> StartGateway -> ShowS

show :: StartGateway -> String

showList :: [StartGateway] -> ShowS

NFData StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

rnf :: StartGateway -> ()

Eq StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

(==) :: StartGateway -> StartGateway -> Bool

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

Hashable StartGateway

Defined in Amazonka.StorageGateway.StartGateway

Methods

hashWithSalt :: Int -> StartGateway -> Int

hash :: StartGateway -> Int

type AWSResponse StartGateway

Defined in Amazonka.StorageGateway.StartGateway

type AWSResponse StartGateway = StartGatewayResponse

type Rep StartGateway

Defined in Amazonka.StorageGateway.StartGateway

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

newStartGateway

Arguments

:: Text

StartGateway

-> StartGateway

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

StartGateway, startGateway_gatewayARN - Undocumented member.

Request Lenses

startGateway_gatewayARN :: Lens' StartGateway Text

Undocumented member.

Destructuring the Response

data StartGatewayResponse

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

See: newStartGatewayResponse smart constructor.

Constructors

StartGatewayResponse'

Fields

• gatewayARN :: Maybe Text
• httpStatus :: Int

  The response's http status code.

Instances

Generic StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type Rep StartGatewayResponse :: Type -> Type

Methods

from :: StartGatewayResponse -> Rep StartGatewayResponse x

to :: Rep StartGatewayResponse x -> StartGatewayResponse

Read StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

Methods

readsPrec :: Int -> ReadS StartGatewayResponse

readList :: ReadS [StartGatewayResponse]

readPrec :: ReadPrec StartGatewayResponse

readListPrec :: ReadPrec [StartGatewayResponse]

Show StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

Methods

showsPrec :: Int -> StartGatewayResponse -> ShowS

show :: StartGatewayResponse -> String

showList :: [StartGatewayResponse] -> ShowS

NFData StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

Methods

rnf :: StartGatewayResponse -> ()

Eq StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

Methods

(==) :: StartGatewayResponse -> StartGatewayResponse -> Bool

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

type Rep StartGatewayResponse

Defined in Amazonka.StorageGateway.StartGateway

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

newStartGatewayResponse

Arguments

:: Int

$sel:httpStatus:StartGatewayResponse'

-> StartGatewayResponse

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

StartGateway, startGatewayResponse_gatewayARN - Undocumented member.

$sel:httpStatus:StartGatewayResponse', startGatewayResponse_httpStatus - The response's http status code.

Response Lenses

startGatewayResponse_gatewayARN :: Lens' StartGatewayResponse (Maybe Text)

Undocumented member.

startGatewayResponse_httpStatus :: Lens' StartGatewayResponse Int

The response's http status code.