Utilizar ListDocuments
con una CLI
En los siguientes ejemplos de código, se muestra cómo utilizar ListDocuments
.
- CLI
-
- AWS CLI
-
Ejemplo 1: enumeración de documentos
En el siguiente ejemplo de
list-documents
se enumeran los documentos propiedad de la cuenta solicitante etiquetados con la etiqueta personalizada.aws ssm list-documents \ --filters
Key=Owner,Values=Self
Key=tag:DocUse,Values=Testing
Salida:
{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }
Para obtener más información, consulte Documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.
Ejemplo 2: enumeración de los documentos compartidos
En el siguiente ejemplo de
list-documents
se enumeran los documentos compartidos, incluidos los documentos compartidos privados que no son propiedad de AWS.aws ssm list-documents \ --filters
Key=Name,Values=sharedDocNamePrefix
Key=Owner,Values=Private
Salida:
{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }
Para obtener más información, consulte Documentos de AWS Systems Manager en la Guía del usuario de AWS Systems Manager.
-
Para obtener información sobre la API, consulte ListDocuments
en la Referencia de comandos de la AWS CLI.
-
- PowerShell
-
- Herramientas para PowerShell
-
Ejemplo 1: en este ejemplo se muestran todos los documentos de configuración de su cuenta.
Get-SSMDocumentList
Salida:
DocumentType : Command DocumentVersion : 1 Name : AWS-ApplyPatchBaseline Owner : Amazon PlatformTypes : {Windows} SchemaVersion : 1.2 DocumentType : Command DocumentVersion : 1 Name : AWS-ConfigureAWSPackage Owner : Amazon PlatformTypes : {Windows, Linux} SchemaVersion : 2.0 DocumentType : Command DocumentVersion : 1 Name : AWS-ConfigureCloudWatch Owner : Amazon PlatformTypes : {Windows} SchemaVersion : 1.2 ...
Ejemplo 2: en este ejemplo se recuperan todos los documentos de automatización cuyo nombre coincida con “Platform”
Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"
Salida:
DocumentFormat : JSON DocumentType : Automation DocumentVersion : 7 Name : KT-Get-Platform Owner : 987654123456 PlatformTypes : {Windows, Linux} SchemaVersion : 0.3 Tags : {} TargetType : VersionName :
-
Para obtener información sobre la API, consulte ListDocuments 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.