Sign In to the Console
AWS Server Migration Service
API Reference (API Version 2016-10-24)

AWS Documentation » AWS SMS » API Reference » Actions » ListApps

ListApps

Returns a list of summaries for all applications.

Request Syntax

{
   "appIds": [ "string" ],
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

appIds

A list of unique application IDs.

Type: Array of strings

Required: No

maxResults

The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Type: Integer

Required: No

nextToken

The token for the next set of results.

Type: String

Required: No

Response Syntax

{
   "apps": [ 
      { 
         "appId": "string",
         "creationTime": number,
         "description": "string",
         "lastModified": number,
         "latestReplicationTime": number,
         "launchDetails": { 
            "latestLaunchTime": number,
            "stackId": "string",
            "stackName": "string"
         },
         "launchStatus": "string",
         "launchStatusMessage": "string",
         "name": "string",
         "replicationStatus": "string",
         "replicationStatusMessage": "string",
         "roleName": "string",
         "status": "string",
         "statusMessage": "string",
         "totalServerGroups": number,
         "totalServers": number
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

apps

A list of application summaries.

Type: Array of AppSummary objects

nextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalError

An internal error occurred.

HTTP Status Code: 500

InvalidParameterException

A specified parameter is not valid.

HTTP Status Code: 400

MissingRequiredParameterException

A required parameter is missing.

HTTP Status Code: 400

OperationNotPermittedException

This operation is not allowed.

HTTP Status Code: 400

UnauthorizedOperationException

You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: