AWS CLI Command Reference

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 . m2 ]

get-application

Description

Describes the details of a specific application.

See also: AWS API Documentation

Synopsis

  get-application
--application-id <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-id (string)

The identifier of the application.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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

applicationArn -> (string)

The Amazon Resource Name (ARN) of the application.

applicationId -> (string)

The identifier of the application.

creationTime -> (timestamp)

The timestamp when this application was created.

deployedVersion -> (structure)

The version of the application that is deployed.

applicationVersion -> (integer)

The version of the deployed application.

status -> (string)

The status of the deployment.

statusReason -> (string)

The reason for the reported status.

description -> (string)

The description of the application.

engineType -> (string)

The type of the target platform for the application.

environmentId -> (string)

The identifier of the runtime environment where you want to deploy the application.

kmsKeyId -> (string)

The identifier of a customer managed key.

lastStartTime -> (timestamp)

The timestamp when you last started the application. Null until the application runs for the first time.

latestVersion -> (structure)

The latest version of the application.

applicationVersion -> (integer)

The application version.

creationTime -> (timestamp)

The timestamp when the application version was created.

status -> (string)

The status of the application.

statusReason -> (string)

The reason for the reported status.

listenerArns -> (list)

The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.

(string)

listenerPorts -> (list)

The port associated with the network load balancer listener created in your Amazon Web Services account.

(integer)

loadBalancerDnsName -> (string)

The public DNS name of the load balancer created in your Amazon Web Services account.

logGroups -> (list)

The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.

(structure)

A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.

logGroupName -> (string)

The name of the log group.

logType -> (string)

The type of log.

name -> (string)

The unique identifier of the application.

roleArn -> (string)

The Amazon Resource Name (ARN) of the role associated with the application.

status -> (string)

The status of the application.

statusReason -> (string)

The reason for the reported status.

tags -> (map)

A list of tags associated with the application.

key -> (string)

value -> (string)

targetGroupArns -> (list)

Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.

(string)