Utilisation de DescribeDocument avec une CLI - Exemples de code de kit AWS SDK

D’autres exemples de kits AWS SDK sont disponibles dans le référentiel GitHub AWS Doc SDK Examples.

Utilisation de DescribeDocument avec une CLI

Les exemples de code suivants illustrent comment utiliser DescribeDocument.

CLI
AWS CLI

Pour afficher les détails d’un document

L’exemple de describe-document suivant affiche les détails d’un document Systems Manager dans votre compte AWS.

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 Création de documents Systems Manager dans le Guide de l’utilisateur AWS Systems Manager.

  • Pour plus d’informations sur l’API, consultez DescribeDocument dans la Référence des commandes AWS CLI.

PowerShell
Outils pour PowerShell V4

Exemple 1 : cet exemple renvoie des informations sur 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 plus d’informations sur l’API, consultez DescribeDocument dans la Référence des cmdlets Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : cet exemple renvoie des informations sur 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 plus d’informations sur l’API, consultez DescribeDocument dans la Référence des cmdlets Outils AWS pour PowerShell (V5).