SSM / Client / register_target_with_maintenance_window



Registers a target with a maintenance window.

See also: AWS API Documentation

Request Syntax

response = client.register_target_with_maintenance_window(
            'Key': 'string',
            'Values': [
  • WindowId (string) –


    The ID of the maintenance window the target should be registered with.

  • ResourceType (string) –


    The type of target being registered with the maintenance window.

  • Targets (list) –


    The targets to register with the maintenance window. In other words, the managed nodes to run commands on when the maintenance window runs.


    If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.

    You can specify targets using managed node IDs, resource group names, or tags that have been applied to managed nodes.

    Example 1: Specify managed node IDs


    Example 2: Use tag key-pairs applied to managed nodes


    Example 3: Use tag-keys applied to managed nodes


    Example 4: Use resource group names


    Example 5: Use filters for resource group types



    For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format


    For more information about these examples formats, including the best use case for each one, see Examples: Register targets with a maintenance window in the Amazon Web Services Systems Manager User Guide.

    • (dict) –

      An array of search criteria that targets managed nodes using a key-value pair that you specify.


      One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

      Supported formats include the following.

      • Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3>

      • Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2>

      • Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2>

      • Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=<resource-group-name>

      • Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2>

      • Automation targets only: Key=ResourceGroup;Values=<resource-group-name>

      For example:

      • Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

      • Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

      • Key=tag-key,Values=Name,Instance-Type,CostCenter

      • Run Command and Maintenance window targets only: Key=resource-groups:Name,Values=ProductionResourceGroup This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

      • Maintenance window targets only: Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2) instances and VPCs in your maintenance window.

      • Automation targets only: Key=ResourceGroup,Values=MyResourceGroup

      • State Manager association targets only: Key=InstanceIds,Values=* This example demonstrates how to target all managed instances in the Amazon Web Services Region where the association was created.

      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

      • Key (string) –

        User-defined criteria for sending commands that target managed nodes that meet the criteria.

      • Values (list) –

        User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

        Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

        • (string) –

  • OwnerInformation (string) – 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 (string) – An optional name for the target.

  • Description (string) – An optional description for the target.

  • ClientToken (string) –

    User-provided idempotency token.

    This field is autopopulated if not provided.

Return type:



Response Syntax

    'WindowTargetId': 'string'

Response Structure

  • (dict) –

    • WindowTargetId (string) –

      The ID of the target definition in this maintenance window.


  • SSM.Client.exceptions.IdempotentParameterMismatch

  • SSM.Client.exceptions.DoesNotExistException

  • SSM.Client.exceptions.ResourceLimitExceededException

  • SSM.Client.exceptions.InternalServerError