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

Amazonka.SSM.DeleteInventory

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

data DeleteInventory Source #

See: newDeleteInventory smart constructor.

Constructors

DeleteInventory' 

Fields

  • clientToken :: Maybe Text

    User-provided idempotency token.

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

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

  • typeName :: Text

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

Instances

Instances details
Eq DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Read DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Show DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Generic DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Associated Types

type Rep DeleteInventory :: Type -> Type #

NFData DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Methods

rnf :: DeleteInventory -> () #

Hashable DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

ToJSON DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

AWSRequest DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Associated Types

type AWSResponse DeleteInventory #

ToHeaders DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

ToPath DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

ToQuery DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

type Rep DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

type Rep DeleteInventory = D1 ('MetaData "DeleteInventory" "Amazonka.SSM.DeleteInventory" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DeleteInventory'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "schemaDeleteOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InventorySchemaDeleteOption))) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteInventory Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

newDeleteInventory Source #

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.

Constructors

DeleteInventoryResponse' 

Fields

  • typeName :: Maybe Text

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

  • deletionSummary :: Maybe InventoryDeletionSummary

    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.

  • deletionId :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Read DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Show DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Generic DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Associated Types

type Rep DeleteInventoryResponse :: Type -> Type #

NFData DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

Methods

rnf :: DeleteInventoryResponse -> () #

type Rep DeleteInventoryResponse Source # 
Instance details

Defined in Amazonka.SSM.DeleteInventory

type Rep DeleteInventoryResponse = D1 ('MetaData "DeleteInventoryResponse" "Amazonka.SSM.DeleteInventory" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DeleteInventoryResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deletionSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InventoryDeletionSummary))) :*: (S1 ('MetaSel ('Just "deletionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.