

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

# Etapa 3: Registrar uma tarefa na janela de manutenção usando a AWS CLI
<a name="mw-cli-tutorial-tasks"></a>

Nesta etapa do tutorial, você registra uma tarefa do AWS Systems Manager Run Command que executa o `df` na instância do Amazon Elastic Compute Cloud (Amazon EC2) para Linux. Os resultados desse comando padrão do Linux mostram a quantidade de espaço livre e a quantidade usada no sistema de arquivos do disco de sua instância.

- ou -

Se você estiver direcionando uma instância do Amazon EC2 para Windows Server em vez de para Linux, substitua o **df** no comando a seguir por **ipconfig**. A saída desse comando lista detalhes sobre o endereço IP, a máscara de sub-rede e o gateway padrão para adaptadores na instância de destino.

Quando você estiver pronto para registrar outros tipos de tarefa ou usar mais opções do Run Command disponíveis no Systems Manager, consulte [Exemplos: Registrar tarefas em uma janela de manutenção](mw-cli-register-tasks-examples.md). Lá fornecemos mais informações sobre os quatro tipos de tarefa e algumas das suas opções mais importante, para ajudar você a se planejar para cenários reais mais abrangentes. 

**Como registrar uma tarefa em uma janela de manutenção**

1. Execute o seguinte comando na máquina local. Substitua cada *espaço reservado para recurso de exemplo* por suas próprias informações. A versão que será executada a partir de uma máquina Windows local inclui os caracteres de escape ("/") necessários para executar o comando em sua ferramenta de linha de comando.

------
#### [ Linux & macOS ]

   ```
   aws ssm register-task-with-maintenance-window \
       --window-id mw-0c50858d01EXAMPLE \
       --task-arn "AWS-RunShellScript" \
       --max-concurrency 1 --max-errors 1 \
       --priority 10 \
       --targets "Key=InstanceIds,Values=i-0471e04240EXAMPLE" \
       --task-type "RUN_COMMAND" \
       --task-invocation-parameters '{"RunCommand":{"Parameters":{"commands":["df"]}}}'
   ```

------
#### [ Windows ]

   ```
   aws ssm register-task-with-maintenance-window ^
       --window-id mw-0c50858d01EXAMPLE ^
       --task-arn "AWS-RunShellScript" ^
       --max-concurrency 1 --max-errors 1 ^
       --priority 10 ^
       --targets "Key=InstanceIds,Values=i-02573cafcfEXAMPLE" ^
       --task-type "RUN_COMMAND" ^
       --task-invocation-parameters={\"RunCommand\":{\"Parameters\":{\"commands\":[\"df\"]}}}
   ```

------

   O sistema retorna informações semelhantes às seguintes:

   ```
   {
       "WindowTaskId": "4f7ca192-7e9a-40fe-9192-5cb15EXAMPLE"
   }
   ```

1. Agora, execute o seguinte comando para visualizar detalhes sobre a tarefa de janela de manutenção criada: 

------
#### [ Linux & macOS ]

   ```
   aws ssm describe-maintenance-window-tasks \
       --window-id mw-0c50858d01EXAMPLE
   ```

------
#### [ Windows ]

   ```
   aws ssm describe-maintenance-window-tasks ^
       --window-id mw-0c50858d01EXAMPLE
   ```

------

1. O sistema retorna informações semelhantes às seguintes.

   ```
   {
       "Tasks": [
           {
               "WindowId": "mw-0c50858d01EXAMPLE",
               "WindowTaskId": "4f7ca192-7e9a-40fe-9192-5cb15EXAMPLE",
               "TaskArn": "AWS-RunShellScript",
               "Type": "RUN_COMMAND",
               "Targets": [
                   {
                       "Key": "InstanceIds",
                       "Values": [
                           "i-02573cafcfEXAMPLE"
                       ]
                   }
               ],
               "TaskParameters": {},
               "Priority": 10,
               "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",
               "MaxConcurrency": "1",
               "MaxErrors": "1"
           }
       ]
   }
   ```

1. Aguarde o runtime da tarefa, com base na programação especificada em [Etapa 1: Criar a janela de manutenção usando a AWS CLI](mw-cli-tutorial-create-mw.md). Por exemplo, se você tiver especificado **--schedule "rate(5 minutes)"**, aguarde cinco minutos. Depois, execute o seguinte comando para visualizar informações sobre todas as execuções que ocorreram para essa tarefa. 

