View a markdown version of this page

Usare DeleteDocument con un AWS SDK o CLI - AWS Systems Manager

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Usare DeleteDocument con un AWS SDK o CLI

I seguenti esempi di codice mostrano come usare DeleteDocument.

CLI
AWS CLI

Per eliminare un documento

L’esempio seguente delete-document elimina un documento Systems Manager.

aws ssm delete-document \ --name "Example"

Questo comando non produce output.

Per ulteriori informazioni, consulta Creazione di documenti di Systems Manager nella Guida per l’utente di AWS Systems Manager.

  • Per i dettagli sull'API, consulta DeleteDocument nel AWS CLI Riferimento al comando.

Java
SDK per Java 2.x
Nota

C'è di più su GitHub. Trova l’esempio completo e scopri di più sulla configurazione e l’esecuzione nel repository di esempi di codice AWS.

/** * Deletes an AWS SSM document asynchronously. * * @param documentName The name of the document to delete. * <p> * This method initiates an asynchronous request to delete an SSM document. * If an exception occurs, it handles the error appropriately. */ public void deleteDoc(String documentName) { DeleteDocumentRequest documentRequest = DeleteDocumentRequest.builder() .name(documentName) .build(); CompletableFuture<Void> future = CompletableFuture.runAsync(() -> { getAsyncClient().deleteDocument(documentRequest) .thenAccept(response -> { System.out.println("The SSM document was successfully deleted."); }) .exceptionally(ex -> { throw new CompletionException(ex); }).join(); }).exceptionally(ex -> { Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex; if (cause instanceof SsmException) { throw new RuntimeException("SSM error: " + cause.getMessage(), cause); } else { throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause); } }); try { future.join(); } catch (CompletionException ex) { throw ex.getCause() instanceof RuntimeException ? (RuntimeException) ex.getCause() : ex; } }
  • Per i dettagli sull'API, consulta DeleteDocument nel AWS SDK for Java 2.x Riferimento API.

JavaScript
SDK per JavaScript (v3)
Nota

C'è dell'altro GitHub. Trova l’esempio completo e scopri di più sulla configurazione e l’esecuzione nel repository di esempi di codice AWS.

import { DeleteDocumentCommand, SSMClient } from "@aws-sdk/client-ssm"; import { parseArgs } from "node:util"; /** * Delete an SSM document. * @param {{ documentName: string }} */ export const main = async ({ documentName }) => { const client = new SSMClient({}); try { await client.send(new DeleteDocumentCommand({ Name: documentName })); console.log(`Document '${documentName}' deleted.`); return { Deleted: true }; } catch (caught) { if (caught instanceof Error && caught.name === "MissingParameter") { console.warn(`${caught.message}. Did you provide this value?`); } else { throw caught; } } };
  • Per i dettagli sull'API, consulta DeleteDocument nel AWS SDK per JavaScript Riferimento API.

PowerShell
Strumenti per PowerShell V4

Esempio 1: questo esempio elimina un documento. Se il comando va a buon fine, non viene generato output.

Remove-SSMDocument -Name "RunShellScript"
  • Per i dettagli sull'API, vedi DeleteDocument nel AWS Strumenti per PowerShell Riferimento al cmdlet (V4).

Strumenti per PowerShell V5

Esempio 1: questo esempio elimina un documento. Se il comando va a buon fine, non viene generato output.

Remove-SSMDocument -Name "RunShellScript"
  • Per i dettagli sull'API, vedi DeleteDocument nel AWS Strumenti per PowerShell Riferimento al cmdlet (V5).

Python
SDK per Python (Boto3)
Nota

C'è di più su GitHub. Trova l’esempio completo e scopri di più sulla configurazione e l’esecuzione nel repository di esempi di codice AWS.

class DocumentWrapper: """Encapsulates AWS Systems Manager Document actions.""" def __init__(self, ssm_client): """ :param ssm_client: A Boto3 Systems Manager client. """ self.ssm_client = ssm_client self.name = None @classmethod def from_client(cls): ssm_client = boto3.client("ssm") return cls(ssm_client) def delete(self): """ Deletes an AWS Systems Manager document. """ if self.name is None: return try: self.ssm_client.delete_document(Name=self.name) print(f"Deleted document {self.name}.") self.name = None except ClientError as err: logger.error( "Couldn't delete %s. Here's why: %s: %s", self.name, err.response["Error"]["Code"], err.response["Error"]["Message"], ) raise
  • Per i dettagli sull'API, consulta DeleteDocument nel AWS Riferimento alle API SDK per Python (Boto3).

SAP ABAP
SDK per SAP ABAP
Nota

C'è di più su GitHub. Trova l’esempio completo e scopri di più sulla configurazione e l’esecuzione nel repository di esempi di codice AWS.

TRY. lo_ssm->deletedocument( iv_name = iv_name ). MESSAGE 'Document deleted.' TYPE 'I'. CATCH /aws1/cx_ssminvaliddocument. MESSAGE 'Invalid document.' TYPE 'I'. CATCH /aws1/cx_ssmassocdinstances. MESSAGE 'Document has associated instances.' TYPE 'I'. ENDTRY.
  • Per i dettagli sull'API, consulta DeleteDocument nel AWS Riferimento all'API SDK per SAP ABAP.

Per un elenco completo di AWS Guide per sviluppatori SDK ed esempi di codice, consulta L'utilizzo di questo servizio con un AWS SDK. Questo argomento include anche informazioni su come iniziare e dettagli sulle versioni precedenti dell’SDK.