Skip to content

ListAppsRequest

Source code in docs_src/capo_sagemaker/types/list_apps_request.py
class ListAppsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>"""
    max_results: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.sort_order.SortOrder"]
    """<p>The sort order for the results. The default is Ascending.</p>"""
    sort_by: NotRequired["capo_sagemaker.types.app_sort_key.AppSortKey"]
    """<p>The parameter by which to sort the results. The default is CreationTime.</p>"""
    domain_id_equals: NotRequired["capo_sagemaker.types.domain_id.DomainId"]
    """<p>A parameter to search for the domain ID.</p>"""
    user_profile_name_equals: NotRequired[
        "capo_sagemaker.types.user_profile_name.UserProfileName"
    ]
    """<p>A parameter to search by user profile name. If <code>SpaceNameEquals</code> is set, then this value cannot be set.</p>"""
    space_name_equals: NotRequired["capo_sagemaker.types.space_name.SpaceName"]
    """<p>A parameter to search by space name. If <code>UserProfileNameEquals</code> is set, then this value cannot be set.</p>"""

domain_id_equals instance-attribute

domain_id_equals: NotRequired[DomainId]

A parameter to search for the domain ID.

max_results instance-attribute

max_results: NotRequired[MaxResults]

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

next_token instance-attribute

next_token: NotRequired[NextToken]

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

sort_by instance-attribute

sort_by: NotRequired[AppSortKey]

The parameter by which to sort the results. The default is CreationTime.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order for the results. The default is Ascending.

space_name_equals instance-attribute

space_name_equals: NotRequired[SpaceName]

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

user_profile_name_equals instance-attribute

user_profile_name_equals: NotRequired[UserProfileName]

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.