Amazonka.StorageGateway.DisableGateway

Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

After a gateway is disabled, it cannot be enabled.

Creating a Request

data DisableGateway

DisableGatewayInput

See: newDisableGateway smart constructor.

Constructors

DisableGateway'

Fields

• gatewayARN :: Text

Instances

ToJSON DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

toJSON :: DisableGateway -> Value

toEncoding :: DisableGateway -> Encoding

toJSONList :: [DisableGateway] -> Value

toEncodingList :: [DisableGateway] -> Encoding

ToHeaders DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

toHeaders :: DisableGateway -> [Header]

ToPath DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

toPath :: DisableGateway -> ByteString

ToQuery DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

toQuery :: DisableGateway -> QueryString

AWSRequest DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Associated Types

type AWSResponse DisableGateway

Methods

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

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

Generic DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Associated Types

type Rep DisableGateway :: Type -> Type

Methods

from :: DisableGateway -> Rep DisableGateway x

to :: Rep DisableGateway x -> DisableGateway

Read DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

readsPrec :: Int -> ReadS DisableGateway

readList :: ReadS [DisableGateway]

readPrec :: ReadPrec DisableGateway

readListPrec :: ReadPrec [DisableGateway]

Show DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

showsPrec :: Int -> DisableGateway -> ShowS

show :: DisableGateway -> String

showList :: [DisableGateway] -> ShowS

NFData DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

rnf :: DisableGateway -> ()

Eq DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

(==) :: DisableGateway -> DisableGateway -> Bool

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

Hashable DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

Methods

hashWithSalt :: Int -> DisableGateway -> Int

hash :: DisableGateway -> Int

type AWSResponse DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

type AWSResponse DisableGateway = DisableGatewayResponse

type Rep DisableGateway

Defined in Amazonka.StorageGateway.DisableGateway

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

newDisableGateway

Arguments

:: Text

DisableGateway

-> DisableGateway

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

DisableGateway, disableGateway_gatewayARN - Undocumented member.

Request Lenses

disableGateway_gatewayARN :: Lens' DisableGateway Text

Undocumented member.

Destructuring the Response

data DisableGatewayResponse

DisableGatewayOutput

See: newDisableGatewayResponse smart constructor.

Constructors

DisableGatewayResponse'

Fields

• gatewayARN :: Maybe Text

  The unique Amazon Resource Name (ARN) of the disabled gateway.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

Associated Types

type Rep DisableGatewayResponse :: Type -> Type

Methods

from :: DisableGatewayResponse -> Rep DisableGatewayResponse x

to :: Rep DisableGatewayResponse x -> DisableGatewayResponse

Read DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

Methods

readsPrec :: Int -> ReadS DisableGatewayResponse

readList :: ReadS [DisableGatewayResponse]

readPrec :: ReadPrec DisableGatewayResponse

readListPrec :: ReadPrec [DisableGatewayResponse]

Show DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

Methods

showsPrec :: Int -> DisableGatewayResponse -> ShowS

show :: DisableGatewayResponse -> String

showList :: [DisableGatewayResponse] -> ShowS

NFData DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

Methods

rnf :: DisableGatewayResponse -> ()

Eq DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

Methods

(==) :: DisableGatewayResponse -> DisableGatewayResponse -> Bool

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

type Rep DisableGatewayResponse

Defined in Amazonka.StorageGateway.DisableGateway

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

newDisableGatewayResponse

Arguments

:: Int

$sel:httpStatus:DisableGatewayResponse'

-> DisableGatewayResponse

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

DisableGateway, disableGatewayResponse_gatewayARN - The unique Amazon Resource Name (ARN) of the disabled gateway.

$sel:httpStatus:DisableGatewayResponse', disableGatewayResponse_httpStatus - The response's http status code.

Response Lenses

disableGatewayResponse_gatewayARN :: Lens' DisableGatewayResponse (Maybe Text)

The unique Amazon Resource Name (ARN) of the disabled gateway.

disableGatewayResponse_httpStatus :: Lens' DisableGatewayResponse Int

The response's http status code.