:doc:`MigrationHubOrchestrator <../../migrationhuborchestrator>` / Client / update_workflow_step

********************
update_workflow_step
********************



.. py:method:: MigrationHubOrchestrator.Client.update_workflow_step(**kwargs)

  

  Update a step in a migration workflow.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/migrationhuborchestrator-2021-08-28/UpdateWorkflowStep>`_  


  **Request Syntax**
  ::

    response = client.update_workflow_step(
        id='string',
        stepGroupId='string',
        workflowId='string',
        name='string',
        description='string',
        stepActionType='MANUAL'|'AUTOMATED',
        workflowStepAutomationConfiguration={
            'scriptLocationS3Bucket': 'string',
            'scriptLocationS3Key': {
                'linux': 'string',
                'windows': 'string'
            },
            'command': {
                'linux': 'string',
                'windows': 'string'
            },
            'runEnvironment': 'AWS'|'ONPREMISE',
            'targetType': 'SINGLE'|'ALL'|'NONE'
        },
        stepTarget=[
            'string',
        ],
        outputs=[
            {
                'name': 'string',
                'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP',
                'required': True|False,
                'value': {
                    'integerValue': 123,
                    'stringValue': 'string',
                    'listOfStringValue': [
                        'string',
                    ]
                }
            },
        ],
        previous=[
            'string',
        ],
        next=[
            'string',
        ],
        status='AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the step.

    

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

    The ID of the step group.

    

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

    The ID of the migration workflow.

    

  
  :type name: string
  :param name: 

    The name of the step.

    

  
  :type description: string
  :param description: 

    The description of the step.

    

  
  :type stepActionType: string
  :param stepActionType: 

    The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

    

  
  :type workflowStepAutomationConfiguration: dict
  :param workflowStepAutomationConfiguration: 

    The custom script to run tests on the source and target environments.

    

  
    - **scriptLocationS3Bucket** *(string) --* 

      The Amazon S3 bucket where the script is located.

      

    
    - **scriptLocationS3Key** *(dict) --* 

      The Amazon S3 key for the script location.

      

    
      - **linux** *(string) --* 

        The script location for Linux.

        

      
      - **windows** *(string) --* 

        The script location for Windows.

        

      
    
    - **command** *(dict) --* 

      The command required to run the script.

      

    
      - **linux** *(string) --* 

        Command for Linux.

        

      
      - **windows** *(string) --* 

        Command for Windows.

        

      
    
    - **runEnvironment** *(string) --* 

      The source or target environment.

      

    
    - **targetType** *(string) --* 

      The servers on which to run the script.

      

    
  
  :type stepTarget: list
  :param stepTarget: 

    The servers on which a step will be run.

    

  
    - *(string) --* 

    

  :type outputs: list
  :param outputs: 

    The outputs of a step.

    

  
    - *(dict) --* 

      The output of a step.

      

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

        The name of the step.

        

      
      - **dataType** *(string) --* 

        The data type of the output.

        

      
      - **required** *(boolean) --* 

        Determine if an output is required from a step.

        

      
      - **value** *(dict) --* 

        The value of the output.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``integerValue``, ``stringValue``, ``listOfStringValue``. 

      
        - **integerValue** *(integer) --* 

          The integer value.

          

        
        - **stringValue** *(string) --* 

          The string value.

          

        
        - **listOfStringValue** *(list) --* 

          The list of string value.

          

        
          - *(string) --* 

          
      
      
    

  :type previous: list
  :param previous: 

    The previous step.

    

  
    - *(string) --* 

    

  :type next: list
  :param next: 

    The next step.

    

  
    - *(string) --* 

    

  :type status: string
  :param status: 

    The status of the step.

    

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

    
    ::

      {
          'id': 'string',
          'stepGroupId': 'string',
          'workflowId': 'string',
          'name': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The ID of the step.

        
      

      - **stepGroupId** *(string) --* 

        The ID of the step group.

        
      

      - **workflowId** *(string) --* 

        The ID of the migration workflow.

        
      

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

        The name of the step.

        
  
  **Exceptions**
  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.InternalServerException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ValidationException`

  