Amazonka.StorageGateway.DetachVolume

Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance. This operation is only supported in the volume gateway type.

Creating a Request

data DetachVolume

AttachVolumeInput

See: newDetachVolume smart constructor.

Constructors

DetachVolume'

Fields

• forceDetach :: Maybe Bool

  Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

  Valid Values: true | false

• volumeARN :: Text

  The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Instances

ToJSON DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

toJSON :: DetachVolume -> Value

toEncoding :: DetachVolume -> Encoding

toJSONList :: [DetachVolume] -> Value

toEncodingList :: [DetachVolume] -> Encoding

ToHeaders DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

toHeaders :: DetachVolume -> [Header]

ToPath DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

toPath :: DetachVolume -> ByteString

ToQuery DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

toQuery :: DetachVolume -> QueryString

AWSRequest DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type AWSResponse DetachVolume

Methods

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

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

Generic DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type Rep DetachVolume :: Type -> Type

Methods

from :: DetachVolume -> Rep DetachVolume x

to :: Rep DetachVolume x -> DetachVolume

Read DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

readsPrec :: Int -> ReadS DetachVolume

readList :: ReadS [DetachVolume]

readPrec :: ReadPrec DetachVolume

readListPrec :: ReadPrec [DetachVolume]

Show DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

showsPrec :: Int -> DetachVolume -> ShowS

show :: DetachVolume -> String

showList :: [DetachVolume] -> ShowS

NFData DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

rnf :: DetachVolume -> ()

Eq DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

(==) :: DetachVolume -> DetachVolume -> Bool

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

Hashable DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

Methods

hashWithSalt :: Int -> DetachVolume -> Int

hash :: DetachVolume -> Int

type AWSResponse DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

type AWSResponse DetachVolume = DetachVolumeResponse

type Rep DetachVolume

Defined in Amazonka.StorageGateway.DetachVolume

type Rep DetachVolume = D1 ('MetaData "DetachVolume" "Amazonka.StorageGateway.DetachVolume" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "DetachVolume'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceDetach") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "volumeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDetachVolume

Arguments

:: Text

DetachVolume

-> DetachVolume

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

$sel:forceDetach:DetachVolume', detachVolume_forceDetach - Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

DetachVolume, detachVolume_volumeARN - The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Request Lenses

detachVolume_forceDetach :: Lens' DetachVolume (Maybe Bool)

Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

Valid Values: true | false

detachVolume_volumeARN :: Lens' DetachVolume Text

The Amazon Resource Name (ARN) of the volume to detach from the gateway.

Destructuring the Response

data DetachVolumeResponse

AttachVolumeOutput

See: newDetachVolumeResponse smart constructor.

Constructors

DetachVolumeResponse'

Fields

• volumeARN :: Maybe Text

  The Amazon Resource Name (ARN) of the volume that was detached.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

Associated Types

type Rep DetachVolumeResponse :: Type -> Type

Methods

from :: DetachVolumeResponse -> Rep DetachVolumeResponse x

to :: Rep DetachVolumeResponse x -> DetachVolumeResponse

Read DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

Methods

readsPrec :: Int -> ReadS DetachVolumeResponse

readList :: ReadS [DetachVolumeResponse]

readPrec :: ReadPrec DetachVolumeResponse

readListPrec :: ReadPrec [DetachVolumeResponse]

Show DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

Methods

showsPrec :: Int -> DetachVolumeResponse -> ShowS

show :: DetachVolumeResponse -> String

showList :: [DetachVolumeResponse] -> ShowS

NFData DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

Methods

rnf :: DetachVolumeResponse -> ()

Eq DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

Methods

(==) :: DetachVolumeResponse -> DetachVolumeResponse -> Bool

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

type Rep DetachVolumeResponse

Defined in Amazonka.StorageGateway.DetachVolume

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

newDetachVolumeResponse

Arguments

:: Int

$sel:httpStatus:DetachVolumeResponse'

-> DetachVolumeResponse

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

DetachVolume, detachVolumeResponse_volumeARN - The Amazon Resource Name (ARN) of the volume that was detached.

$sel:httpStatus:DetachVolumeResponse', detachVolumeResponse_httpStatus - The response's http status code.

Response Lenses

detachVolumeResponse_volumeARN :: Lens' DetachVolumeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the volume that was detached.

detachVolumeResponse_httpStatus :: Lens' DetachVolumeResponse Int

The response's http status code.