• AWS Systems Manager CloudWatch ダッシュボードは、2026 年 4 月 30 日以降は利用できなくなります。お客様は、これまでと同様に Amazon CloudWatch コンソールを使用して、Amazon CloudWatch ダッシュボードの表示、作成、管理を継続できます。詳細については、「[Amazon CloudWatch ダッシュボードのドキュメント](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)」を参照してください。

# CLI で `RegisterTaskWithMaintenanceWindow` を使用する
<a name="example_ssm_RegisterTaskWithMaintenanceWindow_section"></a>

次のサンプルコードは、`RegisterTaskWithMaintenanceWindow` を使用する方法を説明しています。

------
#### [ CLI ]

**AWS CLI**  
**例 1: メンテナンスウィンドウにオートメーションタスクを登録するには**  
次の `register-task-with-maintenance-window` の例では、インスタンスをターゲットとするメンテナンスウィンドウにオートメーションタスクを登録します。  

```
aws ssm register-task-with-maintenance-window \
    --window-id {{"mw-082dcd7649EXAMPLE"}} \
    --targets {{Key=InstanceIds,Values=i-1234520122EXAMPLE}} \
    --task-arn {{AWS-RestartEC2Instance}} \
    --service-role-arn {{arn:aws:iam::111222333444:role/SSM}} --task-type {{AUTOMATION}} \
    --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{RESOURCE_ID}}\"]}}}" \
    --priority {{0}} \
    --max-concurrency {{1}} \
    --max-errors {{1}} \
    --name {{"AutomationExample"}} \
    --description {{"Restarting EC2 Instance for maintenance"}}
```
出力:  

