Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_apps

list_apps(**kwargs)

Lists apps.

See also: AWS API Documentation

Request Syntax

response = client.list_apps(
    NextToken='string',
    MaxResults=123,
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime',
    DomainIdEquals='string',
    UserProfileNameEquals='string',
    SpaceNameEquals='string'
)
Parameters
  • NextToken (string) -- If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
  • MaxResults (integer) -- Returns a list up to a specified limit.
  • 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.
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'
        },
    ],
    'NextToken': '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.

    • NextToken (string) --

      If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.