:doc:`LaunchWizard <../../launch-wizard>` / Client / get_workload

************
get_workload
************



.. py:method:: LaunchWizard.Client.get_workload(**kwargs)

  

  Returns information about a workload.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/GetWorkload>`_  


  **Request Syntax**
  ::

    response = client.get_workload(
        workloadName='string'
    )
    
  :type workloadName: string
  :param workloadName: **[REQUIRED]** 

    The name of the workload.

    

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

    
    ::

      {
          'workload': {
              'workloadName': 'string',
              'displayName': 'string',
              'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
              'description': 'string',
              'documentationUrl': 'string',
              'iconUrl': 'string',
              'statusMessage': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **workload** *(dict) --* 

        Information about the workload.

        
        

        - **workloadName** *(string) --* 

          The name of the workload.

          
        

        - **displayName** *(string) --* 

          The display name of a workload.

          
        

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

          The status of a workload.

           

          You can list deployments in the ``DISABLED`` status.

          
        

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

          The description of a workload.

          
        

        - **documentationUrl** *(string) --* 

          The URL of a workload document.

          
        

        - **iconUrl** *(string) --* 

          The URL of a workload icon.

          
        

        - **statusMessage** *(string) --* 

          The message about a workload's status.

          
    
  
  **Exceptions**
  
  *   :py:class:`LaunchWizard.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`LaunchWizard.Client.exceptions.ResourceNotFoundException`

  