:doc:`WorkSpaces <../../workspaces>` / Client / describe_applications

*********************
describe_applications
*********************



.. py:method:: WorkSpaces.Client.describe_applications(**kwargs)

  

  Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplications>`_  


  **Request Syntax**
  ::

    response = client.describe_applications(
        ApplicationIds=[
            'string',
        ],
        ComputeTypeNames=[
            'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GENERALPURPOSE_4XLARGE'|'GENERALPURPOSE_8XLARGE'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'|'GRAPHICS_G6_XLARGE'|'GRAPHICS_G6_2XLARGE'|'GRAPHICS_G6_4XLARGE'|'GRAPHICS_G6_8XLARGE'|'GRAPHICS_G6_16XLARGE'|'GRAPHICS_GR6_4XLARGE'|'GRAPHICS_GR6_8XLARGE'|'GRAPHICS_G6F_LARGE'|'GRAPHICS_G6F_XLARGE'|'GRAPHICS_G6F_2XLARGE'|'GRAPHICS_G6F_4XLARGE'|'GRAPHICS_GR6F_4XLARGE',
        ],
        LicenseType='LICENSED'|'UNLICENSED',
        OperatingSystemNames=[
            'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
        ],
        Owner='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ApplicationIds: list
  :param ApplicationIds: 

    The identifiers of one or more applications.

    

  
    - *(string) --* 

    

  :type ComputeTypeNames: list
  :param ComputeTypeNames: 

    The compute types supported by the applications.

    

  
    - *(string) --* 

    

  :type LicenseType: string
  :param LicenseType: 

    The license availability for the applications.

    

  
  :type OperatingSystemNames: list
  :param OperatingSystemNames: 

    The operating systems supported by the applications.

    

  
    - *(string) --* 

    

  :type Owner: string
  :param Owner: 

    The owner of the applications.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of applications to return.

    

  
  :type NextToken: string
  :param NextToken: 

    If you received a ``NextToken`` from a previous call that was paginated, provide this token to receive the next set of results.

    

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

    
    ::

      {
          'Applications': [
              {
                  'ApplicationId': 'string',
                  'Created': datetime(2015, 1, 1),
                  'Description': 'string',
                  'LicenseType': 'LICENSED'|'UNLICENSED',
                  'Name': 'string',
                  'Owner': 'string',
                  'State': 'PENDING'|'ERROR'|'AVAILABLE'|'UNINSTALL_ONLY',
                  'SupportedComputeTypeNames': [
                      'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GENERALPURPOSE_4XLARGE'|'GENERALPURPOSE_8XLARGE'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'|'GRAPHICS_G6_XLARGE'|'GRAPHICS_G6_2XLARGE'|'GRAPHICS_G6_4XLARGE'|'GRAPHICS_G6_8XLARGE'|'GRAPHICS_G6_16XLARGE'|'GRAPHICS_GR6_4XLARGE'|'GRAPHICS_GR6_8XLARGE'|'GRAPHICS_G6F_LARGE'|'GRAPHICS_G6F_XLARGE'|'GRAPHICS_G6F_2XLARGE'|'GRAPHICS_G6F_4XLARGE'|'GRAPHICS_GR6F_4XLARGE',
                  ],
                  'SupportedOperatingSystemNames': [
                      'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Applications** *(list) --* 

        List of information about the specified applications.

        
        

        - *(dict) --* 

          Describes the WorkSpace application.

          
          

          - **ApplicationId** *(string) --* 

            The identifier of the application.

            
          

          - **Created** *(datetime) --* 

            The time the application is created.

            
          

          - **Description** *(string) --* 

            The description of the WorkSpace application.

            
          

          - **LicenseType** *(string) --* 

            The license availability for the applications.

            
          

          - **Name** *(string) --* 

            The name of the WorkSpace application.

            
          

          - **Owner** *(string) --* 

            The owner of the WorkSpace application.

            
          

          - **State** *(string) --* 

            The status of WorkSpace application.

            
          

          - **SupportedComputeTypeNames** *(list) --* 

            The supported compute types of the WorkSpace application.

            
            

            - *(string) --* 
        
          

          - **SupportedOperatingSystemNames** *(list) --* 

            The supported operating systems of the WorkSpace application.

            
            

            - *(string) --* 
        
      
    
      

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

        If you received a ``NextToken`` from a previous call that was paginated, provide this token to receive the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

  
  *   :py:class:`WorkSpaces.Client.exceptions.OperationNotSupportedException`

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

  