| 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 |
Amazonka.SSM.DeleteDocument
Description
Deletes the Amazon Web Services Systems Manager document (SSM document) and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
Synopsis
- data DeleteDocument = DeleteDocument' {}
- newDeleteDocument :: Text -> DeleteDocument
- deleteDocument_versionName :: Lens' DeleteDocument (Maybe Text)
- deleteDocument_force :: Lens' DeleteDocument (Maybe Bool)
- deleteDocument_documentVersion :: Lens' DeleteDocument (Maybe Text)
- deleteDocument_name :: Lens' DeleteDocument Text
- data DeleteDocumentResponse = DeleteDocumentResponse' {
- httpStatus :: Int
- newDeleteDocumentResponse :: Int -> DeleteDocumentResponse
- deleteDocumentResponse_httpStatus :: Lens' DeleteDocumentResponse Int
Creating a Request
data DeleteDocument Source #
See: newDeleteDocument smart constructor.
Constructors
| DeleteDocument' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteDocument |
Create a value of DeleteDocument 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:versionName:DeleteDocument', deleteDocument_versionName - The version name of the document that you want to delete. If not
provided, all versions of the document are deleted.
$sel:force:DeleteDocument', deleteDocument_force - Some SSM document types require that you specify a Force flag before
you can delete the document. For example, you must specify a Force
flag to delete a document of type ApplicationConfigurationSchema. You
can restrict access to the Force flag in an Identity and Access
Management (IAM) policy.
$sel:documentVersion:DeleteDocument', deleteDocument_documentVersion - The version of the document that you want to delete. If not provided,
all versions of the document are deleted.
$sel:name:DeleteDocument', deleteDocument_name - The name of the document.
Request Lenses
deleteDocument_versionName :: Lens' DeleteDocument (Maybe Text) Source #
The version name of the document that you want to delete. If not provided, all versions of the document are deleted.
deleteDocument_force :: Lens' DeleteDocument (Maybe Bool) Source #
Some SSM document types require that you specify a Force flag before
you can delete the document. For example, you must specify a Force
flag to delete a document of type ApplicationConfigurationSchema. You
can restrict access to the Force flag in an Identity and Access
Management (IAM) policy.
deleteDocument_documentVersion :: Lens' DeleteDocument (Maybe Text) Source #
The version of the document that you want to delete. If not provided, all versions of the document are deleted.
deleteDocument_name :: Lens' DeleteDocument Text Source #
The name of the document.
Destructuring the Response
data DeleteDocumentResponse Source #
See: newDeleteDocumentResponse smart constructor.
Constructors
| DeleteDocumentResponse' | |
Fields
| |
Instances
newDeleteDocumentResponse Source #
Create a value of DeleteDocumentResponse 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:httpStatus:DeleteDocumentResponse', deleteDocumentResponse_httpStatus - The response's http status code.
Response Lenses
deleteDocumentResponse_httpStatus :: Lens' DeleteDocumentResponse Int Source #
The response's http status code.