Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces ]

describe-applications

Description

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

See also: AWS API Documentation

Synopsis

  describe-applications
[--application-ids <value>]
[--compute-type-names <value>]
[--license-type <value>]
[--operating-system-names <value>]
[--owner <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--application-ids (list)

The identifiers of one or more applications.

(string)

Syntax:

"string" "string" ...

--compute-type-names (list)

The compute types supported by the applications.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  VALUE
  STANDARD
  PERFORMANCE
  POWER
  GRAPHICS
  POWERPRO
  GRAPHICSPRO
  GRAPHICS_G4DN
  GRAPHICSPRO_G4DN

--license-type (string)

The license availability for the applications.

Possible values:

• LICENSED
• UNLICENSED

--operating-system-names (list)

The operating systems supported by the applications.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  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)

The owner of the applications.

--max-results (integer)

The maximum number of applications to return.

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Applications -> (list)

List of information about the specified applications.

(structure)

Describes the WorkSpace application.

ApplicationId -> (string)

The identifier of the application.

Created -> (timestamp)

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.