IoTSiteWise / Client / list_pipelines

list_pipelines¶

IoTSiteWise.Client.list_pipelines(**kwargs)¶

Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.

Request Syntax

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

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace.
nextToken (string) – The token to be used for the next set of paginated results.
maxResults (integer) – The maximum number of results to return for each paginated request. Default: 50.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineSummaries': [
        {
            'pipelineName': 'string',
            'description': 'string',
            'pipelineArn': 'string',
            'version': 'string',
            'status': {
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string'
                },
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Response structure for ListPipelines operation.
- pipelineSummaries (list) –
  
  A list that summarizes each pipeline in the workspace.
  - (dict) –
    
    Contains summary information about a pipeline.
    - pipelineName (string) –
      
      The name of the pipeline.
    - description (string) –
      
      The description of the pipeline.
    - pipelineArn (string) –
      
      The ARN of the pipeline.
    - version (string) –
      
      The version of the pipeline.
    - status (dict) –
      
      The current lifecycle status of the pipeline.
      - error (dict) –
        
        Contains associated error information, if any.
        
        code (string) –
        
        The error code.
        
        message (string) –
        
        The error message.
      - state (string) –
        
        The current status of the resource.
    - createdAt (datetime) –
      
      The time the pipeline was created, in Unix epoch time.
    - updatedAt (datetime) –
      
      The time the pipeline was last updated, in Unix epoch time.
- nextToken (string) –
  
  The token to be used for the next set of paginated results.

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException