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 the details about a specific task run as part of a maintenance window execution.
      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"
}'
      Response Response Example
      200 - Example 1
      {
    "WindowExecutionId": "string",
    "TaskExecutionId": "string",
    "TaskArn": "string",
    "ServiceRole": "string",
    "Type": "RUN_COMMAND",
    "TaskParameters": [],
    "Priority": 0,
    "MaxConcurrency": "string",
    "MaxErrors": "string",
    "Status": "PENDING",
    "StatusDetails": "string",
    "StartTime": "string",
    "EndTime": "string",
    "AlarmConfiguration": {
        "IgnorePollAlarmFailure": true,
        "Alarms": []
    },
    "TriggeredAlarms": []
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      WindowExecutionId
      string 
      required
      The ID of the maintenance window execution that includes 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}$
      TaskId
      string 
      required
      The ID of the specific task execution 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}$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      WindowExecutionId
      string 
      optional
      The ID of the maintenance window execution that includes 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 task that was 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}$
      TaskArn
      string 
      optional
      The Amazon Resource Name (ARN) of the task that ran.
      >= 1 characters<= 1600 characters
      ServiceRole
      string 
      optional
      The role that was assumed when running the task.
      Type
      enum<string> 
      optional
      The type of task that was run.
      Allowed values:
      RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA
      TaskParameters
      array[object (MaintenanceWindowTaskParameters)] 
      optional
      The parameters passed to the task when it was run.
      The map has the following format:
      • Key: string, between 1 and 255 characters
      • Value: an array of strings, each between 1 and 255 characters
      Priority
      integer 
      optional
      The priority of the task.
      >= 0
      MaxConcurrency
      string 
      optional
      The defined maximum number of task executions that could be run in parallel.
      >= 1 characters<= 7 characters
      Match pattern:
      ^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$
      MaxErrors
      string 
      optional
      The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
      >= 1 characters<= 7 characters
      Match pattern:
      ^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$
      Status
      enum<string> 
      optional
      The status of the task.
      Allowed values:
      PENDINGIN_PROGRESSSUCCESSFAILEDTIMED_OUTCANCELLINGCANCELLEDSKIPPED_OVERLAPPING
      StatusDetails
      string 
      optional
      The details explaining the status. 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 completed.
      AlarmConfiguration
      object 
      optional
      The details for the CloudWatch alarm you applied to your maintenance window task.
      IgnorePollAlarmFailure
      boolean 
      optional
      When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
      Alarms
      array[object (Alarm) {1}] 
      required
      The name of the CloudWatch alarm specified in the configuration.
      >= 1 items<= 1 items
      TriggeredAlarms
      array[object (AlarmStateInformation) {2}] 
      optional
      The CloudWatch alarms that were invoked by the maintenance window task.
      >= 1 items<= 1 items
      Name
      string 
      required
      The name of your CloudWatch alarm.
      >= 1 characters<= 255 characters
      Match pattern:
      ^(?!\s*$).+
      State
      enum<string> 
      required
      The state of your CloudWatch alarm.
      Allowed values:
      UNKNOWNALARM
      đźź 480DoesNotExistException
      đźź 481InternalServerError
      Previous
      /
      Next
      /
      Built with