Amazon Simple Systems Manager (SSM)
    Amazon Simple Systems Manager (SSM)
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      The Amazon SSM multi-region endpoint
      http://ssm.{region}.amazonaws.com
      POST
      /
      Retrieves a maintenance window.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "WindowId": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "WindowId": "string",
    "Name": "string",
    "Description": "string",
    "StartDate": "string",
    "EndDate": "string",
    "Schedule": "string",
    "ScheduleTimezone": "string",
    "ScheduleOffset": 0,
    "NextExecutionTime": "string",
    "Duration": 0,
    "Cutoff": 0,
    "AllowUnassociatedTargets": true,
    "Enabled": true,
    "CreatedDate": "string",
    "ModifiedDate": "string"
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      WindowId
      string 
      required
      The ID of the maintenance window for which you want to retrieve information.
      >= 20 characters<= 20 characters
      Match pattern:
      ^mw-[0-9a-f]{17}$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      WindowId
      string 
      optional
      The ID of the created maintenance window.
      >= 20 characters<= 20 characters
      Match pattern:
      ^mw-[0-9a-f]{17}$
      Name
      string 
      optional
      The name of the maintenance window.
      >= 3 characters<= 128 characters
      Match pattern:
      ^[a-zA-Z0-9_\-.]{3,128}$
      Description
      string <password>
      optional
      The description of the maintenance window.
      >= 1 characters<= 128 characters
      StartDate
      string 
      optional
      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
      string 
      optional
      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
      string 
      optional
      The schedule of the maintenance window in the form of a cron or rate expression.
      >= 1 characters<= 256 characters
      ScheduleTimezone
      string 
      optional
      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
      integer 
      optional
      The number of days to wait to run a maintenance window after the scheduled cron expression date and time.
      >= 1<= 6
      NextExecutionTime
      string 
      optional
      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
      integer 
      optional
      The duration of the maintenance window in hours.
      >= 1<= 24
      Cutoff
      integer 
      optional
      The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.
      >= 0<= 23
      AllowUnassociatedTargets
      boolean 
      optional
      Whether targets must be registered with the maintenance window before tasks can be defined for those targets.
      Enabled
      boolean 
      optional
      Indicates whether the maintenance window is enabled.
      CreatedDate
      string <date-time>
      optional
      The date the maintenance window was created.
      ModifiedDate
      string <date-time>
      optional
      The date the maintenance window was last modified.
      🟠480DoesNotExistException
      🟠481InternalServerError
      Previous
      /
      Next
      /
      Built with