------
#### [ Linux & macOS ]

   ```
   aws ssm describe-maintenance-window-executions \
       --window-id mw-0c50858d01EXAMPLE
   ```

------
#### [ Windows ]

   ```
   aws ssm describe-maintenance-window-executions ^
       --window-id mw-0c50858d01EXAMPLE
   ```

------

   O sistema retorna informações semelhantes às seguintes.

   ```
   {
       "WindowExecutions": [
           {
               "WindowId": "mw-0c50858d01EXAMPLE",
               "WindowExecutionId": "14bea65d-5ccc-462d-a2f3-e99c8EXAMPLE",
               "Status": "SUCCESS",
               "StartTime": 1557593493.096,
               "EndTime": 1557593498.611
           }
       ]
   }
   ```

**dica**  
Depois que a tarefa for executada com êxito, reduza a taxa de execução da janela de manutenção. Por exemplo, execute o comando a seguir para reduzir a frequência para uma vez por semana. Substitua *mw-0c50858d01EXAMPLE* pelas suas próprias informações.  

```
aws ssm update-maintenance-window \
    --window-id mw-0c50858d01EXAMPLE \
    --schedule "rate(7 days)"
```

```
aws ssm update-maintenance-window ^
    --window-id mw-0c50858d01EXAMPLE ^
    --schedule "rate(7 days)"
```
Para obter informações sobre como gerenciar programações da janela de manutenção, consulte [Referência: Expressões cron e rate para o Systems Manager](reference-cron-and-rate-expressions.md) e [Opções de programação da janela de manutenção e do período ativo](maintenance-windows-schedule-options.md).  
Para obter informações sobre como usar a AWS Command Line Interface (AWS CLI) para modificar uma janela de manutenção, consulte [Tutorial: Atualizar uma janela de manutenção usando a AWS CLI](maintenance-windows-cli-tutorials-update.md).

Para praticar a execução de comandos da AWS CLI a fim de visualizar mais detalhes sobre sua tarefa de janela de manutenção e suas execuções, continue em [Tutorial: Visualizar informações sobre tarefas e execuções de tarefas usando a AWS CLI](mw-cli-tutorial-task-info.md).

**Acesso à saída do comando do tutorial**  
Está além do escopo deste tutorial usar a AWS CLI para visualizar a *saída* do comando do Run Command associado às suas execuções da tarefa de janela de manutenção.

No entanto, esses dados podem ser visualizados usando a AWS CLI. (Você também pode visualizar a saída no console do Systems Manager ou em um arquivo de log armazenado em um bucket do Amazon Simple Storage Service (Amazon S3), caso tenha configurado a janela de manutenção para armazenar a saída do comando nele.) Observe que a saída do comando **df** em uma instância do EC2 para Linux é semelhante à seguinte:

```
Filesystem 1K-blocks Used Available Use% Mounted on

devtmpfs 485716 0 485716 0% /dev

tmpfs 503624 0 503624 0% /dev/shm

tmpfs 503624 328 503296 1% /run

tmpfs 503624 0 503624 0% /sys/fs/cgroup

/dev/xvda1 8376300 1464160 6912140 18% /
```

A saída do comando **ipconfig** em uma instância do EC2 para Windows Server é semelhante à seguinte:

```
Windows IP Configuration


Ethernet adapter Ethernet 2:

   Connection-specific DNS Suffix  . : example.com
   IPv4 Address. . . . . . . . . . . : 10.24.34.0/23
   Subnet Mask . . . . . . . . . . . : 255.255.255.255
   Default Gateway . . . . . . . . . : 0.0.0.0

Ethernet adapter Ethernet:

   Media State . . . . . . . . . . . : Media disconnected
   Connection-specific DNS Suffix  . : abc1.wa.example.net

Wireless LAN adapter Local Area Connection* 1:

   Media State . . . . . . . . . . . : Media disconnected
   Connection-specific DNS Suffix  . :

Wireless LAN adapter Wi-Fi:

   Connection-specific DNS Suffix  . :
   Link-local IPv6 Address . . . . . : fe80::100b:c234:66d6:d24f%4
   IPv4 Address. . . . . . . . . . . : 192.0.2.0
   Subnet Mask . . . . . . . . . . . : 255.255.255.0
   Default Gateway . . . . . . . . . : 192.0.2.0

Ethernet adapter Bluetooth Network Connection:

   Media State . . . . . . . . . . . : Media disconnected
   Connection-specific DNS Suffix  . :
```

