Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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
- deleteInventory :: Text -> DeleteInventory
- data DeleteInventory
- diClientToken :: Lens' DeleteInventory (Maybe Text)
- diSchemaDeleteOption :: Lens' DeleteInventory (Maybe InventorySchemaDeleteOption)
- diDryRun :: Lens' DeleteInventory (Maybe Bool)
- diTypeName :: Lens' DeleteInventory Text
- deleteInventoryResponse :: Int -> DeleteInventoryResponse
- data DeleteInventoryResponse
- dirsTypeName :: Lens' DeleteInventoryResponse (Maybe Text)
- dirsDeletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary)
- dirsDeletionId :: Lens' DeleteInventoryResponse (Maybe Text)
- dirsResponseStatus :: Lens' DeleteInventoryResponse Int
Creating a Request
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 theSchemaDeleteOption
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 thePutInventory
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 theDryRun
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 Source #
See: deleteInventory
smart constructor.
Instances
Request Lenses
diClientToken :: Lens' DeleteInventory (Maybe Text) Source #
User-provided idempotency token.
diSchemaDeleteOption :: Lens' DeleteInventory (Maybe InventorySchemaDeleteOption) Source #
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) Source #
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 Source #
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 Source #
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
- EveryDeleteInventory
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 Source #
See: deleteInventoryResponse
smart constructor.
Instances
Response Lenses
dirsTypeName :: Lens' DeleteInventoryResponse (Maybe Text) Source #
The name of the inventory data type specified in the request.
dirsDeletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary) Source #
A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary .
dirsDeletionId :: Lens' DeleteInventoryResponse (Maybe Text) Source #
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 Source #
- - | The response status code.