Usar ListDocuments com uma CLI - AWS Systems Manager

Usar ListDocuments com uma CLI

Os exemplos de código a seguir mostram como usar o ListDocuments.

CLI
AWS CLI

Exemplo 1: listar documentos

O exemplo de list-documents a seguir lista documentos pertencentes à conta solicitante marcados com a tag personalizada.

aws ssm list-documents \ --filters Key=Owner,Values=Self Key=tag:DocUse,Values=Testing

Saída:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "29884EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Automation", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [ { "Key": "DocUse", "Value": "Testing" } ] } ] }

Para obter mais informações, consulte Documentos do AWS Systems Manager no Guia do usuário do AWS Systems Manager.

Exemplo 2: listar documentos compartilhados

O exemplo de list-documents a seguir lista documentos compartilhados, incluindo documentos compartilhados privados que não pertencem à AWS.

aws ssm list-documents \ --filters Key=Name,Values=sharedDocNamePrefix Key=Owner,Values=Private

Saída:

{ "DocumentIdentifiers": [ { "Name": "Example", "Owner": "12345EXAMPLE", "PlatformTypes": [ "Windows", "Linux" ], "DocumentVersion": "1", "DocumentType": "Command", "SchemaVersion": "0.3", "DocumentFormat": "YAML", "Tags": [] } ] }

Para obter mais informações, consulte Documentos do AWS Systems Manager no Guia do usuário do AWS Systems Manager.

  • Para obter detalhes da API, consulte ListDocuments na Referência de comandos da AWS CLI.

PowerShell
Ferramentas para PowerShell

Exemplo 1: lista todos os documentos de configuração em sua conta.

Get-SSMDocumentList

Saída:

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 ...

Exemplo 2: esse exemplo recupera todos os documentos de automação com o nome correspondente a "Plataform"

Get-SSMDocumentList -DocumentFilterList @{Key="DocumentType";Value="Automation"} | Where-Object Name -Match "Platform"

Saída:

DocumentFormat : JSON DocumentType : Automation DocumentVersion : 7 Name : KT-Get-Platform Owner : 987654123456 PlatformTypes : {Windows, Linux} SchemaVersion : 0.3 Tags : {} TargetType : VersionName :
  • Para obter detalhes da API, consulte ListDocuments na Referência de cmdlets do AWS Tools for PowerShell.

Para ver uma lista completa dos Guias do desenvolvedor de SDK da AWS e exemplos de código, consulte Usar o Systems Manager com um AWS SDK. Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.