# Exemplos: Registrar tarefas em uma janela de manutenção
<a name="mw-cli-register-tasks-examples"></a>

Você pode registrar uma tarefa no Run Command, uma ferramenta do AWS Systems Manager, com uma janela de manutenção usando o AWS Command Line Interface (AWS CLI), conforme demonstrado em [Registre tarefas com a janela de manutenção](mw-cli-tutorial-tasks.md). Você também pode registrar tarefas para fluxos de trabalho do Systems Manager Automation, funções do AWS Lambda, e tarefas do AWS Step Functions, conforme demonstrado abaixo, neste tópico.

**nota**  
Especifique um ou mais destinos para as tarefas da janela de manutenção do tipo Run Command. Dependendo da tarefa, os destinos serão opcionais para outros tipos de tarefas da janela de manutenção (Automation, AWS Lambda e AWS Step Functions). Para obter mais informações sobre como executar tarefas que não especificam destinos, consulte [Registrar tarefas da janela de manutenção sem destinos](maintenance-windows-targetless-tasks.md).

Neste tópico, fornecemos exemplos de como usar o comando AWS Command Line Interface (AWS CLI) da `register-task-with-maintenance-window` para registrar cada um dos quatro tipos de tarefa compatíveis em uma janela de manutenção. Os exemplos são apenas para demonstração, mas você pode modificá-los para criar comandos de registro de tarefa funcionais. 

**Uso da opção --cli-input-json**  
Para gerenciar melhor suas opções de tarefas, use a opção de comando `--cli-input-json`, com valores de opção referenciados em um arquivo JSON. 

Para usar o conteúdo do arquivo JSON de exemplo fornecido nos exemplos a seguir, faça o seguinte em sua máquina local:

1. Crie um arquivo com um nome, como `MyRunCommandTask.json`, `MyAutomationTask.json` ou outro nome de sua preferência.

1. Copie o conteúdo do nosso exemplo de JSON no arquivo.

1. Modifique o conteúdo do arquivo para o registro de sua tarefa e salve o arquivo.

1. No mesmo diretório em que armazenou o arquivo, execute o seguinte comando. Substitua o nome do arquivo por *MyFile.json*. 

------
#### [ Linux & macOS ]

   ```
   aws ssm register-task-with-maintenance-window \
       --cli-input-json file://MyFile.json
   ```

------
#### [ Windows ]

   ```
   aws ssm register-task-with-maintenance-window ^
       --cli-input-json file://MyFile.json
   ```

------

**Pseudoparâmetros em tarefas da janela de manutenção**  
Em alguns exemplos, usamos *pseudoparâmetros* como método para enviar informações de ID às tarefas. Por exemplo, `{{TARGET_ID}}` e `{{RESOURCE_ID}}` podem ser usados para passar os IDs dos recursos da AWS somente para tarefas do Automation, do Lambda e do Step Functions. Para obter mais informações sobre pseudoparâmetros em conteúdo `--task-invocation-parameters`, consulte [Usar pseudoparâmetros ao registrar tarefas da janela de manutenção](maintenance-window-tasks-pseudo-parameters.md). 

