Skip to content

Update Maintenance Window Target

ssm_update_maintenance_window_target R Documentation

Modifies the target of an existing maintenance window

Description

Modifies the target of an existing maintenance window. You can change the following:

  • Name

  • Description

  • Owner

  • IDs for an ID target

  • Tags for a Tag target

  • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

If a parameter is null, then the corresponding field isn't modified.

Usage

ssm_update_maintenance_window_target(WindowId, WindowTargetId, Targets,
  OwnerInformation, Name, Description, Replace)

Arguments

WindowId

[required] The maintenance window ID with which to modify the target.

WindowTargetId

[required] The target ID to modify.

Targets

The targets to add or replace.

OwnerInformation

User-provided value that will be included in any Amazon CloudWatch Events events raised while running tasks for these targets in this maintenance window.

Name

A name for the update.

Description

An optional description for the update.

Replace

If True, then all fields that are required by the register_target_with_maintenance_window operation are also required for this API request. Optional fields that aren't specified are set to null.

Value

A list with the following syntax:

list(
  WindowId = "string",
  WindowTargetId = "string",
  Targets = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  OwnerInformation = "string",
  Name = "string",
  Description = "string"
)

Request syntax

svc$update_maintenance_window_target(
  WindowId = "string",
  WindowTargetId = "string",
  Targets = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  OwnerInformation = "string",
  Name = "string",
  Description = "string",
  Replace = TRUE|FALSE
)