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
      /
      For a given maintenance window execution, lists the tasks that were run.
      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 '{
    "WindowExecutionId": "string",
    "Filters": [],
    "MaxResults": 0,
    "NextToken": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "WindowExecutionTaskIdentities": [],
    "NextToken": "string"
}

      Request

      Query Params
      MaxResults
      string 
      optional
      Pagination limit
      NextToken
      string 
      optional
      Pagination token
      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      WindowExecutionId
      string 
      required
      The ID of the maintenance window execution whose task executions should be retrieved.
      >= 36 characters<= 36 characters
      Match pattern:
      ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
      Filters
      array [object] 
      optional
      Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.
      >= 0 items<= 5 items
      MaxResults
      integer 
      optional
      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.
      >= 10<= 100
      NextToken
      string 
      optional
      The token for the next set of items to return. (You received this token from a previous call.)
      Examples

      Responses

      🟢200Success
      application/json
      Body
      WindowExecutionTaskIdentities
      array[object (MaintenanceWindowExecutionTaskIdentity) {10}] 
      optional
      Information about the task executions.
      WindowExecutionId
      string 
      optional
      The ID of the maintenance window execution that ran the task.
      >= 36 characters<= 36 characters
      Match pattern:
      ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
      TaskExecutionId
      string 
      optional
      The ID of the specific task execution in the maintenance window execution.
      >= 36 characters<= 36 characters
      Match pattern:
      ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$
      Status
      enum<string> 
      optional
      The status of the task execution.
      Allowed values:
      PENDINGIN_PROGRESSSUCCESSFAILEDTIMED_OUTCANCELLINGCANCELLEDSKIPPED_OVERLAPPING
      StatusDetails
      string 
      optional
      The details explaining the status of the task execution. Not available for all status values.
      >= 0 characters<= 250 characters
      StartTime
      string <date-time>
      optional
      The time the task execution started.
      EndTime
      string <date-time>
      optional
      The time the task execution finished.
      TaskArn
      string 
      optional
      The Amazon Resource Name (ARN) of the task that ran.
      >= 1 characters<= 1600 characters
      TaskType
      enum<string> 
      optional
      The type of task that ran.
      Allowed values:
      RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA
      AlarmConfiguration
      object 
      optional
      The details for the CloudWatch alarm applied to your maintenance window task.
      TriggeredAlarms
      array[object (AlarmStateInformation) {2}] 
      optional
      The CloudWatch alarm that was invoked by the maintenance window task.
      >= 1 items<= 1 items
      NextToken
      string 
      optional
      The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
      đźź 480DoesNotExistException
      đźź 481InternalServerError
      Previous
      /
      Next
      /
      Built with