SMS / Client / list_apps
list_apps#
- SMS.Client.list_apps(**kwargs)#
Retrieves summaries for all applications.
See also: AWS API Documentation
Request Syntax
response = client.list_apps( appIds=[ 'string', ], nextToken='string', maxResults=123 )
- Parameters:
appIds (list) –
The unique application IDs.
(string) –
nextToken (string) – The token for the next set of results.
maxResults (integer) – 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'apps': [ { 'appId': 'string', 'importedAppId': 'string', 'name': 'string', 'description': 'string', 'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED', 'statusMessage': 'string', 'replicationConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED', 'replicationStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_REPLICATION'|'VALIDATION_IN_PROGRESS'|'REPLICATION_PENDING'|'REPLICATION_IN_PROGRESS'|'REPLICATED'|'PARTIALLY_REPLICATED'|'DELTA_REPLICATION_IN_PROGRESS'|'DELTA_REPLICATED'|'DELTA_REPLICATION_FAILED'|'REPLICATION_FAILED'|'REPLICATION_STOPPING'|'REPLICATION_STOP_FAILED'|'REPLICATION_STOPPED', 'replicationStatusMessage': 'string', 'latestReplicationTime': datetime(2015, 1, 1), 'launchConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED', 'launchStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_LAUNCH'|'VALIDATION_IN_PROGRESS'|'LAUNCH_PENDING'|'LAUNCH_IN_PROGRESS'|'LAUNCHED'|'PARTIALLY_LAUNCHED'|'DELTA_LAUNCH_IN_PROGRESS'|'DELTA_LAUNCH_FAILED'|'LAUNCH_FAILED'|'TERMINATE_IN_PROGRESS'|'TERMINATE_FAILED'|'TERMINATED', 'launchStatusMessage': 'string', 'launchDetails': { 'latestLaunchTime': datetime(2015, 1, 1), 'stackName': 'string', 'stackId': 'string' }, 'creationTime': datetime(2015, 1, 1), 'lastModified': datetime(2015, 1, 1), 'roleName': 'string', 'totalServerGroups': 123, 'totalServers': 123 }, ], 'nextToken': 'string' }
Response Structure
(dict) –
apps (list) –
The application summaries.
(dict) –
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 (datetime) –
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 (dict) –
Details about the latest launch of the application.
latestLaunchTime (datetime) –
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 (datetime) –
The creation time of the application.
lastModified (datetime) –
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.
Exceptions
SMS.Client.exceptions.UnauthorizedOperationException
SMS.Client.exceptions.InvalidParameterException
SMS.Client.exceptions.MissingRequiredParameterException
SMS.Client.exceptions.InternalError
SMS.Client.exceptions.OperationNotPermittedException