SSM / Client / update_maintenance_window_target

update_maintenance_window_target#

SSM.Client.update_maintenance_window_target(**kwargs)#

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.update_maintenance_window_target(
    WindowId='string',
    WindowTargetId='string',
    Targets=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    OwnerInformation='string',
    Name='string',
    Description='string',
    Replace=True|False
)
Parameters:

  • WindowId (string) –

    [REQUIRED]

    The maintenance window ID with which to modify the target.

  • WindowTargetId (string) –

    [REQUIRED]

    The target ID to modify.

  • Targets (list) –

    The targets to add or replace.

    • (dict) –

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

      Note

      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.

      For all Systems Manager capabilities:

      • Key=tag-key,Values=tag-value-1,tag-value-2

      For Automation and Change Manager:

      • Key=tag:tag-key,Values=tag-value

      • Key=ResourceGroup,Values=resource-group-name

      • Key=ParameterValues,Values=value-1,value-2,value-3

      • To target all instances in the Amazon Web Services Region:

        • Key=AWS::EC2::Instance,Values=*

        • Key=InstanceIds,Values=*

      For Run Command and Maintenance Windows:

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

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

      • Key=resource-groups:Name,Values=resource-group-name

      • Additionally, Maintenance Windows support targeting resource types:

        • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

      For State Manager:

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

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

      • To target all instances in the Amazon Web Services Region:

        • Key=InstanceIds,Values=*

      For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes 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) – A name for the update.

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

  • Replace (boolean) – If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow operation are also required for this API request. Optional fields that aren’t specified are set to null.

Return type:

dict

Returns:

Response Syntax

{
    'WindowId': 'string',
    'WindowTargetId': 'string',
    'Targets': [
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    'OwnerInformation': 'string',
    'Name': 'string',
    'Description': 'string'
}

Response Structure

  • (dict) –

    • WindowId (string) –

      The maintenance window ID specified in the update request.

    • WindowTargetId (string) –

      The target ID specified in the update request.

    • Targets (list) –

      The updated targets.

      • (dict) –

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

        Note

        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.

        For all Systems Manager capabilities:

        • Key=tag-key,Values=tag-value-1,tag-value-2

        For Automation and Change Manager:

        • Key=tag:tag-key,Values=tag-value

        • Key=ResourceGroup,Values=resource-group-name

        • Key=ParameterValues,Values=value-1,value-2,value-3

        • To target all instances in the Amazon Web Services Region:

          • Key=AWS::EC2::Instance,Values=*

          • Key=InstanceIds,Values=*

        For Run Command and Maintenance Windows:

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

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

        • Key=resource-groups:Name,Values=resource-group-name

        • Additionally, Maintenance Windows support targeting resource types:

          • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

        For State Manager:

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

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

        • To target all instances in the Amazon Web Services Region:

          • Key=InstanceIds,Values=*

        For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes 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) –

      The updated owner.

    • Name (string) –

      The updated name.

    • Description (string) –

      The updated description.

Exceptions

  • SSM.Client.exceptions.DoesNotExistException

  • SSM.Client.exceptions.InternalServerError