IoTAnalytics / Client / list_pipelines

list_pipelines#

IoTAnalytics.Client.list_pipelines(**kwargs)#

Retrieves a list of pipelines.

See also: AWS API Documentation

Request Syntax

response = client.list_pipelines(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) –

    The maximum number of results to return in this request.

    The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineSummaries': [
        {
            'pipelineName': 'string',
            'reprocessingSummaries': [
                {
                    'id': 'string',
                    'status': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                    'creationTime': datetime(2015, 1, 1)
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • pipelineSummaries (list) –

      A list of PipelineSummary objects.

      • (dict) –

        A summary of information about a pipeline.

        • pipelineName (string) –

          The name of the pipeline.

        • reprocessingSummaries (list) –

          A summary of information about the pipeline reprocessing.

          • (dict) –

            Information about pipeline reprocessing.

            • id (string) –

              The reprocessingId returned by StartPipelineReprocessing.

            • status (string) –

              The status of the pipeline reprocessing.

            • creationTime (datetime) –

              The time the pipeline reprocessing was created.

        • creationTime (datetime) –

          When the pipeline was created.

        • lastUpdateTime (datetime) –

          When the pipeline was last updated.

    • nextToken (string) –

      The token to retrieve the next set of results, or null if there are no more results.

Exceptions