Amazon Systems Manager Systems Manager Maintenance Window Execution API

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Maintenance Window…
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 3 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 Execution
paths:
  /#CancelMaintenanceWindowExecution:
    post:
      operationId: CancelMaintenanceWindowExecution
      summary: Cancel Maintenance Window Execution
      description: Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelMaintenanceWindowExecutionResult'
        '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.CancelMaintenanceWindowExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelMaintenanceWindowExecutionRequest'
      tags:
      - Maintenance Window Execution
  /#DescribeMaintenanceWindowExecutions:
    post:
      operationId: DescribeMaintenanceWindowExecutions
      summary: Describe Maintenance Window Executions
      description: Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeMaintenanceWindowExecutionsResult'
        '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.DescribeMaintenanceWindowExecutions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeMaintenanceWindowExecutionsRequest'
      tags:
      - Maintenance Window Execution
  /#GetMaintenanceWindowExecution:
    post:
      operationId: GetMaintenanceWindowExecution
      summary: Get Maintenance Window Execution
      description: Retrieves details about a specific a maintenance window execution.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetMaintenanceWindowExecutionResult'
        '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.GetMaintenanceWindowExecution
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetMaintenanceWindowExecutionRequest'
      tags:
      - Maintenance Window Execution
components:
  schemas:
    CancelMaintenanceWindowExecutionRequest:
      type: object
      properties:
        WindowExecutionId:
          type: string
          description: The ID of the maintenance window execution to stop.
      required:
      - WindowExecutionId
    DescribeMaintenanceWindowExecutionsRequest:
      type: object
      properties:
        WindowId:
          type: string
          description: The ID of the maintenance window whose executions should be retrieved.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/MaintenanceWindowFilter'
          description: 'Each entry in the array is a structure containing: Key. A string between 1 and 128 characters. Supported keys include ExecutedBefore and ExecutedAfter. Values. An array of strings, each between 1 and 256 characters. Supported values are date/time strings in a valid ISO 8601 date/time format, such as 2024-11-04T05:00:00Z.'
        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:
      - WindowId
    DescribeMaintenanceWindowExecutionsResult:
      type: object
      properties:
        WindowExecutions:
          type: array
          items:
            $ref: '#/components/schemas/MaintenanceWindowExecution'
          description: Information about the maintenance window executions.
        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.
    MaintenanceWindowFilter:
      type: object
      properties:
        Key:
          type: string
          description: The name of the filter.
        Values:
          type: array
          items:
            type: string
          description: The filter values.
    GetMaintenanceWindowExecutionRequest:
      type: object
      properties:
        WindowExecutionId:
          type: string
          description: The ID of the maintenance window execution that includes the task.
      required:
      - WindowExecutionId
    MaintenanceWindowExecution:
      type: object
      properties:
        WindowId:
          type: string
          description: The ID of the maintenance window.
        WindowExecutionId:
          type: string
          description: The ID of the maintenance window execution.
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - TIMED_OUT
          - CANCELLING
          - CANCELLED
          - SKIPPED_OVERLAPPING
          description: The status of the execution.
        StatusDetails:
          type: string
          description: The details explaining the status. Not available for all status values.
        StartTime:
          type: string
          format: date-time
          description: The time the execution started.
        EndTime:
          type: string
          format: date-time
          description: The time the execution finished.
    GetMaintenanceWindowExecutionResult:
      type: object
      properties:
        WindowExecutionId:
          type: string
          description: The ID of the maintenance window execution.
        TaskIds:
          type: array
          items:
            type: string
          description: The ID of the task executions from the maintenance window execution.
        Status:
          type: string
          enum:
          - PENDING
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - TIMED_OUT
          - CANCELLING
          - CANCELLED
          - SKIPPED_OVERLAPPING
          description: The status of the maintenance window execution.
        StatusDetails:
          type: string
          description: The details explaining the status. Not available for all status values.
        StartTime:
          type: string
          format: date-time
          description: The time the maintenance window started running.
        EndTime:
          type: string
          format: date-time
          description: The time the maintenance window finished running.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    CancelMaintenanceWindowExecutionResult:
      type: object
      properties:
        WindowExecutionId:
          type: string
          description: The ID of the maintenance window execution that has been stopped.
    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)