describe-applications¶
Description¶
Retrieves a list that describes one or more applications.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-applications
[--arns <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--arns (list)
The ARNs for the applications.
(string)
Syntax:
"string" "string" ...
--next-token (string)
The pagination token used to retrieve the next page of results for this operation.
--max-results (integer)
The maximum size of each page of results.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
Applications -> (list)
The applications in the list.
(structure)
Describes an application in the application catalog.
Name -> (string)
The name of the application.
DisplayName -> (string)
The application name to display.
IconURL -> (string)
The URL for the application icon. This URL might be time-limited.
LaunchPath -> (string)
The path to the application executable in the instance.
LaunchParameters -> (string)
The arguments that are passed to the application at launch.
Enabled -> (boolean)
If there is a problem, the application can be disabled after image creation.
Metadata -> (map)
Additional attributes that describe the application.
key -> (string)
value -> (string)
WorkingDirectory -> (string)
The working directory for the application.
Description -> (string)
The description of the application.
Arn -> (string)
The ARN of the application.
AppBlockArn -> (string)
The app block ARN of the application.
IconS3Location -> (structure)
The S3 location of the application icon.
S3Bucket -> (string)
The S3 bucket of the S3 object.
S3Key -> (string)
The S3 key of the S3 object.
Platforms -> (list)
The platforms on which the application can run.
(string)
InstanceFamilies -> (list)
The instance families for the application.
(string)
CreatedTime -> (timestamp)
The time at which the application was created within the app block.
NextToken -> (string)
The pagination token used to retrieve the next page of results for this operation.