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 information about a specific task running on a specific target.
      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",
    "TaskId": "string",
    "InvocationId": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "WindowExecutionId": "string",
    "TaskExecutionId": "string",
    "InvocationId": "string",
    "ExecutionId": "string",
    "TaskType": "RUN_COMMAND",
    "Parameters": "string",
    "Status": "PENDING",
    "StatusDetails": "string",
    "StartTime": "string",
    "EndTime": "string",
    "OwnerInformation": "string",
    "WindowTargetId": "string"
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      WindowExecutionId
      string 
      required
      The ID of the maintenance window execution for which the task is a part.
      >= 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}$
      TaskId
      string 
      required
      The ID of the specific task in the maintenance window task that 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}$
      InvocationId
      string 
      required
      The invocation ID to retrieve.
      >= 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}$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      WindowExecutionId
      string 
      optional
      The maintenance window execution ID.
      >= 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 task execution ID.
      >= 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}$
      InvocationId
      string 
      optional
      The invocation ID.
      >= 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}$
      ExecutionId
      string 
      optional
      The execution ID.
      TaskType
      enum<string> 
      optional
      Retrieves the task type for a maintenance window.
      Allowed values:
      RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA
      Parameters
      string <password>
      optional
      The parameters used at the time that the task ran.
      Status
      enum<string> 
      optional
      The task status for an invocation.
      Allowed values:
      PENDINGIN_PROGRESSSUCCESSFAILEDTIMED_OUTCANCELLINGCANCELLEDSKIPPED_OVERLAPPING
      StatusDetails
      string 
      optional
      The details explaining the status. Details are only available for certain status values.
      >= 0 characters<= 250 characters
      StartTime
      string <date-time>
      optional
      The time that the task started running on the target.
      EndTime
      string <date-time>
      optional
      The time that the task finished running on the target.
      OwnerInformation
      string <password>
      optional
      User-provided value to be included in any Amazon CloudWatch Events or Amazon EventBridge events raised while running tasks for these targets in this maintenance window.
      >= 1 characters<= 128 characters
      WindowTargetId
      string 
      optional
      The maintenance window target ID.
      <= 36 characters
      🟠480DoesNotExistException
      🟠481InternalServerError
      Previous
      /
      Next
      /
      Built with