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 individual task executions (one per target) for a particular 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",
    "Filters": [],
    "MaxResults": 0,
    "NextToken": "string"
}'
      Response Response Example
      200 - Example 1
      {
    "WindowExecutionTaskInvocationIdentities": [],
    "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 the task is part of.
      >= 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}$
      Filters
      array [object] 
      optional
      Optional filters used to scope down the returned task invocations. 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
      WindowExecutionTaskInvocationIdentities
      array[object (MaintenanceWindowExecutionTaskInvocationIdentity) {12}] 
      optional
      Information about the task invocation results per invocation.
      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}$
      InvocationId
      string 
      optional
      The ID of the task invocation.
      >= 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 ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.
      TaskType
      enum<string> 
      optional
      The task type.
      Allowed values:
      RUN_COMMANDAUTOMATIONSTEP_FUNCTIONSLAMBDA
      Parameters
      string <password>
      optional
      The parameters that were provided for the invocation when it was run.
      Status
      enum<string> 
      optional
      The status of the task invocation.
      Allowed values:
      PENDINGIN_PROGRESSSUCCESSFAILEDTIMED_OUTCANCELLINGCANCELLEDSKIPPED_OVERLAPPING
      StatusDetails
      string 
      optional
      The details explaining the status of the task invocation. Not available for all status values.
      >= 0 characters<= 250 characters
      StartTime
      string <date-time>
      optional
      The time the invocation started.
      EndTime
      string <date-time>
      optional
      The time the invocation finished.
      OwnerInformation
      string <password>
      optional
      User-provided value that was specified when the target was registered with the maintenance window. This was also included in any Amazon CloudWatch Events events raised during the task invocation.
      >= 1 characters<= 128 characters
      WindowTargetId
      string 
      optional
      The ID of the target definition in this maintenance window the invocation was performed for.
      <= 36 characters
      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