Amazonka.EC2.DeregisterImage

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon EC2 User Guide.

When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

Creating a Request

data DeregisterImage

Contains the parameters for DeregisterImage.

See: newDeregisterImage smart constructor.

Constructors

DeregisterImage'

Fields

• 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.

• imageId :: Text

  The ID of the AMI.

Instances

ToHeaders DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

toHeaders :: DeregisterImage -> [Header]

ToPath DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

toPath :: DeregisterImage -> ByteString

ToQuery DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

toQuery :: DeregisterImage -> QueryString

AWSRequest DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Associated Types

type AWSResponse DeregisterImage

Methods

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

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

Generic DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Associated Types

type Rep DeregisterImage :: Type -> Type

Methods

from :: DeregisterImage -> Rep DeregisterImage x

to :: Rep DeregisterImage x -> DeregisterImage

Read DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

readsPrec :: Int -> ReadS DeregisterImage

readList :: ReadS [DeregisterImage]

readPrec :: ReadPrec DeregisterImage

readListPrec :: ReadPrec [DeregisterImage]

Show DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

showsPrec :: Int -> DeregisterImage -> ShowS

show :: DeregisterImage -> String

showList :: [DeregisterImage] -> ShowS

NFData DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

rnf :: DeregisterImage -> ()

Eq DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

(==) :: DeregisterImage -> DeregisterImage -> Bool

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

Hashable DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

Methods

hashWithSalt :: Int -> DeregisterImage -> Int

hash :: DeregisterImage -> Int

type AWSResponse DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

type AWSResponse DeregisterImage = DeregisterImageResponse

type Rep DeregisterImage

Defined in Amazonka.EC2.DeregisterImage

type Rep DeregisterImage = D1 ('MetaData "DeregisterImage" "Amazonka.EC2.DeregisterImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeregisterImage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeregisterImage

Arguments

:: Text

DeregisterImage

-> DeregisterImage

Create a value of DeregisterImage 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:dryRun:DeregisterImage', deregisterImage_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.

DeregisterImage, deregisterImage_imageId - The ID of the AMI.

Request Lenses

deregisterImage_dryRun :: Lens' DeregisterImage (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.

deregisterImage_imageId :: Lens' DeregisterImage Text

The ID of the AMI.

Destructuring the Response

data DeregisterImageResponse

See: newDeregisterImageResponse smart constructor.

Constructors

DeregisterImageResponse'

Instances

Generic DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

Associated Types

type Rep DeregisterImageResponse :: Type -> Type

Methods

from :: DeregisterImageResponse -> Rep DeregisterImageResponse x

to :: Rep DeregisterImageResponse x -> DeregisterImageResponse

Read DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

Methods

readsPrec :: Int -> ReadS DeregisterImageResponse

readList :: ReadS [DeregisterImageResponse]

readPrec :: ReadPrec DeregisterImageResponse

readListPrec :: ReadPrec [DeregisterImageResponse]

Show DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

Methods

showsPrec :: Int -> DeregisterImageResponse -> ShowS

show :: DeregisterImageResponse -> String

showList :: [DeregisterImageResponse] -> ShowS

NFData DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

Methods

rnf :: DeregisterImageResponse -> ()

Eq DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

Methods

(==) :: DeregisterImageResponse -> DeregisterImageResponse -> Bool

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

type Rep DeregisterImageResponse

Defined in Amazonka.EC2.DeregisterImage

type Rep DeregisterImageResponse = D1 ('MetaData "DeregisterImageResponse" "Amazonka.EC2.DeregisterImage" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DeregisterImageResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeregisterImageResponse :: DeregisterImageResponse

Create a value of DeregisterImageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.