Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

get-app

Description

Retrieve information about an application.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-app
[--app-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

ID of the application whose information is being retrieved.

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

See 'aws help' for descriptions of global parameters.

Output

appSummary -> (structure)

Information about the application.

appId -> (string)

Unique ID of the application.

name -> (string)

Name of the application.

description -> (string)

Description of the application.

status -> (string)

Status of the application.

statusMessage -> (string)

A message related to the status of the application

replicationStatus -> (string)

Replication status of the application.

replicationStatusMessage -> (string)

A message related to the replication status of the application.

latestReplicationTime -> (timestamp)

Timestamp of the application's most recent successful replication.

launchStatus -> (string)

Launch status of the application.

launchStatusMessage -> (string)

A message related to the launch status of the application.

launchDetails -> (structure)

Details about the latest launch of the application.

latestLaunchTime -> (timestamp)

Latest time this application was launched successfully.

stackName -> (string)

Name of the latest stack launched for this application.

stackId -> (string)

Identifier of the latest stack launched for this application.

creationTime -> (timestamp)

Time of creation of this application.

lastModified -> (timestamp)

Timestamp of the application's creation.

roleName -> (string)

Name of the service role in the customer's account used by AWS SMS.

totalServerGroups -> (integer)

Number of server groups present in the application.

totalServers -> (integer)

Number of servers present in the application.

serverGroups -> (list)

List of server groups belonging to the application.

(structure)

A logical grouping of servers.

serverGroupId -> (string)

Identifier of a server group.

name -> (string)

Name of a server group.

serverList -> (list)

List of servers belonging to a server group.

(structure)

Represents a server.

serverId -> (string)

The identifier of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

Information about the VM server location.

vmManagerId -> (string)

The identifier of the VM manager.

vmId -> (string)

The identifier of the VM.

vmName -> (string)

The name of the VM.

vmManagerName -> (string)

The name of the VM manager.

vmManagerType -> (string)

The type of VM management product.

vmPath -> (string)

The VM folder path in the vCenter Server virtual machine inventory tree.

replicationJobId -> (string)

The identifier of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

tags -> (list)

List of tags associated with the application.

(structure)

A label that can be assigned to an application.

key -> (string)

Tag key.

value -> (string)

Tag value.