amazonka-ssm-1.6.0: Amazon Simple Systems Manager (SSM) SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SSM.DeleteInventory

Contents

Description

Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

Synopsis

Creating a Request

deleteInventory #

Creates a value of DeleteInventory with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • diClientToken - User-provided idempotency token.
  • diSchemaDeleteOption - Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disbled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
  • diDryRun - Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.
  • diTypeName - The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.

data DeleteInventory #

See: deleteInventory smart constructor.

Instances
Eq DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Data DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteInventory -> c DeleteInventory #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteInventory #

toConstr :: DeleteInventory -> Constr #

dataTypeOf :: DeleteInventory -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteInventory) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteInventory) #

gmapT :: (forall b. Data b => b -> b) -> DeleteInventory -> DeleteInventory #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteInventory -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteInventory -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteInventory -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteInventory -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteInventory -> m DeleteInventory #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteInventory -> m DeleteInventory #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteInventory -> m DeleteInventory #

Read DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Show DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Generic DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Associated Types

type Rep DeleteInventory :: * -> * #

Hashable DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

ToJSON DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

AWSRequest DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Associated Types

type Rs DeleteInventory :: * #

ToHeaders DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

ToPath DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

ToQuery DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

NFData DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Methods

rnf :: DeleteInventory -> () #

type Rep DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

type Rep DeleteInventory = D1 (MetaData "DeleteInventory" "Network.AWS.SSM.DeleteInventory" "amazonka-ssm-1.6.0-2O4V6sSpPonKM5mzsQDhXT" False) (C1 (MetaCons "DeleteInventory'" PrefixI True) ((S1 (MetaSel (Just "_diClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_diSchemaDeleteOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InventorySchemaDeleteOption))) :*: (S1 (MetaSel (Just "_diDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_diTypeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DeleteInventory # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Request Lenses

diClientToken :: Lens' DeleteInventory (Maybe Text) #

User-provided idempotency token.

diSchemaDeleteOption :: Lens' DeleteInventory (Maybe InventorySchemaDeleteOption) #

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options: DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disbled version. DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

diDryRun :: Lens' DeleteInventory (Maybe Bool) #

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

diTypeName :: Lens' DeleteInventory Text #

The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.

Destructuring the Response

deleteInventoryResponse #

Creates a value of DeleteInventoryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dirsTypeName - The name of the inventory data type specified in the request.
  • dirsDeletionSummary - A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary .
  • dirsDeletionId - Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.
  • dirsResponseStatus - -- | The response status code.

data DeleteInventoryResponse #

See: deleteInventoryResponse smart constructor.

Instances
Eq DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Data DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteInventoryResponse -> c DeleteInventoryResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteInventoryResponse #

toConstr :: DeleteInventoryResponse -> Constr #

dataTypeOf :: DeleteInventoryResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteInventoryResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteInventoryResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteInventoryResponse -> DeleteInventoryResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteInventoryResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteInventoryResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteInventoryResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteInventoryResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteInventoryResponse -> m DeleteInventoryResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteInventoryResponse -> m DeleteInventoryResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteInventoryResponse -> m DeleteInventoryResponse #

Read DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Show DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Generic DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Associated Types

type Rep DeleteInventoryResponse :: * -> * #

NFData DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

Methods

rnf :: DeleteInventoryResponse -> () #

type Rep DeleteInventoryResponse # 
Instance details

Defined in Network.AWS.SSM.DeleteInventory

type Rep DeleteInventoryResponse = D1 (MetaData "DeleteInventoryResponse" "Network.AWS.SSM.DeleteInventory" "amazonka-ssm-1.6.0-2O4V6sSpPonKM5mzsQDhXT" False) (C1 (MetaCons "DeleteInventoryResponse'" PrefixI True) ((S1 (MetaSel (Just "_dirsTypeName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dirsDeletionSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe InventoryDeletionSummary))) :*: (S1 (MetaSel (Just "_dirsDeletionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dirsTypeName :: Lens' DeleteInventoryResponse (Maybe Text) #

The name of the inventory data type specified in the request.

dirsDeletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary) #

A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary .

dirsDeletionId :: Lens' DeleteInventoryResponse (Maybe Text) #

Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.

dirsResponseStatus :: Lens' DeleteInventoryResponse Int #

  • - | The response status code.