**Mais informações**  
+ [Opções de parâmetros para o comando register-task-with-maintenance-windows](mw-cli-task-options.md).
+ [https://docs.aws.amazon.com/cli/latest/reference/ssm/register-task-with-maintenance-window.html](https://docs.aws.amazon.com/cli/latest/reference/ssm/register-task-with-maintenance-window.html) na *AWS CLI Command Reference*
+ [https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTaskWithMaintenanceWindow.html) na *Referência de API do AWS Systems Manager*

## Exemplos de registro de tarefas
<a name="task-examples"></a>

As seções a seguir fornecem um exemplo de comando da AWS CLI para registrar um tipo de tarefa compatível e um exemplo de JSON que pode ser usado com a opção `--cli-input-json`.

### Registre uma tarefa Run Command do Systems Manager
<a name="register-tasks-tutorial-run-command"></a>

Os exemplos a seguir demonstram como registrar tarefas Run Command do Systems Manager em uma janela de manutenção usando a AWS CLI:

------
#### [ Linux & macOS ]

```
aws ssm register-task-with-maintenance-window \
    --window-id mw-0c50858d01EXAMPLE \
    --task-arn "AWS-RunShellScript" \
    --max-concurrency 1 --max-errors 1 --priority 10 \
    --targets "Key=InstanceIds,Values=i-02573cafcfEXAMPLE" \
    --task-type "RUN_COMMAND" \
    --task-invocation-parameters '{"RunCommand":{"Parameters":{"commands":["df"]}}}'
```

------
#### [ Windows ]

```
aws ssm register-task-with-maintenance-window ^
    --window-id mw-0c50858d01EXAMPLE ^
    --task-arn "AWS-RunShellScript" ^
    --max-concurrency 1 --max-errors 1 --priority 10 ^
    --targets "Key=InstanceIds,Values=i-02573cafcfEXAMPLE" ^
    --task-type "RUN_COMMAND" ^
    --task-invocation-parameters "{\"RunCommand\":{\"Parameters\":{\"commands\":[\"df\"]}}}"
```

------

**Conteúdo JSON para uso com a opção de arquivo `--cli-input-json`:**

```
{
    "TaskType": "RUN_COMMAND",
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Description": "My Run Command task to update SSM Agent on an instance",
    "MaxConcurrency": "1",
    "MaxErrors": "1",
    "Name": "My-Run-Command-Task",
    "Priority": 10,
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "AWS-UpdateSSMAgent",
    "TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "A TaskInvocationParameters test comment",
            "NotificationConfig": {
                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",
                "NotificationEvents": [
                    "All"
                ],
                "NotificationType": "Invocation"
            },
            "OutputS3BucketName": "amzn-s3-demo-bucket",
            "OutputS3KeyPrefix": "S3-PREFIX",
            "TimeoutSeconds": 3600
        }
    }
}
```

### Registre uma tarefa do Systems Manager Automation
<a name="register-tasks-tutorial-automation"></a>

Os exemplos a seguir demonstram como registrar tarefas do Systems Manager Automation em uma janela de manutenção usando a AWS CLI: 

**AWS CLI comando:**

------
#### [ Linux & macOS ]

```
aws ssm register-task-with-maintenance-window \
    --window-id "mw-0c50858d01EXAMPLE" \
    --task-arn "AWS-RestartEC2Instance" \
    --service-role-arn arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole \
    --task-type AUTOMATION \
    --task-invocation-parameters "Automation={DocumentVersion=5,Parameters={InstanceId='{{RESOURCE_ID}}'}}" \
    --priority 0 --name "My-Restart-EC2-Instances-Automation-Task" \
    --description "Automation task to restart EC2 instances"
```

------
#### [ Windows ]

```
aws ssm register-task-with-maintenance-window ^
    --window-id "mw-0c50858d01EXAMPLE" ^
    --task-arn "AWS-RestartEC2Instance" ^
    --service-role-arn arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole ^
    --task-type AUTOMATION ^
    --task-invocation-parameters "Automation={DocumentVersion=5,Parameters={InstanceId='{{TARGET_ID}}'}}" ^
    --priority 0 --name "My-Restart-EC2-Instances-Automation-Task" ^
    --description "Automation task to restart EC2 instances"
```

------

**Conteúdo JSON para uso com a opção de arquivo `--cli-input-json`:**

```
{
    "WindowId": "mw-0c50858d01EXAMPLE",
        "TaskArn": "AWS-PatchInstanceWithRollback",
    "TaskType": "AUTOMATION","TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "instanceId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }
}
```

### Registrar uma tarefa do AWS Lambda
<a name="register-tasks-tutorial-lambda"></a>

Os exemplos a seguir demonstram como registrar tarefas de função do Lambda em uma janela de manutenção usando a : AWS CLI. 

Para esses exemplos, o usuário que criou a função do Lambda a nomeou como `SSMrestart-my-instances` e criou dois parâmetros chamados `instanceId` e `targetType`.

**Importante**  
A política do Maintenance Windows para IAM requer a adição do prefixo `SSM` aos nomes das funções Lambda (ou alias) . Antes de prosseguir com o registro desse tipo de tarefa, atualize o nome no AWS Lambda para incluir `SSM`. Por exemplo, se o nome da função Lambda for `MyLambdaFunction`, altere-o para `SSMMyLambdaFunction`.

**AWS CLI comando:**

------
#### [ Linux & macOS ]

**Importante**  
Se você estiver usando a versão 2 do AWS CLI, inclua a opção `--cli-binary-format raw-in-base64-out` no comando a seguir se sua carga útil do Lambda não for codificada em base64. A opção `cli_binary_format` está disponível apenas na versão 2. Para obter informações sobre essa e outras configurações do arquivo AWS CLI `config`, consulte [Configurações de arquivo `config` compatíveis](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-settings) no *Manual do usuário do AWS Command Line Interface*.

```
aws ssm register-task-with-maintenance-window \
    --window-id "mw-0c50858d01EXAMPLE" \
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" \
    --priority 2 --max-concurrency 10 --max-errors 5 --name "My-Lambda-Example" \
    --description "A description for my LAMBDA example task" --task-type "LAMBDA" \
    --task-arn "arn:aws:lambda:region:123456789012:function:serverlessrepo-SSMrestart-my-instances-C4JF9EXAMPLE" \
    --task-invocation-parameters '{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier": "$LATEST"}}'
```

------
#### [ PowerShell ]

**Importante**  
Se você estiver usando a versão 2 do AWS CLI, inclua a opção `--cli-binary-format raw-in-base64-out` no comando a seguir se sua carga útil do Lambda não for codificada em base64. A opção `cli_binary_format` está disponível apenas na versão 2. Para obter informações sobre essa e outras configurações do arquivo AWS CLI `config`, consulte [Configurações de arquivo `config` compatíveis](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-settings) no *Manual do usuário do AWS Command Line Interface*.

```
aws ssm register-task-with-maintenance-window `
    --window-id "mw-0c50858d01EXAMPLE" `
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" `
    --priority 2 --max-concurrency 10 --max-errors 5 --name "My-Lambda-Example" `
    --description "A description for my LAMBDA example task" --task-type "LAMBDA" `
    --task-arn "arn:aws:lambda:region:123456789012:function:serverlessrepo-SSMrestart-my-instances-C4JF9EXAMPLE" `
    --task-invocation-parameters '{\"Lambda\":{\"Payload\":\"{\\\"InstanceId\\\":\\\"{{RESOURCE_ID}}\\\",\\\"targetType\\\":\\\"{{TARGET_TYPE}}\\\"}\",\"Qualifier\": \"$LATEST\"}}'
```

------

**Conteúdo JSON para uso com a opção de arquivo `--cli-input-json`:**

```
{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "SSM_RestartMyInstances",
    "TaskType": "LAMBDA",
    "MaxConcurrency": "10",
    "MaxErrors": "10",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"instanceId\": \"{{RESOURCE_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",
            "Qualifier": "$LATEST"
        }
    },
    "Name": "My-Lambda-Task",
    "Description": "A description for my LAMBDA task",
    "Priority": 5
}
```

### Registre uma tarefa do Step Functions
<a name="register-tasks-tutorial-step-functions"></a>

Os exemplos a seguir demonstram como registrar tarefas da máquina de estado do Step Functions em uma janela de manutenção usando a : AWS CLI.

**nota**  
As tarefas da janela de manutenção oferecem suporte somente aos fluxos de trabalho da máquina de estado Step Functions Standard. Elas não oferecem suporte a fluxos de trabalho de máquinas de estado Express. Para obter informações sobre os tipos de fluxo de trabalho da máquina de estado, consulte [Fluxos de trabalho Standard vs. Express](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-standard-vs-express.html) no *Guia do desenvolvedor do AWS Step Functions*.

Para esses exemplos, o usuário que criou a máquina de estado do Step Functions criou uma máquina de estado chamada `SSMMyStateMachine` com um parâmetro chamado `instanceId`.

**Importante**  
A política do AWS Identity and Access Management (IAM) para a Maintenance Windows requer o uso do prefixo Step Functions nos nomes das máquinas de estado do `SSM`. Antes de prosseguir com o registro desse tipo de tarefa, é necessário atualizar o nome no AWS Step Functions a fim de incluir `SSM`. Por exemplo, se o nome da máquina de estado for `MyStateMachine`, altere para `SSMMyStateMachine`.

**AWS CLI comando:**

------
#### [ Linux & macOS ]

```
aws ssm register-task-with-maintenance-window \
    --window-id "mw-0c50858d01EXAMPLE" \
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" \
    --task-arn arn:aws:states:region:123456789012:stateMachine:SSMMyStateMachine-MggiqEXAMPLE \
    --task-type STEP_FUNCTIONS \
    --task-invocation-parameters '{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}", "Name":"{{INVOCATION_ID}}"}}' \
    --priority 0 --max-concurrency 10 --max-errors 5 \
    --name "My-Step-Functions-Task" --description "A description for my Step Functions task"
```

------
#### [ PowerShell ]

```
aws ssm register-task-with-maintenance-window `
    --window-id "mw-0c50858d01EXAMPLE" `
    --targets "Key=WindowTargetIds,Values=e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE" `
    --task-arn arn:aws:states:region:123456789012:stateMachine:SSMMyStateMachine-MggiqEXAMPLE `
    --task-type STEP_FUNCTIONS `
    --task-invocation-parameters '{\"StepFunctions\":{\"Input\":\"{\\\"InstanceId\\\":\\\"{{RESOURCE_ID}}\\\"}\", \"Name\":\"{{INVOCATION_ID}}\"}}' `
    --priority 0 --max-concurrency 10 --max-errors 5 `
    --name "My-Step-Functions-Task" --description "A description for my Step Functions task"
```

------

**Conteúdo JSON para uso com a opção de arquivo `--cli-input-json`:**

```
{
    "WindowId": "mw-0c50858d01EXAMPLE",
    "Targets": [
        {
            "Key": "WindowTargetIds",
            "Values": [
                "e32eecb2-646c-4f4b-8ed1-205fbEXAMPLE"
            ]
        }
    ],
    "TaskArn": "SSM_MyStateMachine",
    "TaskType": "STEP_FUNCTIONS",
    "MaxConcurrency": "10",
    "MaxErrors": "10",
    "TaskInvocationParameters": {
        "StepFunctions": {
            "Input": "{ \"instanceId\": \"{{TARGET_ID}}\" }",
            "Name": "{{INVOCATION_ID}}"
        }
    },
    "Name": "My-Step-Functions-Task",
    "Description": "A description for my Step Functions task",
    "Priority": 5
}
```

# Opções de parâmetros para o comando register-task-with-maintenance-windows
<a name="mw-cli-task-options"></a>

O comando **register-task-with-maintenance-window** fornece várias opções para configurar uma tarefa de acordo com as suas necessidades. Algumas são necessárias, algumas são opcionais, outras se aplicam somente a um único tipo de tarefa de janela de manutenção.

Este tópico fornece informações sobre algumas dessas opções para ajudar você a trabalhar com exemplos nesta seção do tutorial. Para obter mais informações sobre as opções de comando, consulte **[https://docs.aws.amazon.com/cli/latest/reference/ssm/register-task-with-maintenance-window.html](https://docs.aws.amazon.com/cli/latest/reference/ssm/register-task-with-maintenance-window.html)** na *Referência de comandos do AWS CLI*.

**Opção de comando: `--task-arn`**  
A opção `--task-arn` é usada para especificar o recurso no qual a tarefa é executada. O valor especificado depende do tipo de tarefa que você estiver registrando, conforme descrito na tabela a seguir.


**Formatos de TaskArn para tarefas de janela de manutenção**  

| Tipo de tarefa de janela de manutenção | Valor de TaskArn | 
| --- | --- | 
|  **`RUN_COMMAND`** e ** `AUTOMATION`**  |  `TaskArn`O é o nome do documento SSM ou o Amazon Resource Name (ARN). Por exemplo:  `AWS-RunBatchShellScript`  - ou - `arn:aws:ssm:region:111122223333:document/My-Document`.  | 
|  **`LAMBDA`**  |  `TaskArn` é o nome ou o ARN da função. Por exemplo:  `SSMMy-Lambda-Function` - ou - `arn:aws:lambda:region:111122223333:function:SSMMyLambdaFunction`.  A política do Maintenance Windows para IAM requer a adição do prefixo `SSM` aos nomes das funções Lambda (ou alias) . Antes de prosseguir com o registro desse tipo de tarefa, atualize o nome no AWS Lambda para incluir `SSM`. Por exemplo, se o nome da função Lambda for `MyLambdaFunction`, altere-o para `SSMMyLambdaFunction`.   | 
|  **`STEP_FUNCTIONS`**  |  `TaskArn` é o ARN da máquina de estado. Por exemplo:  `arn:aws:states:us-east-2:111122223333:stateMachine:SSMMyStateMachine`.  A política do IAM para as janelas de manutenção requer o uso do prefixo Step Functions nos nomes das máquinas de estado com o `SSM`. Antes de registrar esse tipo de tarefa, é necessário atualizar o nome no AWS Step Functions a fim de incluir `SSM`. Por exemplo, se o nome da máquina de estado for `MyStateMachine`, altere para `SSMMyStateMachine`.   | 

**Opção de comando: `--service-role-arn`**  
A função a ser assumida pelo AWS Systems Manager ao executar a tarefa de janela de manutenção. 

Para obter mais informações, consulte . [Configurar o Maintenance Windows](setting-up-maintenance-windows.md)

**Opção de comando: `--task-invocation-parameters`**  
A opção `--task-invocation-parameters` é usada para especificar os parâmetros que são exclusivos para cada um dos quatro tipos de tarefa. Os parâmetros compatíveis com cada um dos quatro tipos de tarefa estão descritos na tabela a seguir.

**nota**  
Para obter informações sobre como usar pseudoparâmetros em conteúdo `--task-invocation-parameters`, como \$1\$1TARGET\$1ID\$1\$1, consulte [Usar pseudoparâmetros ao registrar tarefas da janela de manutenção](maintenance-window-tasks-pseudo-parameters.md). 

Opções de parâmetros de invocação de tarefas para tarefas de janela de manutenção


| Tipo de tarefa de janela de manutenção | Parâmetros disponíveis  | Exemplo | 
| --- | --- | --- | 
|  **`RUN_COMMAND`**  |  `Comment` `DocumentHash` `DocumentHashType` `NotificationConfig` `OutputS3BucketName` `OutPutS3KeyPrefix` `Parameters` `ServiceRoleArn` `TimeoutSeconds`  |  <pre>"TaskInvocationParameters": {<br />        "RunCommand": {<br />            "Comment": "My Run Command task comment",<br />            "DocumentHash": "6554ed3d--truncated--5EXAMPLE",<br />            "DocumentHashType": "Sha256",<br />            "NotificationConfig": {<br />                "NotificationArn": "arn:aws:sns:region:123456789012:my-sns-topic-name",<br />                "NotificationEvents": [<br />                    "FAILURE"<br />                ],<br />                "NotificationType": "Invocation"<br />            },<br />            "OutputS3BucketName": "amzn-s3-demo-bucket",<br />            "OutputS3KeyPrefix": "S3-PREFIX",<br />            "Parameters": {<br />                "commands": [<br />                    "Get-ChildItem$env: temp-Recurse|Remove-Item-Recurse-force"<br />                ]<br />            },<br />            "ServiceRoleArn": "arn:aws:iam::123456789012:role/MyMaintenanceWindowServiceRole",<br />            "TimeoutSeconds": 3600<br />        }<br />    }</pre>  | 
|  **`AUTOMATION`**  |  `DocumentVersion` `Parameters`  |  <pre>"TaskInvocationParameters": {<br />        "Automation": {<br />            "DocumentVersion": "3",<br />            "Parameters": {<br />                "instanceid": [<br />                    "{{TARGET_ID}}"<br />                ]<br />            }<br />        }<br />    }</pre>  | 
|  **`LAMBDA`**  |  `ClientContext` `Payload` `Qualifier`  |  <pre>"TaskInvocationParameters": {<br />        "Lambda": {<br />            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",<br />            "Payload": "{ \"targetId\": \"{{TARGET_ID}}\", \"targetType\": \"{{TARGET_TYPE}}\" }",<br />            "Qualifier": "$LATEST"<br />        }<br />    }</pre>  | 
|  **`STEP_FUNCTIONS`**  |  `Input` `Name`  |  <pre>"TaskInvocationParameters": {<br />        "StepFunctions": {<br />            "Input": "{ \"targetId\": \"{{TARGET_ID}}\" }",<br />            "Name": "{{INVOCATION_ID}}"<br />        }<br />    }</pre>  | 