:doc:`imagebuilder <../../imagebuilder>` / Client / get_workflow_step_execution

***************************
get_workflow_step_execution
***************************



.. py:method:: imagebuilder.Client.get_workflow_step_execution(**kwargs)

  

  Get the runtime information that was logged for a specific runtime instance of the workflow step.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowStepExecution>`_  


  **Request Syntax**
  ::

    response = client.get_workflow_step_execution(
        stepExecutionId='string'
    )
    
  :type stepExecutionId: string
  :param stepExecutionId: **[REQUIRED]** 

    Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.

    

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

    
    ::

      {
          'requestId': 'string',
          'stepExecutionId': 'string',
          'workflowBuildVersionArn': 'string',
          'workflowExecutionId': 'string',
          'imageBuildVersionArn': 'string',
          'name': 'string',
          'description': 'string',
          'action': 'string',
          'status': 'PENDING'|'SKIPPED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
          'rollbackStatus': 'RUNNING'|'COMPLETED'|'SKIPPED'|'FAILED',
          'message': 'string',
          'inputs': 'string',
          'outputs': 'string',
          'startTime': 'string',
          'endTime': 'string',
          'onFailure': 'string',
          'timeoutSeconds': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **requestId** *(string) --* 

        The request ID that uniquely identifies this request.

        
      

      - **stepExecutionId** *(string) --* 

        The unique identifier for the runtime version of the workflow step that you specified in the request.

        
      

      - **workflowBuildVersionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

        
      

      - **workflowExecutionId** *(string) --* 

        The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

        
      

      - **imageBuildVersionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.

        
      

      - **name** *(string) --* 

        The name of the specified runtime instance of the workflow step.

        
      

      - **description** *(string) --* 

        Describes the specified workflow step.

        
      

      - **action** *(string) --* 

        The name of the action that the specified step performs.

        
      

      - **status** *(string) --* 

        The current status for the specified runtime version of the workflow step.

        
      

      - **rollbackStatus** *(string) --* 

        Reports on the rollback status of the specified runtime version of the workflow step, if applicable.

        
      

      - **message** *(string) --* 

        The output message from the specified runtime instance of the workflow step, if applicable.

        
      

      - **inputs** *(string) --* 

        Input parameters that Image Builder provided for the specified runtime instance of the workflow step.

        
      

      - **outputs** *(string) --* 

        The file names that the specified runtime version of the workflow step created as output.

        
      

      - **startTime** *(string) --* 

        The timestamp when the specified runtime version of the workflow step started.

        
      

      - **endTime** *(string) --* 

        The timestamp when the specified runtime instance of the workflow step finished.

        
      

      - **onFailure** *(string) --* 

        The action to perform if the workflow step fails.

        
      

      - **timeoutSeconds** *(integer) --* 

        The maximum duration in seconds for this step to complete its action.

        
  
  **Exceptions**
  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ClientException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`imagebuilder.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ForbiddenException`

  
  *   :py:class:`imagebuilder.Client.exceptions.CallRateLimitExceededException`

  