Skip to content

ListPipelinesRequest

Source code in docs_src/capo_sagemaker/types/list_pipelines_request.py
class ListPipelinesRequest(TypedDict, closed=True):
    pipeline_name_prefix: NotRequired["capo_sagemaker.types.pipeline_name.PipelineName"]
    """<p>The prefix of the pipeline name.</p>"""
    created_after: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns the pipelines that were created after a specified time.</p>"""
    created_before: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A filter that returns the pipelines that were created before a specified time.</p>"""
    sort_by: NotRequired["capo_sagemaker.types.sort_pipelines_by.SortPipelinesBy"]
    """<p>The field by which to sort results. The default is <code>CreatedTime</code>.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.sort_order.SortOrder"]
    """<p>The sort order for results.</p>"""
    next_token: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<p>If the result of the previous <code>ListPipelines</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipelines, use the token in the next request.</p>"""
    max_results: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>The maximum number of pipelines to return in the response.</p>"""

created_after instance-attribute

created_after: NotRequired[Timestamp]

A filter that returns the pipelines that were created after a specified time.

created_before instance-attribute

created_before: NotRequired[Timestamp]

A filter that returns the pipelines that were created before a specified time.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of pipelines to return in the response.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

pipeline_name_prefix instance-attribute

pipeline_name_prefix: NotRequired[PipelineName]

The prefix of the pipeline name.

sort_by instance-attribute

sort_by: NotRequired[SortPipelinesBy]

The field by which to sort results. The default is CreatedTime.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order for results.