Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DetachVolume

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an Amazon Web Services Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.

Synopsis

data DetachVolume = DetachVolume' {
- device :: Maybe Text
- dryRun :: Maybe Bool
- force :: Maybe Bool
- instanceId :: Maybe Text
- volumeId :: Text
}
newDetachVolume :: Text -> DetachVolume
detachVolume_device :: Lens' DetachVolume (Maybe Text)
detachVolume_dryRun :: Lens' DetachVolume (Maybe Bool)
detachVolume_force :: Lens' DetachVolume (Maybe Bool)
detachVolume_instanceId :: Lens' DetachVolume (Maybe Text)
detachVolume_volumeId :: Lens' DetachVolume Text
data VolumeAttachment = VolumeAttachment' {
- attachTime :: Maybe ISO8601
- deleteOnTermination :: Maybe Bool
- device :: Maybe Text
- instanceId :: Maybe Text
- state :: Maybe VolumeAttachmentState
- volumeId :: Maybe Text
}
newVolumeAttachment :: VolumeAttachment
volumeAttachment_attachTime :: Lens' VolumeAttachment (Maybe UTCTime)
volumeAttachment_deleteOnTermination :: Lens' VolumeAttachment (Maybe Bool)
volumeAttachment_device :: Lens' VolumeAttachment (Maybe Text)
volumeAttachment_instanceId :: Lens' VolumeAttachment (Maybe Text)
volumeAttachment_state :: Lens' VolumeAttachment (Maybe VolumeAttachmentState)
volumeAttachment_volumeId :: Lens' VolumeAttachment (Maybe Text)

Creating a Request

data DetachVolume Source #

See: newDetachVolume smart constructor.

Constructors

DetachVolume'

Fields

device :: Maybe Text
The device name.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
force :: Maybe Bool
Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
instanceId :: Maybe Text
The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
volumeId :: Text
The ID of the volume.

Instances

Instances details

