SageMaker / Paginator / ListApps
ListApps#
- class SageMaker.Paginator.ListApps#
paginator = client.get_paginator('list_apps')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SageMaker.Client.list_apps()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( SortOrder='Ascending'|'Descending', SortBy='CreationTime', DomainIdEquals='string', UserProfileNameEquals='string', SpaceNameEquals='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
SortOrder (string) – The sort order for the results. The default is Ascending.
SortBy (string) – The parameter by which to sort the results. The default is CreationTime.
DomainIdEquals (string) – A parameter to search for the domain ID.
UserProfileNameEquals (string) – A parameter to search by user profile name. If
SpaceNameEquals
is set, then this value cannot be set.SpaceNameEquals (string) – A parameter to search by space name. If
UserProfileNameEquals
is set, then this value cannot be set.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
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.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Apps': [ { 'DomainId': 'string', 'UserProfileName': 'string', 'AppType': 'JupyterServer'|'KernelGateway'|'TensorBoard'|'RStudioServerPro'|'RSessionGateway', 'AppName': 'string', 'Status': 'Deleted'|'Deleting'|'Failed'|'InService'|'Pending', 'CreationTime': datetime(2015, 1, 1), 'SpaceName': 'string' }, ], }
Response Structure
(dict) –
Apps (list) –
The list of apps.
(dict) –
Details about an Amazon SageMaker app.
DomainId (string) –
The domain ID.
UserProfileName (string) –
The user profile name.
AppType (string) –
The type of app.
AppName (string) –
The name of the app.
Status (string) –
The status.
CreationTime (datetime) –
The creation time.
SpaceName (string) –
The name of the space.