Utilizzare DescribeDocument 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à.

Utilizzare DescribeDocument con un AWS SDK o CLI

I seguenti esempi di codice mostrano come utilizzareDescribeDocument.

CLI
AWS CLI

Per visualizzare i dettagli di un documento

L'describe-documentesempio seguente mostra i dettagli su un documento Systems Manager nel tuo AWS account.

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

Output:

{
    "Document": {
        "Hash": "fc2410281f40779e694a8b95975d0f9f316da8a153daa94e3d9921102EXAMPLE",
        "HashType": "Sha256",
        "Name": "Example",
        "Owner": "29884EXAMPLE",
        "CreatedDate": 1583257938.266,
        "Status": "Active",
        "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, vedere Creazione di documenti di Systems Manager nella Guida per l'utente di AWS Systems Manager.

PowerShell
Strumenti per PowerShell

Esempio 1: questo esempio restituisce informazioni su un documento.

Get-SSMDocumentDescription -Name "RunShellScript"

Output:

CreatedDate     : 2/24/2017 5:25:13 AM
DefaultVersion  : 1
Description     : Run an updated script
DocumentType    : Command
DocumentVersion : 1
Hash            : f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b
HashType        : Sha256
LatestVersion   : 1
Name            : RunShellScript
Owner           : 123456789012
Parameters      : {commands}
PlatformTypes   : {Linux}
SchemaVersion   : 2.0
Sha1            :
Status          : Active

  • Per API i dettagli, vedere DescribeDocumentin AWS Tools for PowerShell Cmdlet Reference.

Per un elenco completo di guide per AWS SDK sviluppatori ed esempi di codice, vedere. Utilizzo di Systems Manager con un AWS SDK Questo argomento include anche informazioni su come iniziare e dettagli sulle SDK versioni precedenti.