amazonka-storagegateway-2.0: Amazon Storage Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.StorageGateway.StartGateway

Description

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.

Synopsis

Creating a Request

data StartGateway Source #

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

See: newStartGateway smart constructor.

Constructors

StartGateway' 

Fields

Instances

Instances details
ToJSON StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

ToHeaders StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

ToPath StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

ToQuery StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

AWSRequest StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type AWSResponse StartGateway #

Generic StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type Rep StartGateway :: Type -> Type #

Read StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Show StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

NFData StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Methods

rnf :: StartGateway -> () #

Eq StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Hashable StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

type AWSResponse StartGateway Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

type Rep StartGateway Source # 
Instance details

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 Source #

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

Destructuring the Response

data StartGatewayResponse Source #

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

See: newStartGatewayResponse smart constructor.

Constructors

StartGatewayResponse' 

Fields

Instances

Instances details
Generic StartGatewayResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Associated Types

type Rep StartGatewayResponse :: Type -> Type #

Read StartGatewayResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Show StartGatewayResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

NFData StartGatewayResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

Methods

rnf :: StartGatewayResponse -> () #

Eq StartGatewayResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.StartGateway

type Rep StartGatewayResponse Source # 
Instance details

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 Source #

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