WorkSpaces / Client / describe_applications

describe_applications#

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

Request Syntax

response = client.describe_applications(
    ApplicationIds=[
        'string',
    ],
    ComputeTypeNames=[
        'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
    ],
    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',
    ],
    Owner='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ApplicationIds (list) –

    The identifiers of one or more applications.

    • (string) –

  • ComputeTypeNames (list) –

    The compute types supported by the applications.

    • (string) –

  • LicenseType (string) – The license availability for the applications.

  • OperatingSystemNames (list) –

    The operating systems supported by the applications.

    • (string) –

  • Owner (string) – The owner of the applications.

  • MaxResults (integer) – The maximum number of applications to return.

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Return type:

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'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
            ],
            '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',
            ]
        },
    ],
    '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

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException