DataPipeline / Client / list_pipelines

list_pipelines#

DataPipeline.Client.list_pipelines(**kwargs)#

Lists the pipeline identifiers for all active pipelines that you have permission to access.

See also: AWS API Documentation

Request Syntax

response = client.list_pipelines(
    marker='string'
)
Parameters:

marker (string) – The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call ListPipelines with the marker value from the previous call to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineIdList': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'marker': 'string',
    'hasMoreResults': True|False
}

Response Structure

  • (dict) –

    Contains the output of ListPipelines.

    • pipelineIdList (list) –

      The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

      • (dict) –

        Contains the name and identifier of a pipeline.

        • id (string) –

          The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .

        • name (string) –

          The name of the pipeline.

    • marker (string) –

      The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results.

    • hasMoreResults (boolean) –

      Indicates whether there are more results that can be obtained by a subsequent call.

Exceptions

  • DataPipeline.Client.exceptions.InternalServiceError

  • DataPipeline.Client.exceptions.InvalidRequestException