SSM / Client / describe_maintenance_window_schedule

describe_maintenance_window_schedule

SSM.Client.describe_maintenance_window_schedule(**kwargs)

Retrieves information about upcoming executions of a maintenance window.

See also: AWS API Documentation

Request Syntax

response = client.describe_maintenance_window_schedule(
    WindowId='string',
    Targets=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ResourceType='INSTANCE'|'RESOURCE_GROUP',
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='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.

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

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

• MaxResults (integer) – The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

• NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

Return type:

dict

Returns:

Response Syntax

{
    'ScheduledWindowExecutions': [
        {
            'WindowId': 'string',
            'Name': 'string',
            'ExecutionTime': 'string'
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    The token for the next set of items to return. (You use this token in the next call.)

Exceptions

• SSM.Client.exceptions.InternalServerError

• SSM.Client.exceptions.DoesNotExistException