• O AWS Systems Manager CloudWatch Dashboard não estará mais disponível a partir de 30 de abril de 2026. Os clientes podem continuar usando o console do Amazon CloudWatch para visualizar, criar e gerenciar os painéis do Amazon CloudWatch exatamente como fazem hoje. Para obter mais informações, consulte a [documentação do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html).
# Trabalhar com documentos
Esta seção contém informações sobre como usar e trabalhar com documentos do SSM.
**Topics**
+ [Comparar versões de documentos do SSM](comparing-versions.md)
+ [Criar um documento do SSM.](create-ssm-console.md)
+ [Excluir documentos do SSM personalizados](deleting-documents.md)
+ [Executar documentos do em locais remotos](documents-running-remote-github-s3.md)
+ [Compartilhar documentos do Systems Manager](documents-ssm-sharing.md)
+ [Pesquisando documentos do SSM](ssm-documents-searching.md)
# Comparar versões de documentos do SSM
Você pode comparar as diferenças de conteúdo entre versões doAWS Systems Manager(SSM) no console Documents do Systems Manager. Ao comparar versões de um documento SSM, as diferenças entre o conteúdo das versões são realçadas.
**Para comparar o conteúdo do documento SSM (console)**
1. Abra o console do AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Na lista de documentos, escolha o documento cujo conteúdo você deseja comparar.
1. No**Conteúdo**, selecione**Comparar versões**E escolha a versão do documento com a qual você deseja comparar o conteúdo.
# Criar um documento do SSM.
Depois que criar o conteúdo do documento SSM personalizado, conforme descrito em [Escrever conteúdo de documento do](documents-creating-content.md#writing-ssm-doc-content), você poderá usar o console do Systems Manager para criar um documento do SSM usando seu conteúdo.
**Para criar um documento do SSM**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Escolha **Create command or session (Criar comando ou sessão)**.
1. Insira um nome descritivo para o documento.
1. (Opcional) No **Tipo de destino**, especifique o tipo de recursos nos quais o documento pode ser executado.
1. Na lista **Document type (Tipo de documento)**, escolha o tipo de documento que você deseja criar.
1. Exclua os parênteses no campo **Content (Conteúdo)** e cole o conteúdo do documento que você criou anteriormente.
1. (Opcional) Na seção **Tags de documento**, aplique um ou mais pares de nome/valor de chave de tag ao documento.
Tags são metadados opcionais que você atribui a um recurso. As tags permitem categorizar um recurso de diferentes formas, como por finalidade, proprietário ou ambiente. Por exemplo, você pode querer marcar um documento para identificar o tipo de tarefas que ele executa, o tipo de sistemas operacionais que ele direciona e o ambiente em que ele é executado. Nesse caso, você pode especificar os seguintes pares de nome/valor:
+ `Key=TaskType,Value=MyConfigurationUpdate`
+ `Key=OS,Value=AMAZON_LINUX_2`
+ `Key=Environment,Value=Production`
1. Escolha **Create document (Criar documento)** para salvar o documento.
# Excluir documentos do SSM personalizados
Caso não deseje mais usar um documento do SSM personalizado, você poderá excluí-lo usando o console do AWS Systems Manager.
**Para excluir um documento do SSM**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Selecione a função que você deseja excluir.
1. Select**Excluir**. Quando solicitado a excluir o documento, selecione**Excluir**.
Para obter exemplos do uso de ferramentas de linha de comando ou SDKs para excluir documentos do SSM, consulte [Usar `DeleteDocument` com o AWS SDK ou a CLI](example_ssm_DeleteDocument_section.md).
# Executar documentos do em locais remotos
Você pode executar documentos do AWS Systems Manager (SSM) em locais remotos usando o documento SSM predefinido `AWS-RunDocument`. Este documento suporta a execução de documentos SSM armazenados nos seguintes locais:
+ Repositórios públicos e privados do GitHub (não há suporte ao GitHub Enterprise)
+ Buckets do Amazon S3
+ Systems Manager
Embora também seja possível executar documentos remotos usando o State Manager ou o Automation, ferramentas do AWS Systems Manager, o procedimento a seguir descreve apenas como executar documentos do SSM remotos usando o AWS Systems Manager Run Command no console do Systems Manager.
**nota**
`AWS-RunDocument`O pode ser usado para executar apenas documentos SSM do tipo de comando, não outros tipos, como runbooks de automação. O `AWS-RunDocument` usa o plugin `aws:downloadContent`. Para obter mais informações sobre o plugin `aws:downloadContent`, consulte [`aws:downloadContent`](documents-command-ssm-plugin-reference.md#aws-downloadContent).
**Atenção**
`AWS-RunDocument` pode executar o conteúdo do documento de várias origens (documentos do SSM, GitHub, S3, URLs). Ao executar documentos remotos, as permissões do IAM avaliadas são para `ssm:GetDocument` no documento remoto e `ssm:SendCommand` em `AWS-RunDocument`. Se você tiver políticas do IAM que negam acesso a documentos SSM específicos, os usuários com permissões `AWS-RunDocument` ainda poderão executar esses documentos negados passando o conteúdo do documento como parâmetros, que podem não estar sujeitos às mesmas restrições do IAM específicas do documento.
Para restringir adequadamente a execução de documentos, use uma destas abordagens:
**Origens aprovadas na lista de permissões**: se você precisar usar a execução de documentos aninhados, restrinja o acesso apenas a origens aprovadas usando controles apropriados para cada tipo de origem: políticas do IAM para controlar `ssm:GetDocument` origens de documentos do SSM, políticas do IAM e buckets do S3 para origens do Amazon S3 e configurações de rede (como endpoints de VPC ou grupos de segurança) para origens públicas da Internet.
**Restrinja o acesso a AWS-RunDocument**: negue `ssm:SendCommand` em `AWS-RunDocument` e qualquer outro documento que use o plug-in `aws:runDocument` em suas políticas do IAM para evitar a execução de documentos aninhados.
**Use limites de permissão**: implemente limites de permissão do IAM para definir o máximo de permissões para os usuários, impedindo que eles executem documentos não autorizados, independentemente do método de execução.
Para obter mais informações sobre as práticas recomendadas do IAM e os limites de permissão, consulte [Limites de permissão para entidades do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html), no *Guia do usuário do AWS Identity and Access Management*.
**Antes de começar**
Para executar um documento remoto, você deve primeiro concluir as tarefas a seguir.
+ Crie um documento do Comando SSM e salve-o em um local remoto. Para obter mais informações, consulte . [Criar conteúdo de documento do SSM](documents-creating-content.md)
+ Se você planeja executar um documento remoto armazenado em um repositório privado do GitHub, é necessário criar um parâmetro `SecureString` do Systems Manager para o token de acesso de segurança do GitHub. Não é possível acessar um documento remoto em um repositório privado do GitHub transmitindo manualmente o token via SSH. O token de acesso deve ser passado como um parâmetro `SecureString` do Systems Manager. Para obter mais informações sobre como criar um parâmetro `SecureString`, consulte [Criar parâmetros do Parameter Store no Systems Manager](sysman-paramstore-su-create.md).
## Executar um documento remoto (console)
**Para executar um documento remoto**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Run Command**.
1. Selecione **Run command**.
1. Na lista **Document** (Documento), escolha **`AWS-RunDocument`**.
1. Em **Command parameters (Parâmetros de comando)**, em **Source Type (Tipo de origem)**, escolha uma opção.
+ Se você escolher o **GitHub**, especifique as **Informações da origem** no seguinte formato:
```
{
"owner": "owner_name",
"repository": "repository_name",
"path": "path_to_document",
"getOptions":"branch:branch_name",
"tokenInfo": "{{ssm-secure:secure-string-token}}"
}
```
Por exemplo:
```
{
"owner":"TestUser",
"repository":"GitHubTestExamples",
"path":"scripts/python/test-script",
"getOptions":"branch:exampleBranch",
"tokenInfo":"{{ssm-secure:my-secure-string-token}}"
}
```
**nota**
`getOptions` são opções extras para recuperar conteúdo de uma ramificação diferente da principal ou de uma confirmação específica no repositório. O `getOptions` poderá ser omitido se você estiver usando a confirmação mais recente na ramificação principal. O parâmetro `branch` é necessário somente se o documento do SSM estiver armazenado em uma ramificação diferente de `master`.
Para usar a versão do documento do SSM em uma *confirmação* específica no repositório, use `commitID` com `getOptions` em vez de `branch`. Por exemplo:
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
+ Se escolher **S3**, especifique as informações em **Source Info** no formato a seguir:
```
{"path":"URL_to_document_in_S3"}
```
Por exemplo:
```
{"path":"https://s3.amazonaws.com/amzn-s3-demo-bucket/scripts/ruby/mySSMdoc.json"}
```
+ Se escolher **SSMDocument**, especifique as informações em **Source Info** no formato a seguir:
```
{"name": "document_name"}
```
Por exemplo:
```
{"name": "mySSMdoc"}
```
1. No campo **Document Parameters** (Parâmetros do documento), digite os parâmetros para o documento remoto do SSM. Por exemplo, se você executar o documento `AWS-RunPowerShell`, poderá especificar:
```
{"commands": ["date", "echo \"Hello World\""]}
```
Se você executar o documento `AWS-ConfigureAWSPack`, poderá especificar:
```
{
"action":"Install",
"name":"AWSPVDriver"
}
```
1. Na seção **Targets** (Destinos), escolha os nós gerenciados nos quais você quer executar essa operação, especificando as tags, selecionando as instâncias ou dispositivos de borda manualmente ou especificando um grupo de recursos.
**dica**
Se um nó gerenciado que você espera ver não estiver listado, consulte [Solução de problemas de disponibilidade do nó gerenciado](fleet-manager-troubleshooting-managed-nodes.md) para obter dicas de solução de problemas.
1. Para **Other parameters (Outros parâmetros)**:
+ Em **Comment** (Comentário), digite as informações sobre esse comando.
+ Em **Timeout (seconds) (Tempo limite [segundos])**, especifique o número de segundos para o sistema aguardar até a falha de execução do comando total.
1. Para **Rate control** (Controle de taxa):
+ Em **Concurrency** (Concorrência), especifique um número ou uma porcentagem de nós gerenciados nos quais executar o comando ao mesmo tempo.
**nota**
Se você selecionou destinos especificando tags aplicadas a instâncias a nós gerenciados ou especificando grupos de recursos da AWS, e não tiver certeza de quantas instâncias são direcionadas, restrinja o número de instâncias que poderão executar o documento ao mesmo tempo, especificando uma porcentagem.
+ Em **Error threshold** (Limite de erro), especifique quando parar de executar o comando em outros nós depois de falhar em alguns ou em uma porcentagem de nós. Por exemplo, se você especificar três erros, o Systems Manager deixará de enviar o comando quando o 4° erro for recebido. Os nós gerenciados que continuam processando o comando também podem enviar erros.
1. (Opcional) Em **Output options (Opções de saída)**, para salvar a saída do comando em um arquivo, selecione a caixa **Write command output to an S3 bucket (Gravar saída do comando em um bucket do S3)**. Digite os nomes de bucket e prefixo (pastas) nas caixas de texto.
**nota**
As permissões do S3 que concedem a possibilidade de gravar os dados em um bucket do S3 são as do perfil de instância (para instâncias do EC2) ou perfil de serviço do IAM (máquinas ativadas para ambientes híbridos) atribuído à instância, e não as do usuário do IAM que realiza essa tarefa. Para obter mais informações, consulte [Configurar permissões de instância obrigatórias para o Systems Manager](setup-instance-permissions.md) ou [Criar um perfil de serviço do IAM para um ambiente híbrido](hybrid-multicloud-service-role.md). Além disso, se o bucket do S3 especificado estiver em uma conta da Conta da AWS diferente, verifique se o perfil da instância ou a função de serviço do IAM associado ao nó gerenciado tenha as permissões necessárias para gravar nesse bucket.
1. Na seção **SNS notifications** (Notificações do SNS), se quiser enviar notificações sobre o status da execução do comando, marque a caixa de seleção **Enable SNS notifications** (Habilitar notificações do SNS).
Para obter mais informações sobre a configuração de notificações do Amazon SNS para o Run Command, consulte [Monitorar alterações de status do Systems Manager usando as notificações do Amazon SNS](monitoring-sns-notifications.md).
1. Escolha **Executar**.
**nota**
Para obter mais informações sobre reinicialização dos servidores e instâncias ao usar Run Command para chamar scripts, consulte [Tratamento de reinicializações ao executar comandos](send-commands-reboot.md).
# Compartilhar documentos do Systems Manager
É possível compartilhar documentos do AWS Systems Manager (SSM) de forma privada ou pública com contas na mesma região da Região da AWS. Para compartilhar um documento específico, modifique as permissões do documento e permita que pessoas específicas acessem o mesmo de acordo com o ID da Conta da AWS. Para compartilhar um documento SSM publicamente, modifique as permissões do documento e especifique `All`. Não é possível compartilhar os documentos de forma pública e privada simultaneamente.
**Atenção**
Use documentos SSM compartilhados apenas de fontes confiáveis. Ao usar qualquer documento compartilhado, revise cuidadosamente o conteúdo do documento antes de usá-lo para que você entenda como ele mudará a configuração da sua instância. Para obter mais informações sobre melhores práticas de documentos compartilhados, consulte [Práticas recomendadas para documentos compartilhados do SSM](#best-practices-shared).
**Limitações**
Ao começar a trabalhar com documentos do SSM, lembre-se das seguintes limitações.
+ Somente o proprietário pode compartilhar um documento.
+ É preciso interromper o compartilhamento de um documento antes de excluí-lo. Para obter mais informações, consulte [Modificar permissões para um documento compartilhado do](#modify-permissions-shared).
+ Você pode compartilhar um documento com um máximo de 1000 contas da . 1000 Contas da AWS. Você pode solicitar um aumento desse limite no [Suporte Center](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase). Em **Limit type** (Tipo de limite), escolha *EC2 Systems Manager* e descreva o motivo para a solicitação.
+ Você pode compartilhar publicamente um máximo de cinco documentos do . Você pode solicitar um aumento desse limite no [Suporte Center](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase). Em **Limit type** (Tipo de limite), escolha *EC2 Systems Manager* e descreva o motivo para a solicitação.
+ Os documentos podem ser compartilhados somente com outras contas na mesma Região da AWS. O compartilhamento entre regiões não é compatível.
**Importante**
No Systems Manager, um documento SSM *pertencente à Amazon* é um documento criado e gerenciado pela própria Amazon Web Services. Os documentos *pertencentes à Amazon* incluem um prefixo como `AWS-*` no nome do documento. O proprietário do documento é considerado a Amazon, e não uma conta de usuário específica em AWS. Esses documentos estão disponíveis publicamente para uso de todos.
Para obter mais informações sobre as cotas de serviço do Systems Manager, consulte [Service Quotas do AWS Systems Manager](https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm).
**Topics**
+ [Práticas recomendadas para documentos compartilhados do SSM](#best-practices-shared)
+ [Bloquear compartilhamento público para documentos do SSM](#block-public-access)
+ [Compartilhar um documento do](#ssm-how-to-share)
+ [Modificar permissões para um documento compartilhado do](#modify-permissions-shared)
+ [Usar documentos compartilhados do](#using-shared-documents)
## Práticas recomendadas para documentos compartilhados do SSM
Reveja as seguintes diretrizes antes de compartilhar ou usar um documento compartilhado.
**Remover informações confidenciais**
Reveja seu documento do AWS Systems Manager cuidadosamente e remova todas as informações confidenciais. Por exemplo, verifique se o documento não inclui suas credenciais da AWS. Se você compartilhar um documento com pessoas específicas, esses usuários poderão visualizar as informações no documento. Se você compartilhar um documento publicamente, qualquer pessoa poderá visualizar as informações no documento.
**Bloquear compartilhamento público de documentos**
Analise todos os documentos do SSM compartilhados publicamente em sua conta e confirme se você deseja continuar compartilhando-os. Para parar de compartilhar um documento com o público, é necessário modificar a configuração de permissões do documento, conforme descrito na seção [Modificar permissões para um documento compartilhado do](#modify-permissions-shared) deste tópico. Ativar a configuração de bloqueio de compartilhamento público não afeta nenhum documento que você esteja compartilhando atualmente com o público. A menos que seu caso de uso exija que você compartilhe documentos com o público, recomendamos ativar a configuração de bloqueio de compartilhamento público para seus documentos do SSM na seção **Preferências** do console de documentos do Systems Manager. Ativar essa configuração impede o acesso indesejado aos documentos do SSM. A configuração de compartilhamento público de bloco é uma configuração de nível de conta que pode diferir para cada Região da AWS.
**Restringir ações do Run Command usando uma política de confiança do IAM**
Crie uma política do AWS Identity and Access Management (IAM) restritiva para os usuários que terão acesso ao documento. A política do IAM do determina quais documento do SSM um usuário pode ver no console do Amazon Elastic Compute Cloud (Amazon EC2) ou ao chamar `ListDocuments` usando a AWS Command Line Interface (AWS CLI) ou o AWS Tools for Windows PowerShell. A política também restringe as ações que o usuário pode realizar com o documento do . Você pode criar uma política restritiva para que um usuário só possa usar documentos específicos. Para obter mais informações, consulte [Exemplos de política gerenciada pelo cliente](security_iam_id-based-policy-examples.md#customer-managed-policies).
**Ter cuidado ao usar documentos compartilhados do **
Revise o conteúdo de cada documento compartilhado com você, especialmente documentos públicos, para entender os comandos que serão executados em suas instâncias. Um documento pode ter intencionalmente ou involuntariamente repercussões negativas após sua execução. Se o documento fizer referência a uma rede externa, reveja a origem externa antes de usar o documento.
**Enviar comandos usando o hash do documento**
Quando você compartilha um documento, o sistema cria um hash Sha-256 e o atribui ao documento. O sistema também salva um snapshot do conteúdo do documento. Quando você envia um comando usando um documento compartilhado, pode especificar o hash no seu comando para garantir que as seguintes condições sejam verdadeiras:
+ Você está executando um comando no documento correto do Systems Manager
+ O conteúdo do documento não mudou desde que foi compartilhado com você.
Se o hash não corresponder ao documento especificado ou se o conteúdo do documento compartilhado tiver mudado, o comando retornará uma exceção `InvalidDocument`. Observação: o hash não pode verificar o conteúdo do documento de locais externos.
**Usar o parâmetro de interpolação para melhorar a segurança**
Para parâmetros de tipo `String` em seus documentos do SSM, use o parâmetro e o valor `interpolationType": "ENV_VAR` para melhorar a segurança contra ataques de injeção de comando, tratando as entradas de parâmetros como literais de string em vez de comandos potencialmente executáveis. Nesse caso, o agente cria uma variável de ambiente denominada `SSM_parameter-name` com o valor do parâmetro. Recomendamos atualizar todos os seus documentos existentes do SSM que incluam parâmetros de tipo `String` para incluir `"interpolationType": "ENV_VAR"`. Para obter mais informações, consulte [Escrever conteúdo de documento do](documents-creating-content.md#writing-ssm-doc-content).
## Bloquear compartilhamento público para documentos do SSM
Antes de começar, analise todos os documentos do SSM compartilhados publicamente na sua Conta da AWS e confirme se você deseja continuar compartilhando-os. Para parar de compartilhar um documento do SSM com o público, é necessário modificar a configuração de permissões do documento, conforme descrito na seção [Modificar permissões para um documento compartilhado do](#modify-permissions-shared) deste tópico. Ativar a configuração de bloqueio de compartilhamento público não afeta nenhum documento do SSM que você esteja compartilhando atualmente com o público. Com a configuração de bloqueio de compartilhamento público ativada, você não poderá compartilhar nenhum documento do SSM adicional com o público.
A menos que seu caso de uso exija que você compartilhe documentos com o público, recomendamos que ative a configuração de bloqueio de compartilhamento público para os seus documentos do SSM. Ativar essa configuração impede o acesso indesejado aos documentos do SSM. A configuração de compartilhamento público de bloco é uma configuração de nível de conta que pode diferir para cada Região da AWS. Conclua as tarefas a seguir para bloquear o compartilhamento público de quaisquer documentos do SSM que você esteja compartilhando no momento.
### Bloquear compartilhamento público (console)
**Para bloquear o compartilhamento público de seus documentos do SSM**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Selecione **Preferences** (Preferências) e, em seguida, escolha **Edit** (Editar) na seção **Block public sharing** (Bloquear compartilhamento público).
1. Selecione **Bloquear compartilhamento público** e, em seguida, selecione **Salvar**.
### Bloquear compartilhamento público (linha de comando)
Abrir o AWS Command Line Interface (AWS CLI) ou AWS Tools for Windows PowerShell no computador local e execute o comando a seguir para bloquear o compartilhamento público de documentos SSM.
------
#### [ Linux & macOS ]
```
aws ssm update-service-setting \
--setting-id /ssm/documents/console/public-sharing-permission \
--setting-value Disable \
--region 'The Região da AWS you want to block public sharing in'
```
------
#### [ Windows ]
```
aws ssm update-service-setting ^
--setting-id /ssm/documents/console/public-sharing-permission ^
--setting-value Disable ^
--region "The Região da AWS you want to block public sharing in"
```
------
#### [ PowerShell ]
```
Update-SSMServiceSetting `
-SettingId /ssm/documents/console/public-sharing-permission `
-SettingValue Disable `
–Region The Região da AWS you want to block public sharing in
```
------
Confirme se o valor da configuração foi atualizado usando o comando a seguir.
------
#### [ Linux & macOS ]
```
aws ssm get-service-setting \
--setting-id /ssm/documents/console/public-sharing-permission \
--region The Região da AWS you blocked public sharing in
```
------
#### [ Windows ]
```
aws ssm get-service-setting ^
--setting-id /ssm/documents/console/public-sharing-permission ^
--region "The Região da AWS you blocked public sharing in"
```
------
#### [ PowerShell ]
```
Get-SSMServiceSetting `
-SettingId /ssm/documents/console/public-sharing-permission `
-Region The Região da AWS you blocked public sharing in
```
------
### Restringir o acesso para bloquear o compartilhamento público com o IAM
Você pode criar políticas do AWS Identity and Access Management (IAM) que impedem os usuários de modificar a configuração de compartilhamento público de blocos. Isso impede que os usuários permitam acesso indesejado aos documentos do SSM.
Veja a seguir um exemplo de uma política do IAM que impede que os usuários atualizem a configuração de compartilhamento público de bloco. Para usar este exemplo, você deve substituir o exemplo de ID de conta da Amazon Web Services pelo seu próprio ID de conta.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Deny",
"Action": "ssm:UpdateServiceSetting",
"Resource": "arn:aws:ssm:*:444455556666:servicesetting/ssm/documents/console/public-sharing-permission"
}
]
}
```
------
## Compartilhar um documento do
Você pode compartilhar documentos do AWS Systems Manager (SSM) usando o console do Systems Manager. Ao compartilhar documentos do console, é possível compartilhar somente a versão padrão do documento. Também é possível compartilhar documentos SSM de forma programática chamando a operação da API `ModifyDocumentPermission` usando a AWS Command Line Interface (AWS CLI), o AWS Tools for Windows PowerShell ou o AWS SDK. Antes de compartilhar um documento, obtenha os IDs das Conta da AWS das pessoas com quem deseja compartilhar. Você especificará esses IDs de conta quando compartilhar o documento.
### Compartilhar um documento (console)
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Na lista de documentos, selecione o documento que você deseja compartilhar e escolha **View details (Visualizar detalhes)**. Na guia **Permissions**, verifique se você é o proprietário do documento. Somente o proprietário de um documento pode compartilhá-lo.
1. Escolha **Editar**.
1. Para compartilhar o comando publicamente, escolha **Public (Público)** e depois **Save (Salvar)**. Para compartilhar o comando de forma privada, escolha **Private** (Privado), insira o ID da Conta da AWS e escolha **Add permission** (Adicionar permissão) e **Save** (Salvar).
### Compartilhar um documento (linha de comando)
O procedimento a seguir requer que você especifique uma Região da AWS para sua sessão de linha de comando.
1. Abra a AWS CLI ou o AWS Tools for Windows PowerShell no computador local e execute o comando a seguir para especificar suas credenciais.
No comando a seguir, substitua *region* por suas próprias informações. Para ver uma lista dos valores de *região* com suporte, consulte a coluna **Region** em [Systems Manager service endpoints](https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) no *Referência geral da Amazon Web Services*.
------
#### [ Linux & macOS ]
```
aws config
AWS Access Key ID: [your key]
AWS Secret Access Key: [your key]
Default region name: region
Default output format [None]:
```
------
#### [ Windows ]
```
aws config
AWS Access Key ID: [your key]
AWS Secret Access Key: [your key]
Default region name: region
Default output format [None]:
```
------
#### [ PowerShell ]
```
Set-AWSCredentials –AccessKey your key –SecretKey your key
Set-DefaultAWSRegion -Region region
```
------
1. Use o seguinte comando para listar todos os documentos do disponíveis para você. A lista inclui os documentos que você criou e os documentos que foram compartilhados com você.
------
#### [ Linux & macOS ]
```
aws ssm list-documents
```
------
#### [ Windows ]
```
aws ssm list-documents
```
------
#### [ PowerShell ]
```
Get-SSMDocumentList
```
------
1. Use o seguinte comando para obter um documento específico.
------
#### [ Linux & macOS ]
```
aws ssm get-document \
--name document name
```
------
#### [ Windows ]
```
aws ssm get-document ^
--name document name
```
------
#### [ PowerShell ]
```
Get-SSMDocument `
–Name document name
```
------
1. Use o seguinte comando para obter uma descrição do documento.
------
#### [ Linux & macOS ]
```
aws ssm describe-document \
--name document name
```
------
#### [ Windows ]
```
aws ssm describe-document ^
--name document name
```
------
#### [ PowerShell ]
```
Get-SSMDocumentDescription `
–Name document name
```
------
1. Use o seguinte comando para visualizar as permissões do documento.
------
#### [ Linux & macOS ]
```
aws ssm describe-document-permission \
--name document name \
--permission-type Share
```
------
#### [ Windows ]
```
aws ssm describe-document-permission ^
--name document name ^
--permission-type Share
```
------
#### [ PowerShell ]
```
Get-SSMDocumentPermission `
–Name document name `
-PermissionType Share
```
------
1. Use o seguinte comando para modificar as permissões do documento e compartilhá-lo. Você deve ser o proprietário do documento para editar as permissões. Opcionalmente, para documentos compartilhados com IDs de Conta da AWS específicos, é possível especificar uma versão do documento que deseja compartilhar usando o parâmetro `--shared-document-version`. Se você não especificar a versão, o sistema compartilhará a versão `Default` do documento. Se você compartilhar um documento publicamente (com `all`), o comportamento padrão é compartilhar todas as versões do documento especificado. O exemplo de comando a seguir compartilha o documento de forma privada com uma pessoa específica com base no ID da Conta da AWS dessa pessoa.
------
#### [ Linux & macOS ]
```
aws ssm modify-document-permission \
--name document name \
--permission-type Share \
--account-ids-to-add Conta da AWS ID
```
------
#### [ Windows ]
```
aws ssm modify-document-permission ^
--name document name ^
--permission-type Share ^
--account-ids-to-add Conta da AWS ID
```
------
#### [ PowerShell ]
```
Edit-SSMDocumentPermission `
–Name document name `
-PermissionType Share `
-AccountIdsToAdd Conta da AWS ID
```
------
1. Use o seguinte comando para compartilhar um documento publicamente.
**nota**
Se você compartilhar um documento publicamente (com `all`), o comportamento padrão é compartilhar todas as versões do documento especificado.
------
#### [ Linux & macOS ]
```
aws ssm modify-document-permission \
--name document name \
--permission-type Share \
--account-ids-to-add 'all'
```
------
#### [ Windows ]
```
aws ssm modify-document-permission ^
--name document name ^
--permission-type Share ^
--account-ids-to-add "all"
```
------
#### [ PowerShell ]
```
Edit-SSMDocumentPermission `
-Name document name `
-PermissionType Share `
-AccountIdsToAdd ('all')
```
------
## Modificar permissões para um documento compartilhado do
Se você compartilhar um comando, os usuários poderão visualizar e usar esse comando até que você remova o acesso ao documento do AWS Systems Manager (SSM) ou exclua esse documento do SSM. No entanto, não é possível excluir um documento que esteja compartilhado. Você deve parar de compartilhá-lo primeiro e depois excluí-lo.
### Parar de compartilhar um documento (console)
**Parar de compartilhar um documento**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Na lista de documentos, selecione o documento que deseja parar de compartilhar e escolha **Detalhes**. Na guia **Permissões**, verifique se você é o proprietário do documento. Somente o proprietário de um documento pode parar de compartilhá-lo.
1. Escolha **Editar**.
1. Selecione **X** para excluir o ID da Conta da AWS que não deve mais ter acesso ao comando e escolha **Save** (Salvar).
### Parar de compartilhar um documento (linha de comando)
Abra a AWS CLI ou o AWS Tools for Windows PowerShell no computador local e execute o comando a seguir para parar o compartilhamento de um comando.
------
#### [ Linux & macOS ]
```
aws ssm modify-document-permission \
--name document name \
--permission-type Share \
--account-ids-to-remove 'Conta da AWS ID'
```
------
#### [ Windows ]
```
aws ssm modify-document-permission ^
--name document name ^
--permission-type Share ^
--account-ids-to-remove "Conta da AWS ID"
```
------
#### [ PowerShell ]
```
Edit-SSMDocumentPermission `
-Name document name `
-PermissionType Share `
–AccountIdsToRemove Conta da AWS ID
```
------
## Usar documentos compartilhados do
Quando você compartilha um documento do AWS Systems Manager, o sistema gera um nome do recurso da Amazon (ARN) e o atribui ao comando. Se você selecionar e executar um documento compartilhado do console do Systems Manager, não verá o ARN. Porém, para executar um documento SSM compartilhado usando um outro método, não o console do Systems Manager, você deve especificar o ARN completo do documento para o parâmetro de solicitação `DocumentName`. Você visualiza o ARN completo de um documento do SSM ao executar o comando para listar documentos.
**nota**
Não é necessário especificar ARNs para documentos públicos da AWS (documentos que começam com `AWS-*`) ou comandos de sua propriedade.
### Usar um documento compartilhado do (linha de comando)
**Para listar todos os documentos públicos do Systems Manager**
------
#### [ Linux & macOS ]
```
aws ssm list-documents \
--filters Key=Owner,Values=Public
```
------
#### [ Windows ]
```
aws ssm list-documents ^
--filters Key=Owner,Values=Public
```
------
#### [ PowerShell ]
```
$filter = New-Object Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter
$filter.Key = "Owner"
$filter.Values = "Public"
Get-SSMDocumentList `
-Filters @($filter)
```
------
**Para listar documentos SSM privados que foram compartilhados com você**
------
#### [ Linux & macOS ]
```
aws ssm list-documents \
--filters Key=Owner,Values=Private
```
------
#### [ Windows ]
```
aws ssm list-documents ^
--filters Key=Owner,Values=Private
```
------
#### [ PowerShell ]
```
$filter = New-Object Amazon.SimpleSystemsManagement.Model.DocumentKeyValuesFilter
$filter.Key = "Owner"
$filter.Values = "Private"
Get-SSMDocumentList `
-Filters @($filter)
```
------
**Para listar todos os documentos SSM disponíveis para você**
------
#### [ Linux & macOS ]
```
aws ssm list-documents
```
------
#### [ Windows ]
```
aws ssm list-documents
```
------
#### [ PowerShell ]
```
Get-SSMDocumentList
```
------
**Para obter informações sobre um documento SSM que foi compartilhado com você**
------
#### [ Linux & macOS ]
```
aws ssm describe-document \
--name arn:aws:ssm:us-east-2:12345678912:document/documentName
```
------
#### [ Windows ]
```
aws ssm describe-document ^
--name arn:aws:ssm:us-east-2:12345678912:document/documentName
```
------
#### [ PowerShell ]
```
Get-SSMDocumentDescription `
–Name arn:aws:ssm:us-east-2:12345678912:document/documentName
```
------
**Para executar um documento SSM compartilhado**
------
#### [ Linux & macOS ]
```
aws ssm send-command \
--document-name arn:aws:ssm:us-east-2:12345678912:document/documentName \
--instance-ids ID
```
------
#### [ Windows ]
```
aws ssm send-command ^
--document-name arn:aws:ssm:us-east-2:12345678912:document/documentName ^
--instance-ids ID
```
------
#### [ PowerShell ]
```
Send-SSMCommand `
–DocumentName arn:aws:ssm:us-east-2:12345678912:document/documentName `
–InstanceIds ID
```
------
# Pesquisando documentos do SSM
Você pode pesquisar aAWS Systems Manager(SSM) para documentos SSM usando pesquisa de texto livre ou uma pesquisa baseada em filtro. Também é possível marcar documentos como favoritos para ajudar você a encontrar documentos do SSM usados com frequência. As seções a seguir descrevem como usar esses recursos.
## Usando a pesquisa de texto livre
A caixa de pesquisa na página **Documents** (Documentos) do Systems Manager oferece suporte à pesquisa de texto livre. A pesquisa de texto livre compara o termo ou termos de pesquisa inseridos com o nome do documento em cada documento do SSM. Se você inserir um único termo de pesquisa, por exemplo**ansible**, o Systems Manager retorna todos os documentos SSM onde esse termo foi descoberto. Se você inserir vários termos de pesquisa, o Systems Manager pesquisará usando um`OR`instrução. Por exemplo, se você especificar **ansible** e **linux**, a pesquisa retornará todos os documentos com *qualquer uma das* palavras-chave em seu nome.
Se você inserir um termo de pesquisa de texto livre e escolher uma opção de pesquisa, como**Tipo de plataforma**, em seguida, a pesquisa usa um`AND`e retorna todos os documentos com a palavra-chave em seu nome e o tipo de plataforma especificado.
**nota**
Observe os seguintes detalhes sobre a pesquisa de texto livre.
A pesquisa de texto livre *não* diferencia maiúsculas de minúsculas.
Os termos de pesquisa exigem um mínimo de três caracteres e têm um máximo de 20 caracteres.
A pesquisa de texto livre aceita até cinco termos de pesquisa.
Se você inserir um espaço entre termos de pesquisa, o sistema incluirá o espaço durante a pesquisa.
Você pode combinar a pesquisa de texto livre com outras opções de pesquisa, como**Tipo de documento**ou**Tipo de plataforma**.
O**Prefixo do Nome do documento**O filtro e a pesquisa de texto livre não podem ser usados juntos. Eles são mutuamente exclusivos.
**Para pesquisar um documento do SSM**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Insira os termos da pesquisa na caixa de pesquisa e pressione Enter.
### Executando pesquisa de documentos de texto livre usando o comando AWS CLI
**Para executar uma pesquisa de documento de texto livre usando a CLI**
1. Instale e configure a AWS Command Line Interface (AWS CLI), caso ainda não o tenha feito.
Para obter informações, consulte [Instalar ou atualizar a versão mais recente da AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html).
1. Para executar a pesquisa de documento de texto livre com um único termo, execute o comando a seguir. Neste comando, substitua*search\$1term*com suas próprias informações.
```
aws ssm list-documents --filters Key="SearchKeyword",Values="search_term"
```
Aqui está um exemplo.
```
aws ssm list-documents --filters Key="SearchKeyword",Values="aws-asg" --region us-east-2
```
Para pesquisar usando vários termos que criam um`AND`, execute o seguinte comando. Neste comando, substitua*search\$1term\$11*e*search\$1term\$12*com suas próprias informações.
```
aws ssm list-documents --filters Key="SearchKeyword",Values="search_term_1","search_term_2","search_term_3" --region us-east-2
```
Aqui está um exemplo.
```
aws ssm list-documents --filters Key="SearchKeyword",Values="aws-asg","aws-ec2","restart" --region us-east-2
```
## Usar filtros
A página **Documents** (Documentos) do Systems Manager exibe automaticamente os filtros a seguir quando você escolhe a caixa de pesquisa.
+ Prefixo do nome do documento
+ Tipos de plataforma
+ Tipo de documento
+ Chave de tag
![\[Opções de filtro na página SSM Documents (Documentos do SSM).\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/ssm-documents-filters-1.png)
Você pode procurar documentos SSM usando um único filtro. Se você quiser retornar um conjunto mais específico de documentos SSM, você pode aplicar vários filtros. Veja a seguir um exemplo de pesquisa que usa os **Tipos de plataforma** e os filtros do **Prefixo do nome do documento**.
![\[Aplicar várias opções de filtro à página SSM Documents (Documentos do SSM).\]](http://docs.aws.amazon.com/pt_br/systems-manager/latest/userguide/images/ssm-documents-filters-2.png)
Se você aplicar vários filtros, o Systems Manager criará instruções de pesquisa diferentes com base nos filtros escolhidos:
+ Se você aplicar o*Igual*filtrar várias vezes, por exemplo**Prefixo do nome do documento**e, em seguida, o Systems Manager procura utilizando um`OR`instrução. Por exemplo, se você especificar um filtro **Document name prefix**=**AWS** e um segundo filtro **Document name prefix**=**Lambda**, a pesquisa retornará todos os documentos com o prefixo "`AWS`" e todos os documentos com o prefixo "`Lambda`".
+ Se você aplicar filtros *diferentes*, por exemplo **Prefixo do nome do documento** e **Tipos de plataforma**, o Systems Manager fará a busca utilizando uma instrução `AND`. Por exemplo, se você especificar um filtro **Prefixo do nome do documento**=**AWS** e um filtro **Tipo de plataforma**=**Linux**, a pesquisa retornará todos os documentos com o prefixo "`AWS`" que forem específicos da plataforma Linux.
**nota**
As pesquisas que usam filtros diferenciam maiúsculas de minúsculas
## Como adicionar documentos aos seus favoritos
Para ajudar você a encontrar documentos do SSM usados com frequência, adicione-os aos seus favoritos. É possível adicionar até 20 documentos como favoritos por tipo de documento, Conta da AWS e Região da AWS. Você pode escolher, modificar e visualizar seus favoritos nos documentos do Console de gerenciamento da AWS. Os procedimentos a seguir descrevem como escolher, modificar e visualizar seus favoritos.
**Como adicionar um documento do SSM aos favoritos**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Selecione o ícone de estrela ao lado do nome do documento que deseja adicionar como favorito.
**Como remover um documento do SSM dos seus favoritos**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Desmarque o ícone de estrela ao lado do nome do documento que deseja remover dos seus favoritos.
**Como visualizar seus favoritos nos documentos do Console de gerenciamento da AWS**
1. Abra o console AWS Systems Manager em [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/).
1. No painel de navegação, escolha **Documents**.
1. Selecione a guia **Favoritos**.