ToHeaders DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods toHeaders :: DetachVolume -> [Header] #
ToPath DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods toPath :: DetachVolume -> ByteString #
ToQuery DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods toQuery :: DetachVolume -> QueryString #
AWSRequest DetachVolume Source #
Instance details Defined in Amazonka.EC2.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 Source #
Instance details Defined in Amazonka.EC2.DetachVolume Associated Types type Rep DetachVolume :: Type -> Type # Methods from :: DetachVolume -> Rep DetachVolume x # to :: Rep DetachVolume x -> DetachVolume #
Read DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods readsPrec :: Int -> ReadS DetachVolume # readList :: ReadS [DetachVolume] # readPrec :: ReadPrec DetachVolume # readListPrec :: ReadPrec [DetachVolume] #
Show DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods showsPrec :: Int -> DetachVolume -> ShowS # show :: DetachVolume -> String # showList :: [DetachVolume] -> ShowS #
NFData DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods rnf :: DetachVolume -> () #
Eq DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods (==) :: DetachVolume -> DetachVolume -> Bool # (/=) :: DetachVolume -> DetachVolume -> Bool #
Hashable DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume Methods hashWithSalt :: Int -> DetachVolume -> Int # hash :: DetachVolume -> Int #
type AWSResponse DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume type AWSResponse DetachVolume = VolumeAttachment
type Rep DetachVolume Source #
Instance details Defined in Amazonka.EC2.DetachVolume type Rep DetachVolume = D1 ('MetaData "DetachVolume" "Amazonka.EC2.DetachVolume" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DetachVolume'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDetachVolume Source #

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:

DetachVolume, detachVolume_device - The device name.

$sel:dryRun:DetachVolume', detachVolume_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:force:DetachVolume', detachVolume_force - Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

DetachVolume, detachVolume_instanceId - The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

DetachVolume, detachVolume_volumeId - The ID of the volume.

Request Lenses

detachVolume_device :: Lens' DetachVolume (Maybe Text) Source #

The device name.

detachVolume_dryRun :: Lens' DetachVolume (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

detachVolume_force :: Lens' DetachVolume (Maybe Bool) Source #

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

detachVolume_instanceId :: Lens' DetachVolume (Maybe Text) Source #

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

detachVolume_volumeId :: Lens' DetachVolume Text Source #

The ID of the volume.

Destructuring the Response

data VolumeAttachment Source #

Describes volume attachment details.

See: newVolumeAttachment smart constructor.

Constructors

VolumeAttachment'
Fields attachTime :: Maybe ISO8601 The time stamp when the attachment initiated. deleteOnTermination :: Maybe Bool Indicates whether the EBS volume is deleted on instance termination. device :: Maybe Text The device name. instanceId :: Maybe Text The ID of the instance. state :: Maybe VolumeAttachmentState The attachment state of the volume. volumeId :: Maybe Text The ID of the volume.

Instances

Instances details

FromXML VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods parseXML :: [Node] -> Either String VolumeAttachment #
Generic VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Associated Types type Rep VolumeAttachment :: Type -> Type # Methods from :: VolumeAttachment -> Rep VolumeAttachment x # to :: Rep VolumeAttachment x -> VolumeAttachment #
Read VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods readsPrec :: Int -> ReadS VolumeAttachment # readList :: ReadS [VolumeAttachment] # readPrec :: ReadPrec VolumeAttachment # readListPrec :: ReadPrec [VolumeAttachment] #
Show VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods showsPrec :: Int -> VolumeAttachment -> ShowS # show :: VolumeAttachment -> String # showList :: [VolumeAttachment] -> ShowS #
NFData VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods rnf :: VolumeAttachment -> () #
Eq VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods (==) :: VolumeAttachment -> VolumeAttachment -> Bool # (/=) :: VolumeAttachment -> VolumeAttachment -> Bool #
Hashable VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment Methods hashWithSalt :: Int -> VolumeAttachment -> Int # hash :: VolumeAttachment -> Int #
type Rep VolumeAttachment Source #
Instance details Defined in Amazonka.EC2.Types.VolumeAttachment type Rep VolumeAttachment = D1 ('MetaData "VolumeAttachment" "Amazonka.EC2.Types.VolumeAttachment" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "VolumeAttachment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attachTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "deleteOnTermination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "device") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeAttachmentState)) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newVolumeAttachment :: VolumeAttachment Source #

Create a value of VolumeAttachment 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:attachTime:VolumeAttachment', volumeAttachment_attachTime - The time stamp when the attachment initiated.

$sel:deleteOnTermination:VolumeAttachment', volumeAttachment_deleteOnTermination - Indicates whether the EBS volume is deleted on instance termination.

$sel:device:VolumeAttachment', volumeAttachment_device - The device name.

$sel:instanceId:VolumeAttachment', volumeAttachment_instanceId - The ID of the instance.

$sel:state:VolumeAttachment', volumeAttachment_state - The attachment state of the volume.

$sel:volumeId:VolumeAttachment', volumeAttachment_volumeId - The ID of the volume.

Response Lenses

volumeAttachment_attachTime :: Lens' VolumeAttachment (Maybe UTCTime) Source #

The time stamp when the attachment initiated.

volumeAttachment_deleteOnTermination :: Lens' VolumeAttachment (Maybe Bool) Source #

Indicates whether the EBS volume is deleted on instance termination.

volumeAttachment_device :: Lens' VolumeAttachment (Maybe Text) Source #

The device name.

volumeAttachment_instanceId :: Lens' VolumeAttachment (Maybe Text) Source #

The ID of the instance.

volumeAttachment_state :: Lens' VolumeAttachment (Maybe VolumeAttachmentState) Source #

The attachment state of the volume.

volumeAttachment_volumeId :: Lens' VolumeAttachment (Maybe Text) Source #

The ID of the volume.