SSM / Paginator / DescribeMaintenanceWindowTargets

DescribeMaintenanceWindowTargets

class SSM.Paginator.DescribeMaintenanceWindowTargets

paginator = client.get_paginator('describe_maintenance_window_targets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.describe_maintenance_window_targets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WindowId='string',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• WindowId (string) –

  [REQUIRED]

  The ID of the maintenance window whose targets should be retrieved.

• Filters (list) –

  Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId, and OwnerInformation.

  • (dict) –

    Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:

    • DescribeMaintenanceWindowExecutions

    • DescribeMaintenanceWindowExecutionTaskInvocations

    • DescribeMaintenanceWindowExecutionTasks

    • DescribeMaintenanceWindows

    • DescribeMaintenanceWindowTargets

    • DescribeMaintenanceWindowTasks

    • Key (string) –

      The name of the filter.

    • Values (list) –

      The filter values.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • Targets (list) –

    Information about the targets in the maintenance window.

    • (dict) –

      The target registered with the maintenance window.

      • WindowId (string) –

        The ID of the maintenance window to register the target with.

      • WindowTargetId (string) –

        The ID of the target.

      • ResourceType (string) –

        The type of target that is being registered with the maintenance window.

      • Targets (list) –

        The targets, either managed nodes or tags.

        Specify managed nodes using the following format:

        Key=instanceids,Values=<instanceid1>,<instanceid2>

        Tags are specified using the following format:

        Key=<tag name>,Values=<tag value>.

        • (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) –

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

      • Name (string) –

        The name for the maintenance window target.

      • Description (string) –

        A description for the target.