```
{
    "WindowTaskId":"11144444-5555-6666-7777-88888888"
}
```
詳細については、「*AWS Systems Manager ユーザーガイド*」の「[メンテナンスウィンドウにタスクを登録する (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)」を参照してください。  
**例 2: メンテナンスウィンドウに Lambda タスクを登録するには**  
次の `register-task-with-maintenance-window` の例では、インスタンスをターゲットとするメンテナンスウィンドウに Lambda タスクを登録します。  

```
aws ssm register-task-with-maintenance-window \
    --window-id {{"mw-082dcd7649dee04e4"}} \
    --targets {{Key=InstanceIds,Values=i-12344d305eEXAMPLE}} \
    --task-arn {{arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA}} \
    --service-role-arn {{arn:aws:iam::111222333444:role/SSM}} \
    --task-type {{LAMBDA}} \
    --task-invocation-parameters '{{{"Lambda":{"Payload":"{\"InstanceId\":\"{{RESOURCE_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}}}' \
    --priority {{0}} \
    --max-concurrency {{10}} \
    --max-errors {{5}} \
    --name {{"Lambda_Example"}} \
    --description {{"My Lambda Example"}}
```
出力:  

```
{
    "WindowTaskId":"22244444-5555-6666-7777-88888888"
}
```
詳細については、「*AWS Systems Manager ユーザーガイド*」の「[メンテナンスウィンドウにタスクを登録する (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)」を参照してください。  
**例 3: メンテナンスウィンドウに Run Command タスクを登録するには**  
次の `register-task-with-maintenance-window` の例では、インスタンスをターゲットとするメンテナンスウィンドウに Run Command タスクを登録します。  

```
aws ssm register-task-with-maintenance-window \
    --window-id {{"mw-082dcd7649dee04e4"}} \
    --targets {{"Key=InstanceIds,Values=i-12344d305eEXAMPLE"}} \
    --service-role-arn {{"arn:aws:iam::111222333444:role/SSM"}} \
    --task-type {{"RUN_COMMAND"}} \
    --name {{"SSMInstallPowerShellModule"}} \
    --task-arn {{"AWS-InstallPowerShellModule"}} \
    --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/{{1}}{{1}}0351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" \
    --max-concurrency 1 \
    --max-errors 1 \
    --priority {{10}}
```
出力:  

```
{
    "WindowTaskId":"33344444-5555-6666-7777-88888888"
}
```
詳細については、「*AWS Systems Manager ユーザーガイド*」の「[メンテナンスウィンドウにタスクを登録する (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)」を参照してください。  
**例 4: Step Functions タスクをメンテナンスウィンドウに登録するには**  
次の `register-task-with-maintenance-window` の例では、インスタンスをターゲットとするメンテナンスウィンドウに Step Functions タスクを登録します。  

```
aws ssm register-task-with-maintenance-window \
    --window-id {{"mw-1234d787d6EXAMPLE"}} \
    --targets {{Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcEXAMPLE}} \
    --task-arn {{arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine}} \
    --service-role-arn {{arn:aws:iam::111222333444:role/MaintenanceWindows}} \
    --task-type {{STEP_FUNCTIONS}} \
    --task-invocation-parameters '{{{"StepFunctions":{"Input":"{\"InstanceId\":\"{{RESOURCE_ID}}\"}"}}}}' \
    --priority {{0}} \
    --max-concurrency {{10}} \
    --max-errors {{5}} \
    --name {{"Step_Functions_Example"}} \
    --description {{"My Step Functions Example"}}
```
出力:  

```
{
    "WindowTaskId":"44444444-5555-6666-7777-88888888"
}
```
詳細については、「*AWS Systems Manager ユーザーガイド*」の「[メンテナンスウィンドウにタスクを登録する (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)」を参照してください。  
**例 5: メンテナンスウィンドウのターゲット ID を使用してタスクを登録するには**  
次の `register-task-with-maintenance-window` の例では、メンテナンスウィンドウのターゲット ID を使用してタスクを登録します。メンテナンスウィンドウのターゲット ID は、`aws ssm register-target-with-maintenance-window` コマンドの出力に含まれていました。この情報は `aws ssm describe-maintenance-window-targets` コマンドの出力から取得することもできます。  

```
aws ssm register-task-with-maintenance-window \
    --targets {{"Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c9EXAMPLE"}} \
    --task-arn {{"AWS-RunShellScript"}} \
    --service-role-arn {{"arn:aws:iam::111222333444:role/MaintenanceWindowsRole"}} \
    --window-id {{"mw-ab12cd34eEXAMPLE"}} \
    --task-type {{"RUN_COMMAND"}} \
    --task-parameters  "{\"commands\":{\"Values\":[\"df\"]}}" \
    --max-concurrency {{1}} \
    --max-errors {{1}} \
    --priority {{10}}
```
出力:  

```
{
    "WindowTaskId":"33344444-5555-6666-7777-88888888"
}
```
詳細については、「*AWS Systems Manager ユーザーガイド*」の「[メンテナンスウィンドウにタスクを登録する (AWS CLI)](https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-tasks.html)」を参照してください。  
+  API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTaskWithMaintenanceWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm/register-task-with-maintenance-window.html)」を参照してください。

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

**Tools for PowerShell V4**  
**例 1: この例では、インスタンス ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**  

```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)

Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**  

```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 2: この例では、ターゲット ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**  

```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)

register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**  

```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 3: この例では、run コマンドドキュメント `AWS-RunPowerShellScript` のパラメータオブジェクトを作成し、ターゲット ID を使用して任意のメンテナンスウィンドウを持つタスクを作成します。返される出力はタスク ID です。**  

```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))

$props = @{
    WindowId = "mw-0123e4cce56ff78ae"
    ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
    MaxConcurrency = 1
    MaxError = 1
    TaskType = "RUN_COMMAND"
    TaskArn = "AWS-RunPowerShellScript"
    Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
    Priority = 1
    RunCommand_Parameter = $parameters
    Name = "set-via-cmdlet"
}

Register-SSMTaskWithMaintenanceWindow @props
```
**出力:**  

```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**例 4: この例では、`Create-Snapshots` という名前のドキュメントを使用して AWS Systems Manager Automation タスクを登録します。**  

```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
    -ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
    -MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
    -Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
    -TaskType "AUTOMATION"`
    -Priority 4`
    -Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+  API の詳細については、*AWS Tools for PowerShell コマンドレットリファレンス (V4)* の「[RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。

**Tools for PowerShell V5**  
**例 1: この例では、インスタンス ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**  

```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)

Register-SSMTaskWithMaintenanceWindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="InstanceIds";Values="i-0000293ffd8c57862" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**  

```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 2: この例では、ターゲット ID を使用して、タスクをメンテナンスウィンドウに登録します。出力はタスク ID です。**  

```
$parameters = @{}
$parameterValues = New-Object Amazon.SimpleSystemsManagement.Model.MaintenanceWindowTaskParameterValueExpression
$parameterValues.Values = @("Install")
$parameters.Add("Operation", $parameterValues)

register-ssmtaskwithmaintenancewindow -WindowId "mw-03a342e62c96d31b0" -ServiceRoleArn "arn:aws:iam::123456789012:role/MaintenanceWindowsRole" -MaxConcurrency 1 -MaxError 1 -TaskArn "AWS-RunShellScript" -Target @{ Key="WindowTargetIds";Values="350d44e6-28cc-44e2-951f-4b2c985838f6" } -TaskType "RUN_COMMAND" -Priority 10 -TaskParameter $parameters
```
**出力:**  

```
f34a2c47-ddfd-4c85-a88d-72366b69af1b
```
**例 3: この例では、run コマンドドキュメント `AWS-RunPowerShellScript` のパラメータオブジェクトを作成し、ターゲット ID を使用して任意のメンテナンスウィンドウを持つタスクを作成します。返される出力はタスク ID です。**  

```
$parameters = [Collections.Generic.Dictionary[String,Collections.Generic.List[String]]]::new()
$parameters.Add("commands",@("ipconfig","dir env:\computername"))
$parameters.Add("executionTimeout",@(3600))

$props = @{
    WindowId = "mw-0123e4cce56ff78ae"
    ServiceRoleArn = "arn:aws:iam::123456789012:role/MaintenanceWindowsRole"
    MaxConcurrency = 1
    MaxError = 1
    TaskType = "RUN_COMMAND"
    TaskArn = "AWS-RunPowerShellScript"
    Target = @{Key="WindowTargetIds";Values="fe1234ea-56d7-890b-12f3-456b789bee0f"}
    Priority = 1
    RunCommand_Parameter = $parameters
    Name = "set-via-cmdlet"
}

Register-SSMTaskWithMaintenanceWindow @props
```
**出力:**  

```
f1e2ef34-5678-12e3-456a-12334c5c6cbe
```
**例 4: この例では、`Create-Snapshots` という名前のドキュメントを使用して AWS Systems Manager Automation タスクを登録します。**  

```
$automationParameters = @{}
$automationParameters.Add( "instanceId", @("{{ TARGET_ID }}") )
$automationParameters.Add( "AutomationAssumeRole", @("{arn:aws:iam::111111111111:role/AutomationRole}") )
$automationParameters.Add( "SnapshotTimeout", @("PT20M") )
Register-SSMTaskWithMaintenanceWindow -WindowId mw-123EXAMPLE456`
    -ServiceRoleArn "arn:aws:iam::123456789012:role/MW-Role"`
    -MaxConcurrency 1 -MaxError 1 -TaskArn "CreateVolumeSnapshots"`
    -Target @{ Key="WindowTargetIds";Values="4b5acdf4-946c-4355-bd68-4329a43a5fd1" }`
    -TaskType "AUTOMATION"`
    -Priority 4`
    -Automation_DocumentVersion '$DEFAULT' -Automation_Parameter $automationParameters -Name "Create-Snapshots"
```
+  API の詳細については、AWS Tools for PowerShell Cmdlet リファレンス (V5) の「[RegisterTaskWithMaintenanceWindow](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。

------

AWS SDK デベロッパーガイドとコード例の詳細なリストについては、[このサービスを AWS SDK で使用する](sdk-general-information-section.md) を参照してください。このトピックには、使用開始方法に関する情報と、以前の SDK バージョンの詳細も含まれています。