SSM / Paginator / DescribeMaintenanceWindowSchedule

DescribeMaintenanceWindowSchedule

class SSM.Paginator.DescribeMaintenanceWindowSchedule

paginator = client.get_paginator('describe_maintenance_window_schedule')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• WindowId (string) – The ID of the maintenance window to retrieve information about.

• Targets (list) –

  The managed node ID or key-value pair to retrieve information about.

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

• ResourceType (string) – The type of resource you want to retrieve information about. For example, INSTANCE.

• Filters (list) –

  Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

  • (dict) –

    Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:

    • DescribeAvailablePatches

    • DescribeInstancePatches

    • DescribePatchBaselines

    • DescribePatchGroups

    • Key (string) –

      The key for the filter.

    • Values (list) –

      The value for the filter.

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

{
    'ScheduledWindowExecutions': [
        {
            'WindowId': 'string',
            'Name': 'string',
            'ExecutionTime': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ScheduledWindowExecutions (list) –

    Information about maintenance window executions scheduled for the specified time range.

    • (dict) –

      Information about a scheduled execution for a maintenance window.

      • WindowId (string) –

        The ID of the maintenance window to be run.

      • Name (string) –

        The name of the maintenance window to be run.

      • ExecutionTime (string) –

        The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.