:doc:`CloudWatchObservabilityAdminService <../../observabilityadmin>` / Client / list_telemetry_pipelines

************************
list_telemetry_pipelines
************************



.. py:method:: CloudWatchObservabilityAdminService.Client.list_telemetry_pipelines(**kwargs)

  

  Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the ``NextToken`` value from the response to retrieve the next set of results.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListTelemetryPipelines>`_  


  **Request Syntax**
  ::

    response = client.list_telemetry_pipelines(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of telemetry pipelines to return in a single call.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. A previous call generates this token.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'PipelineSummaries': [
              {
                  'CreatedTimeStamp': 123,
                  'LastUpdateTimeStamp': 123,
                  'Arn': 'string',
                  'Name': 'string',
                  'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED',
                  'Tags': {
                      'string': 'string'
                  },
                  'ConfigurationSummary': {
                      'Sources': [
                          {
                              'Type': 'string'
                          },
                      ],
                      'DataSources': [
                          {
                              'Name': 'string',
                              'Type': 'string'
                          },
                      ],
                      'Processors': [
                          'string',
                      ],
                      'ProcessorCount': 123,
                      'Sinks': [
                          'string',
                      ]
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PipelineSummaries** *(list) --* 

        A list of telemetry pipeline summaries containing key information about each pipeline.

        
        

        - *(dict) --* 

          Contains summary information about a telemetry pipeline for listing operations.

          
          

          - **CreatedTimeStamp** *(integer) --* 

            The timestamp when the telemetry pipeline was created.

            
          

          - **LastUpdateTimeStamp** *(integer) --* 

            The timestamp when the telemetry pipeline was last updated.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the telemetry pipeline.

            
          

          - **Name** *(string) --* 

            The name of the telemetry pipeline.

            
          

          - **Status** *(string) --* 

            The current status of the telemetry pipeline.

            
          

          - **Tags** *(dict) --* 

            The key-value pairs associated with the telemetry pipeline resource.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **ConfigurationSummary** *(dict) --* 

            A summary of the pipeline configuration components.

            
            

            - **Sources** *(list) --* 

              The list of data sources configured in the pipeline.

              
              

              - *(dict) --* 

                A list of source plugin types used in the pipeline configuration (such as ``cloudwatch_logs`` or ``s3``). Currently supports a single source per pipeline, but is structured as a list to accommodate multiple pipelines in the configuration.

                
                

                - **Type** *(string) --* 

                  The plugin name of the source, such as ``cloudwatch_logs`` or ``s3``.

                  
            
          
            

            - **DataSources** *(list) --* 

              The list of data sources that provide telemetry data to the pipeline.

              
              

              - *(dict) --* 

                Information about a data source associated with the telemetry pipeline. For CloudWatch Logs sources, this includes both a name and type extracted from the log event metadata. For third-party sources (such as S3), this includes only a name, with the type field left empty.

                
                

                - **Name** *(string) --* 

                  The name of the data source. For CloudWatch Logs sources, this corresponds to the ``data_source_name`` from the log event metadata. For third-party sources, this is either the configured ``data_source_name`` or defaults to the plugin name if not specified.

                  
                

                - **Type** *(string) --* 

                  The type of the data source. For CloudWatch Logs sources, this corresponds to the ``data_source_type`` from the log event metadata. For third-party sources, this field is empty.

                  
            
          
            

            - **Processors** *(list) --* 

              The list of processors configured in the pipeline for data transformation.

              
              

              - *(string) --* 
          
            

            - **ProcessorCount** *(integer) --* 

              The total number of processors configured in the pipeline.

              
            

            - **Sinks** *(list) --* 

              The list of destinations where processed data is sent.

              
              

              - *(string) --* 
          
        
      
    
      

      - **NextToken** *(string) --* 

        A token to resume pagination of results.

        
  
  **Exceptions**
  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.InternalServerException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.ValidationException`

  
  *   :py:class:`CloudWatchObservabilityAdminService.Client.exceptions.TooManyRequestsException`

  