:doc:`drs <../../drs>` / Client / put_launch_action

*****************
put_launch_action
*****************



.. py:method:: drs.Client.put_launch_action(**kwargs)

  

  Puts a resource launch action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/PutLaunchAction>`_  


  **Request Syntax**
  ::

    response = client.put_launch_action(
        actionCode='string',
        actionId='string',
        actionVersion='string',
        active=True|False,
        category='MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER',
        description='string',
        name='string',
        optional=True|False,
        order=123,
        parameters={
            'string': {
                'type': 'SSM_STORE'|'DYNAMIC',
                'value': 'string'
            }
        },
        resourceId='string'
    )
    
  :type actionCode: string
  :param actionCode: **[REQUIRED]** 

    Launch action code.

    

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

    Launch action Id.

    

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

    Launch action version.

    

  
  :type active: boolean
  :param active: **[REQUIRED]** 

    Whether the launch action is active.

    

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

    Launch action category.

    

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

    Launch action description.

    

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

    Launch action name.

    

  
  :type optional: boolean
  :param optional: **[REQUIRED]** 

    Whether the launch will not be marked as failed if this action fails.

    

  
  :type order: integer
  :param order: **[REQUIRED]** 

    Launch action order.

    

  
  :type parameters: dict
  :param parameters: 

    Launch action parameters.

    

  
    - *(string) --* 

    
      - *(dict) --* 

        Launch action parameter.

        

      
        - **type** *(string) --* 

          Type.

          

        
        - **value** *(string) --* 

          Value.

          

        
      


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

    Launch configuration template Id or Source Server Id

    

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

    
    ::

      {
          'actionCode': 'string',
          'actionId': 'string',
          'actionVersion': 'string',
          'active': True|False,
          'category': 'MONITORING'|'VALIDATION'|'CONFIGURATION'|'SECURITY'|'OTHER',
          'description': 'string',
          'name': 'string',
          'optional': True|False,
          'order': 123,
          'parameters': {
              'string': {
                  'type': 'SSM_STORE'|'DYNAMIC',
                  'value': 'string'
              }
          },
          'resourceId': 'string',
          'type': 'SSM_AUTOMATION'|'SSM_COMMAND'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **actionCode** *(string) --* 

        Launch action code.

        
      

      - **actionId** *(string) --* 

        Launch action Id.

        
      

      - **actionVersion** *(string) --* 

        Launch action version.

        
      

      - **active** *(boolean) --* 

        Whether the launch action is active.

        
      

      - **category** *(string) --* 

        Launch action category.

        
      

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

        Launch action description.

        
      

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

        Launch action name.

        
      

      - **optional** *(boolean) --* 

        Whether the launch will not be marked as failed if this action fails.

        
      

      - **order** *(integer) --* 

        Launch action order.

        
      

      - **parameters** *(dict) --* 

        Launch action parameters.

        
        

        - *(string) --* 
          

          - *(dict) --* 

            Launch action parameter.

            
            

            - **type** *(string) --* 

              Type.

              
            

            - **value** *(string) --* 

              Value.

              
        
    
  
      

      - **resourceId** *(string) --* 

        Launch configuration template Id or Source Server Id

        
      

      - **type** *(string) --* 

        Launch action type.

        
  
  **Exceptions**
  
  *   :py:class:`drs.Client.exceptions.ResourceNotFoundException`

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

  
  *   :py:class:`drs.Client.exceptions.ConflictException`

  
  *   :py:class:`drs.Client.exceptions.ThrottlingException`

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

  
  *   :py:class:`drs.Client.exceptions.UninitializedAccountException`

  