Amazon Systems Manager Systems Manager Maintenance Window API
The Systems Manager Maintenance Window API from Amazon Systems Manager — 6 operation(s) for systems manager maintenance window.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-systems-manager:amazon-systems-manager-maintenance-window-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Simple Systems Manager (SSM) Maintenance Window API
version: '2014-11-06'
description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 6 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ssm.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Maintenance Window
paths:
/#CreateMaintenanceWindow:
post:
operationId: CreateMaintenanceWindow
summary: Create Maintenance Window
description: Creates a new maintenance window. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateMaintenanceWindowResult'
'400':
description: IdempotentParameterMismatch; ResourceLimitExceededException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/IdempotentParameterMismatch'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.CreateMaintenanceWindow
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateMaintenanceWindowRequest'
tags:
- Maintenance Window
/#DeleteMaintenanceWindow:
post:
operationId: DeleteMaintenanceWindow
summary: Delete Maintenance Window
description: Deletes a maintenance window.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteMaintenanceWindowResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.DeleteMaintenanceWindow
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteMaintenanceWindowRequest'
tags:
- Maintenance Window
/#DescribeMaintenanceWindows:
post:
operationId: DescribeMaintenanceWindows
summary: Describe Maintenance Windows
description: Retrieves the maintenance windows in an Amazon Web Services account.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMaintenanceWindowsResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.DescribeMaintenanceWindows
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMaintenanceWindowsRequest'
tags:
- Maintenance Window
/#DescribeMaintenanceWindowsForTarget:
post:
operationId: DescribeMaintenanceWindowsForTarget
summary: Describe Maintenance Windows For Target
description: Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMaintenanceWindowsForTargetResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.DescribeMaintenanceWindowsForTarget
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeMaintenanceWindowsForTargetRequest'
tags:
- Maintenance Window
/#GetMaintenanceWindow:
post:
operationId: GetMaintenanceWindow
summary: Get Maintenance Window
description: Retrieves a maintenance window.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetMaintenanceWindowResult'
'400':
description: DoesNotExistException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DoesNotExistException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.GetMaintenanceWindow
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetMaintenanceWindowRequest'
tags:
- Maintenance Window
/#UpdateMaintenanceWindow:
post:
operationId: UpdateMaintenanceWindow
summary: Update Maintenance Window
description: Updates an existing maintenance window. Only specified parameters are modified. The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateMaintenanceWindowResult'
'400':
description: DoesNotExistException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DoesNotExistException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.UpdateMaintenanceWindow
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateMaintenanceWindowRequest'
tags:
- Maintenance Window
components:
schemas:
DescribeMaintenanceWindowsRequest:
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/MaintenanceWindowFilter'
description: Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled. For example, Name=MyMaintenanceWindow and Enabled=True.
MaxResults:
type: integer
description: 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:
type: string
description: The token for the next set of items to return. (You received this token from a previous call.)
DescribeMaintenanceWindowsResult:
type: object
properties:
WindowIdentities:
type: array
items:
$ref: '#/components/schemas/MaintenanceWindowIdentity'
description: Information about the maintenance windows.
NextToken:
type: string
description: The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Tag:
type: object
properties:
Key:
type: string
description: The name of the tag.
Value:
type: string
description: The value of the tag.
required:
- Key
- Value
MaintenanceWindowIdentity:
type: object
properties:
WindowId:
type: string
description: The ID of the maintenance window.
Name:
type: string
description: The name of the maintenance window.
Description:
type: string
description: A description of the maintenance window.
Enabled:
type: boolean
description: Indicates whether the maintenance window is enabled.
Duration:
type: integer
description: The duration of the maintenance window in hours.
Cutoff:
type: integer
description: The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
Schedule:
type: string
description: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleTimezone:
type: string
description: The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.
ScheduleOffset:
type: integer
description: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
EndDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.
StartDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
NextExecutionTime:
type: string
description: The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
DescribeMaintenanceWindowsForTargetResult:
type: object
properties:
WindowIdentities:
type: array
items:
$ref: '#/components/schemas/MaintenanceWindowIdentityForTarget'
description: Information about the maintenance window targets and tasks a managed node is associated with.
NextToken:
type: string
description: The token for the next set of items to return. (You use this token in the next call.)
CreateMaintenanceWindowResult:
type: object
properties:
WindowId:
type: string
description: The ID of the created maintenance window.
InternalServerError:
type: object
properties:
Message:
type: string
MaintenanceWindowIdentityForTarget:
type: object
properties:
WindowId:
type: string
description: The ID of the maintenance window.
Name:
type: string
description: The name of the maintenance window.
CreateMaintenanceWindowRequest:
type: object
properties:
Name:
type: string
description: The name of the maintenance window.
Description:
type: string
description: An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.
StartDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date. When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.
EndDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
Schedule:
type: string
description: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleTimezone:
type: string
description: 'The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.'
ScheduleOffset:
type: integer
description: The number of days to wait after the date and time specified by a cron expression before running the maintenance window. For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, the maintenance window won't run until two days later.
Duration:
type: integer
description: The duration of the maintenance window in hours.
Cutoff:
type: integer
description: The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets:
type: boolean
description: Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window. If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.
ClientToken:
type: string
description: User-provided idempotency token.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: 'Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key-value pairs: Key=TaskType,Value=AgentUpdate Key=OS,Value=Windows Key=Environment,Value=Production To add tags to an existing maintenance window, use the AddTagsToResource operation.'
required:
- Name
- Schedule
- Duration
- Cutoff
- AllowUnassociatedTargets
UpdateMaintenanceWindowRequest:
type: object
properties:
WindowId:
type: string
description: The ID of the maintenance window to update.
Name:
type: string
description: The name of the maintenance window.
Description:
type: string
description: An optional description for the update request.
StartDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date. When using a rate schedule, if you provide a start date that occurs in the past, the current date and time are used as the start date.
EndDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
Schedule:
type: string
description: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleTimezone:
type: string
description: 'The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.'
ScheduleOffset:
type: integer
description: The number of days to wait after the date and time specified by a cron expression before running the maintenance window. For example, the following cron expression schedules a maintenance window to run the third Tuesday of every month at 11:30 PM. cron(30 23 ? * TUE#3 *) If the schedule offset is 2, the maintenance window won't run until two days later.
Duration:
type: integer
description: The duration of the maintenance window in hours.
Cutoff:
type: integer
description: The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets:
type: boolean
description: Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
Enabled:
type: boolean
description: Whether the maintenance window is enabled.
Replace:
type: boolean
description: If True, then all fields that are required by the CreateMaintenanceWindow operation are also required for this API request. Optional fields that aren't specified are set to null.
required:
- WindowId
Target:
type: object
properties:
Key:
type: string
description: User-defined criteria for sending commands that target managed nodes that meet the criteria.
Values:
type: array
items:
type: string
description: 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.
UpdateMaintenanceWindowResult:
type: object
properties:
WindowId:
type: string
description: The ID of the created maintenance window.
Name:
type: string
description: The name of the maintenance window.
Description:
type: string
description: An optional description of the update.
StartDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
EndDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
Schedule:
type: string
description: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleTimezone:
type: string
description: 'The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.'
ScheduleOffset:
type: integer
description: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
Duration:
type: integer
description: The duration of the maintenance window in hours.
Cutoff:
type: integer
description: The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets:
type: boolean
description: Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
Enabled:
type: boolean
description: Whether the maintenance window is enabled.
MaintenanceWindowFilter:
type: object
properties:
Key:
type: string
description: The name of the filter.
Values:
type: array
items:
type: string
description: The filter values.
GetMaintenanceWindowResult:
type: object
properties:
WindowId:
type: string
description: The ID of the created maintenance window.
Name:
type: string
description: The name of the maintenance window.
Description:
type: string
description: The description of the maintenance window.
StartDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
EndDate:
type: string
description: The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
Schedule:
type: string
description: The schedule of the maintenance window in the form of a cron or rate expression.
ScheduleTimezone:
type: string
description: 'The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.'
ScheduleOffset:
type: integer
description: The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
NextExecutionTime:
type: string
description: The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
Duration:
type: integer
description: The duration of the maintenance window in hours.
Cutoff:
type: integer
description: The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
AllowUnassociatedTargets:
type: boolean
description: Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
Enabled:
type: boolean
description: Indicates whether the maintenance window is enabled.
CreatedDate:
type: string
format: date-time
description: The date the maintenance window was created.
ModifiedDate:
type: string
format: date-time
description: The date the maintenance window was last modified.
DescribeMaintenanceWindowsForTargetRequest:
type: object
properties:
Targets:
type: array
items:
$ref: '#/components/schemas/Target'
description: The managed node ID or key-value pair to retrieve information about.
ResourceType:
type: string
enum:
- INSTANCE
- RESOURCE_GROUP
description: The type of resource you want to retrieve information about. For example, INSTANCE.
MaxResults:
type: integer
description: 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:
type: string
description: The token for the next set of items to return. (You received this token from a previous call.)
required:
- Targets
- ResourceType
DeleteMaintenanceWindowResult:
type: object
properties:
WindowId:
type: string
description: The ID of the deleted maintenance window.
GetMaintenanceWindowRequest:
type: object
properties:
WindowId:
type: string
description: The ID of the maintenance window for which you want to retrieve information.
required:
- WindowId
IdempotentParameterMismatch:
type: object
properties:
Message:
type: string
DeleteMaintenanceWindowRequest:
type: object
properties:
WindowId:
type: string
description: The ID of the maintenance window to delete.
required:
- WindowId
DoesNotExistException:
type: object
properties:
Message:
type: string
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: ssm
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm/service/2014-11-06/ssm-2014-11-06.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)