:doc:`SSM <../../ssm>` / Client / describe_maintenance_window_execution_task_invocations

******************************************************
describe_maintenance_window_execution_task_invocations
******************************************************



.. py:method:: SSM.Client.describe_maintenance_window_execution_task_invocations(**kwargs)

  

  Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribeMaintenanceWindowExecutionTaskInvocations>`_  


  **Request Syntax**
  ::

    response = client.describe_maintenance_window_execution_task_invocations(
        WindowExecutionId='string',
        TaskId='string',
        Filters=[
            {
                'Key': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type WindowExecutionId: string
  :param WindowExecutionId: **[REQUIRED]** 

    The ID of the maintenance window execution the task is part of.

    

  
  :type TaskId: string
  :param TaskId: **[REQUIRED]** 

    The ID of the specific task in the maintenance window task that should be retrieved.

    

  
  :type Filters: list
  :param Filters: 

    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``.

    

  
    - *(dict) --* 

      Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use ``MaintenanceWindowFilter>`` include the following:

       

      
      *  DescribeMaintenanceWindowExecutions
       
      *  DescribeMaintenanceWindowExecutionTaskInvocations
       
      *  DescribeMaintenanceWindowExecutionTasks
       
      *  DescribeMaintenanceWindows
       
      *  DescribeMaintenanceWindowTargets
       
      *  DescribeMaintenanceWindowTasks
      

      

    
      - **Key** *(string) --* 

        The name of the filter.

        

      
      - **Values** *(list) --* 

        The filter values.

        

      
        - *(string) --* 

        
    
    

  :type MaxResults: integer
  :param MaxResults: 

    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.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'WindowExecutionTaskInvocationIdentities': [
              {
                  'WindowExecutionId': 'string',
                  'TaskExecutionId': 'string',
                  'InvocationId': 'string',
                  'ExecutionId': 'string',
                  'TaskType': 'RUN_COMMAND'|'AUTOMATION'|'STEP_FUNCTIONS'|'LAMBDA',
                  'Parameters': 'string',
                  'Status': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'TIMED_OUT'|'CANCELLING'|'CANCELLED'|'SKIPPED_OVERLAPPING',
                  'StatusDetails': 'string',
                  'StartTime': datetime(2015, 1, 1),
                  'EndTime': datetime(2015, 1, 1),
                  'OwnerInformation': 'string',
                  'WindowTargetId': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **WindowExecutionTaskInvocationIdentities** *(list) --* 

        Information about the task invocation results per invocation.

        
        

        - *(dict) --* 

          Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.

          
          

          - **WindowExecutionId** *(string) --* 

            The ID of the maintenance window execution that ran the task.

            
          

          - **TaskExecutionId** *(string) --* 

            The ID of the specific task execution in the maintenance window execution.

            
          

          - **InvocationId** *(string) --* 

            The ID of the task invocation.

            
          

          - **ExecutionId** *(string) --* 

            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** *(string) --* 

            The task type.

            
          

          - **Parameters** *(string) --* 

            The parameters that were provided for the invocation when it was run.

            
          

          - **Status** *(string) --* 

            The status of the task invocation.

            
          

          - **StatusDetails** *(string) --* 

            The details explaining the status of the task invocation. Not available for all status values.

            
          

          - **StartTime** *(datetime) --* 

            The time the invocation started.

            
          

          - **EndTime** *(datetime) --* 

            The time the invocation finished.

            
          

          - **OwnerInformation** *(string) --* 

            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.

            
          

          - **WindowTargetId** *(string) --* 

            The ID of the target definition in this maintenance window the invocation was performed for.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

        
  
  **Exceptions**
  
  *   :py:class:`SSM.Client.exceptions.DoesNotExistException`

  
  *   :py:class:`SSM.Client.exceptions.InternalServerError`

  