[ aws . sms ]

list-apps

Description

Retrieves summaries for all applications.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-apps is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: apps

Synopsis

  list-apps
[--app-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--app-ids (list)

The unique application IDs.

(string)

Syntax:

"string" "string" ...

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Output

apps -> (list)

The application summaries.

(structure)

Information about the application.

appId -> (string)

The unique ID of the application.

importedAppId -> (string)

The ID of the application.

name -> (string)

The name of the application.

description -> (string)

The description of the application.

status -> (string)

Status of the application.

statusMessage -> (string)

A message related to the status of the application

replicationConfigurationStatus -> (string)

Status of the replication configuration.

replicationStatus -> (string)

The replication status of the application.

replicationStatusMessage -> (string)

A message related to the replication status of the application.

latestReplicationTime -> (timestamp)

The timestamp of the application’s most recent successful replication.

launchConfigurationStatus -> (string)

Status of the launch configuration.

launchStatus -> (string)

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

The latest time that this application was launched successfully.

stackName -> (string)

The name of the latest stack launched for this application.

stackId -> (string)

The ID of the latest stack launched for this application.

creationTime -> (timestamp)

The creation time of the application.

lastModified -> (timestamp)

The last modified time of the application.

roleName -> (string)

The name of the service role in the customer’s account used by Server Migration Service.

totalServerGroups -> (integer)

The number of server groups present in the application.

totalServers -> (integer)

The number of servers present in the application.

nextToken -> (string)

The token required to retrieve the next set of results. This value is null when there are no more results to return.