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 `CreateDocument` con un AWS SDK o CLI
I seguenti esempi di codice mostrano come usare `CreateDocument`.
Gli esempi di operazioni sono estratti di codice da programmi più grandi e devono essere eseguiti nel contesto. È possibile visualizzare questa operazione nel contesto nel seguente esempio di codice:
+ [Informazioni di base](example_ssm_Scenario_section.md)
------
#### [ CLI ]
**AWS CLI**
**Come creare un documento**
L’esempio seguente `create-document` crea un documento di Systems Manager.
```
aws ssm create-document \
--content {{file://exampleDocument.yml}} \
--name {{"Example"}} \
--document-type {{"Automation"}} \
--document-format {{YAML}}
```
Contenuto di `exampleDocument.yml`:
```
description: Document Example
schemaVersion: '0.3'
assumeRole: '{{ AutomationAssumeRole }}'
parameters:
AutomationAssumeRole:
type: String
description: (Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.
default: ''
InstanceId:
type: String
description: (Required) The ID of the Amazon EC2 instance.
default: ''
mainSteps:
- name: rebootInstance
action: 'aws:executeAwsApi'
inputs:
Service: ec2
Api: RebootInstances
InstanceIds:
- '{{ InstanceId }}'
```
Output:
```
{
"DocumentDescription": {
"Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE",
"HashType": "Sha256",
"Name": "Example",
"Owner": "29884EXAMPLE",
"CreatedDate": 1583256349.452,
"Status": "Creating",
"DocumentVersion": "1",
"Description": "Document Example",
"Parameters": [
{
"Name": "AutomationAssumeRole",
"Type": "String",
"Description": "(Required) The ARN of the role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to execute this document.",
"DefaultValue": ""
},
{
"Name": "InstanceId",
"Type": "String",
"Description": "(Required) The ID of the Amazon EC2 instance.",
"DefaultValue": ""
}
],
"PlatformTypes": [
"Windows",
"Linux"
],
"DocumentType": "Automation",
"SchemaVersion": "0.3",
"LatestVersion": "1",
"DefaultVersion": "1",
"DocumentFormat": "YAML",
"Tags": []
}
}
```
Per ulteriori informazioni, consulta [Creazione di documenti di Systems Manager](https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html) nella *Guida per l’utente di AWS Systems Manager*.
+ Per i dettagli sull'API, consulta [CreateDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/create-document.html) nel *AWS CLI Riferimento al comando*.
------
#### [ Java ]
**SDK per Java 2.x**
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](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ssm#code-examples).
```
/**
* Creates an AWS SSM document asynchronously.
*
* @param docName The name of the document to create.
*
* This method initiates an asynchronous request to create an SSM document.
* If the request is successful, it prints the document status.
* If an exception occurs, it handles the error appropriately.
*/
public void createSSMDoc(String docName) throws SsmException {
String jsonData = """
{
"schemaVersion": "2.2",
"description": "Run a simple shell command",
"mainSteps": [
{
"action": "aws:runShellScript",
"name": "runEchoCommand",
"inputs": {
"runCommand": [
"echo 'Hello, world!'"
]
}
}
]
}
""";
CreateDocumentRequest request = CreateDocumentRequest.builder()
.content(jsonData)
.name(docName)
.documentType(DocumentType.COMMAND)
.build();
CompletableFuture future = getAsyncClient().createDocument(request);
future.thenAccept(response -> {
System.out.println("The status of the SSM document is " + response.documentDescription().status());
}).exceptionally(ex -> {
Throwable cause = (ex instanceof CompletionException) ? ex.getCause() : ex;
if (cause instanceof DocumentAlreadyExistsException) {
throw new CompletionException(cause);
} else if (cause instanceof SsmException) {
throw new CompletionException(cause);
} else {
throw new RuntimeException(cause);
}
}).join();
}
```
+ Per i dettagli sull'API, consulta [CreateDocument](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-2014-11-06/CreateDocument) nel *AWS SDK for Java 2.x Riferimento API*.
------
#### [ JavaScript ]
**SDK per JavaScript (v3)**
C'è dell'altro GitHub. Trova l’esempio completo e scopri di più sulla configurazione e l’esecuzione nel [repository di esempi di codice AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/ssm#code-examples).
```
import { CreateDocumentCommand, SSMClient } from "@aws-sdk/client-ssm";
import { parseArgs } from "node:util";
/**
* Create an SSM document.
* @param {{ content: string, name: string, documentType?: DocumentType }}
*/
export const main = async ({ content, name, documentType }) => {
const client = new SSMClient({});
try {
const { documentDescription } = await client.send(
new CreateDocumentCommand({
Content: content, // The content for the new SSM document. The content must not exceed 64KB.
Name: name,
DocumentType: documentType, // Document format type can be JSON, YAML, or TEXT. The default format is JSON.
}),
);
console.log("Document created successfully.");
return { DocumentDescription: documentDescription };
} catch (caught) {
if (caught instanceof Error && caught.name === "DocumentAlreadyExists") {
console.warn(`${caught.message}. Did you provide a new document name?`);
} else {
throw caught;
}
}
};
```
+ Per i dettagli sull'API, consulta [CreateDocument](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/CreateDocumentCommand) nel *AWS SDK per JavaScript Riferimento API*.
------
#### [ PowerShell ]
**Strumenti per PowerShell V4**
**Esempio 1: questo esempio crea un documento nell’account. Il documento deve essere in formato JSON. Per ulteriori informazioni sulla scrittura di un documento di configurazione, consulta il Documento di configurazione nella Documentazione di riferimento API SSM.**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**Output:**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ Per i dettagli sull'API, vedi [CreateDocument](https://docs.aws.amazon.com/powershell/v4/reference) nel *AWS Strumenti per PowerShell Riferimento al cmdlet (V4)*.
**Strumenti per PowerShell V5**
**Esempio 1: questo esempio crea un documento nell’account. Il documento deve essere in formato JSON. Per ulteriori informazioni sulla scrittura di un documento di configurazione, consulta il Documento di configurazione nella Documentazione di riferimento API SSM.**
```
New-SSMDocument -Content (Get-Content -Raw "c:\temp\RunShellScript.json") -Name "RunShellScript" -DocumentType "Command"
```
**Output:**
```
CreatedDate : 3/1/2017 1:21:33 AM
DefaultVersion : 1
Description : Run an updated script
DocumentType : Command
DocumentVersion : 1
Hash : 1d5ce820e999ff051eb4841ed887593daf77120fd76cae0d18a53cc42e4e22c1
HashType : Sha256
LatestVersion : 1
Name : RunShellScript
Owner : 809632081692
Parameters : {commands}
PlatformTypes : {Linux}
SchemaVersion : 2.0
Sha1 :
Status : Creating
```
+ Per i dettagli sull'API, vedi [CreateDocument](https://docs.aws.amazon.com/powershell/v5/reference) nel *AWS Strumenti per PowerShell Riferimento al cmdlet (V5)*.
------
#### [ Python ]
**SDK per Python (Boto3)**
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](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ssm#code-examples).
```
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 create(self, content, name):
"""
Creates a document.
:param content: The content of the document.
:param name: The name of the document.
"""
try:
self.ssm_client.create_document(
Name=name, Content=content, DocumentType="Command"
)
self.name = name
except self.ssm_client.exceptions.DocumentAlreadyExists:
print(f"Document {name} already exists.")
self.name = name
except ClientError as err:
logger.error(
"Couldn't create %s. Here's why: %s: %s",
name,
err.response["Error"]["Code"],
err.response["Error"]["Message"],
)
raise
```
+ Per i dettagli sull'API, consulta [CreateDocument](https://docs.aws.amazon.com/goto/boto3/ssm-2014-11-06/CreateDocument) nel *AWS Riferimento alle API SDK per Python (Boto3)*.
------
#### [ SAP ABAP ]
**SDK per SAP ABAP**
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](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ssm#code-examples).
```
TRY.
lo_ssm->createdocument(
iv_name = iv_name
iv_content = iv_content
iv_documenttype = 'Command' ).
MESSAGE 'Document created.' TYPE 'I'.
CATCH /aws1/cx_ssmdocalreadyexists.
MESSAGE 'Document already exists.' TYPE 'I'.
CATCH /aws1/cx_ssminvaliddoccontent.
MESSAGE 'Invalid document content.' TYPE 'I'.
ENDTRY.
```
+ Per i dettagli sull'API, consulta [CreateDocument](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) 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](sdk-general-information-section.md). Questo argomento include anche informazioni su come iniziare e dettagli sulle versioni precedenti dell’SDK.