Copyright | (c) 2013-2021 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 |
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
- data DeleteInventory = DeleteInventory' {}
- newDeleteInventory :: Text -> DeleteInventory
- deleteInventory_clientToken :: Lens' DeleteInventory (Maybe Text)
- deleteInventory_schemaDeleteOption :: Lens' DeleteInventory (Maybe InventorySchemaDeleteOption)
- deleteInventory_dryRun :: Lens' DeleteInventory (Maybe Bool)
- deleteInventory_typeName :: Lens' DeleteInventory Text
- data DeleteInventoryResponse = DeleteInventoryResponse' {}
- newDeleteInventoryResponse :: Int -> DeleteInventoryResponse
- deleteInventoryResponse_typeName :: Lens' DeleteInventoryResponse (Maybe Text)
- deleteInventoryResponse_deletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary)
- deleteInventoryResponse_deletionId :: Lens' DeleteInventoryResponse (Maybe Text)
- deleteInventoryResponse_httpStatus :: Lens' DeleteInventoryResponse Int
Creating a Request
data DeleteInventory Source #
See: newDeleteInventory
smart constructor.
DeleteInventory' | |
|
Instances
Create a value of DeleteInventory
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:clientToken:DeleteInventory'
, deleteInventory_clientToken
- User-provided idempotency token.
$sel:schemaDeleteOption:DeleteInventory'
, deleteInventory_schemaDeleteOption
- 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
operation for
a version greater than the disabled version.
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
$sel:dryRun:DeleteInventory'
, deleteInventory_dryRun
- 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.
$sel:typeName:DeleteInventory'
, deleteInventory_typeName
- The name of the custom inventory type for which you want to delete
either all previously collected data or the inventory type itself.
Request Lenses
deleteInventory_clientToken :: Lens' DeleteInventory (Maybe Text) Source #
User-provided idempotency token.
deleteInventory_schemaDeleteOption :: 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
operation for
a version greater than the disabled version.
DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.
deleteInventory_dryRun :: 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.
deleteInventory_typeName :: 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
data DeleteInventoryResponse Source #
See: newDeleteInventoryResponse
smart constructor.
DeleteInventoryResponse' | |
|
Instances
newDeleteInventoryResponse Source #
Create a value of DeleteInventoryResponse
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:typeName:DeleteInventory'
, deleteInventoryResponse_typeName
- The name of the inventory data type specified in the request.
$sel:deletionSummary:DeleteInventoryResponse'
, deleteInventoryResponse_deletionSummary
- A summary of the delete operation. For more information about this
summary, see
Deleting custom inventory
in the Amazon Web Services Systems Manager User Guide.
$sel:deletionId:DeleteInventoryResponse'
, deleteInventoryResponse_deletionId
- Every DeleteInventory
operation 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 operations.
$sel:httpStatus:DeleteInventoryResponse'
, deleteInventoryResponse_httpStatus
- The response's http status code.
Response Lenses
deleteInventoryResponse_typeName :: Lens' DeleteInventoryResponse (Maybe Text) Source #
The name of the inventory data type specified in the request.
deleteInventoryResponse_deletionSummary :: Lens' DeleteInventoryResponse (Maybe InventoryDeletionSummary) Source #
A summary of the delete operation. For more information about this summary, see Deleting custom inventory in the Amazon Web Services Systems Manager User Guide.
deleteInventoryResponse_deletionId :: Lens' DeleteInventoryResponse (Maybe Text) Source #
Every DeleteInventory
operation 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 operations.
deleteInventoryResponse_httpStatus :: Lens' DeleteInventoryResponse Int Source #
The response's http status code.