mgn.Paginator.
ListApplications
¶paginator = client.get_paginator('list_applications')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.list_applications()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'applicationIDs': [
'string',
],
'isArchived': True|False,
'waveIDs': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Applications list filters.
Filter applications list by application ID.
Filter applications list by archival status.
Filter applications list by wave ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'items': [
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Applications list.
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
waveID (string) --
Application wave ID.
NextToken (string) --
A token to resume pagination.