SageMaker / Client / list_pipelines

list_pipelines#

SageMaker.Client.list_pipelines(**kwargs)#

Gets a list of pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_pipelines(
    PipelineNamePrefix='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • PipelineNamePrefix (string) – The prefix of the pipeline name.

  • CreatedAfter (datetime) – A filter that returns the pipelines that were created after a specified time.

  • CreatedBefore (datetime) – A filter that returns the pipelines that were created before a specified time.

  • SortBy (string) – The field by which to sort results. The default is CreatedTime.

  • SortOrder (string) – The sort order for results.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of pipelines to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'PipelineSummaries': [
        {
            'PipelineArn': 'string',
            'PipelineName': 'string',
            'PipelineDisplayName': 'string',
            'PipelineDescription': 'string',
            'RoleArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastExecutionTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • PipelineSummaries (list) –

      Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

      • (dict) –

        A summary of a pipeline.

        • PipelineArn (string) –

          The Amazon Resource Name (ARN) of the pipeline.

        • PipelineName (string) –

          The name of the pipeline.

        • PipelineDisplayName (string) –

          The display name of the pipeline.

        • PipelineDescription (string) –

          The description of the pipeline.

        • RoleArn (string) –

          The Amazon Resource Name (ARN) that the pipeline used to execute.

        • CreationTime (datetime) –

          The creation time of the pipeline.

        • LastModifiedTime (datetime) –

          The time that the pipeline was last modified.

        • LastExecutionTime (datetime) –

          The last time that a pipeline execution began.

    • NextToken (string) –

      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.