Skip to content

ListTrialsRequest

Source code in docs_src/capo_sagemaker/types/list_trials_request.py
class ListTrialsRequest(TypedDict, closed=True):
    experiment_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>A filter that returns only trials that are part of the specified experiment.</p>"""
    trial_component_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>A filter that returns only trials that are associated with the specified trial component.</p>"""
    created_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only trials created after the specified time.</p>"""
    created_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns only trials created before the specified time.</p>"""
    sort_by: NotRequired["capo_sagemaker.types.sort_trials_by.SortTrialsBy"]
    """<p>The property used to sort results. The default value is <code>CreationTime</code>.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.sort_order.SortOrder"]
    """<p>The sort order. The default value is <code>Descending</code>.</p>"""
    max_results: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>The maximum number of trials to return in the response. The default value is 10.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the previous call to <code>ListTrials</code> didn't return the full set of trials, the call returns a token for getting the next set of trials.</p>"""

created_after instance-attribute

created_after: NotRequired[Timestamp]

A filter that returns only trials created after the specified time.

created_before instance-attribute

created_before: NotRequired[Timestamp]

A filter that returns only trials created before the specified time.

experiment_name instance-attribute

experiment_name: NotRequired[ExperimentEntityName]

A filter that returns only trials that are part of the specified experiment.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of trials to return in the response. The default value is 10.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

sort_by instance-attribute

sort_by: NotRequired[SortTrialsBy]

The property used to sort results. The default value is CreationTime.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order. The default value is Descending.

trial_component_name instance-attribute

trial_component_name: NotRequired[ExperimentEntityName]

A filter that returns only trials that are associated with the specified trial component.