À utiliser DescribeDocument avec un AWS SDK ou CLI - AWS Systems Manager

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

À utiliser DescribeDocument avec un AWS SDK ou CLI

Les exemples de code suivants montrent comment utiliserDescribeDocument.

CLI
AWS CLI

Pour afficher les détails d'un document

L'describe-documentexemple suivant affiche les détails d'un document Systems Manager de votre AWS compte.

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

Sortie :

{
    "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": []
    }
}

Pour plus d'informations, consultez la section Création de documents Systems Manager dans le guide de l'utilisateur de AWS Systems Manager.

  • Pour API plus de détails, voir DescribeDocumentla section Référence des AWS CLI commandes.

PowerShell
Outils pour PowerShell

Exemple 1 : Cet exemple renvoie des informations relatives à un document.

Get-SSMDocumentDescription -Name "RunShellScript"

Sortie :

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

  • Pour API plus de détails, consultez la section DescribeDocumentRéférence des AWS Tools for PowerShell applets de commande.

Pour obtenir la liste complète des guides AWS SDK de développement et des exemples de code, consultezUtilisation de Systems Manager avec un AWS SDK. Cette rubrique inclut également des informations sur la mise en route et des détails sur SDK les versions précédentes.