Utilizar DescribeDocument
con una CLI
En los siguientes ejemplos de código, se muestra cómo utilizar DescribeDocument
.
- CLI
-
- AWS CLI
-
Visualización de los detalles de un documento
En el siguiente ejemplo de
describe-document
se muestran detalles sobre un documento de Systems Manager de su cuenta de AWS.aws ssm describe-document \ --name
"Example"
Salida:
{ "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": [] } }
Para obtener más información, consulte Crear contenido en el documento de SSM en la Guía del usuario de AWS Systems Manager.
-
Para obtener información sobre la API, consulte DescribeDocument
en la Referencia de comandos de la AWS CLI.
-
- PowerShell
-
- Herramientas para PowerShell
-
Ejemplo 1: en este ejemplo se devuelve información sobre un documento.
Get-SSMDocumentDescription -Name "RunShellScript"
Salida:
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
-
Para obtener información sobre la API, consulte DescribeDocument en la Referencia de Cmdlet de AWS Tools for PowerShell.
-
Para obtener una lista completa de las guías para desarrolladores del AWS SDK y ejemplos de código, consulte Uso de Systems Manager con un SDK de AWS. En este tema también se incluye información sobre cómo comenzar a utilizar el SDK y detalles sobre sus versiones anteriores.