:doc:`IoTSiteWise <../../iotsitewise>` / Client / list_time_series

****************
list_time_series
****************



.. py:method:: IoTSiteWise.Client.list_time_series(**kwargs)

  

  Retrieves a paginated list of time series (data streams).

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTimeSeries>`_  


  **Request Syntax**
  ::

    response = client.list_time_series(
        nextToken='string',
        maxResults=123,
        assetId='string',
        aliasPrefix='string',
        timeSeriesType='ASSOCIATED'|'DISASSOCIATED'
    )
    
  :type nextToken: string
  :param nextToken: 

    The token to be used for the next set of paginated results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return for each paginated request.

    

  
  :type assetId: string
  :param assetId: 

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else ``externalId:`` followed by the external ID, if it has one. For more information, see `Referencing objects with external IDs <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references>`__ in the *IoT SiteWise User Guide*.

    

  
  :type aliasPrefix: string
  :param aliasPrefix: 

    The alias prefix of the time series.

    

  
  :type timeSeriesType: string
  :param timeSeriesType: 

    The type of the time series. The time series type can be one of the following values:

     

    
    * ``ASSOCIATED`` – The time series is associated with an asset property.
     
    * ``DISASSOCIATED`` – The time series isn't associated with any asset property.
    

    

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

    
    ::

      {
          'TimeSeriesSummaries': [
              {
                  'assetId': 'string',
                  'propertyId': 'string',
                  'alias': 'string',
                  'timeSeriesId': 'string',
                  'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN'|'STRUCT',
                  'dataTypeSpec': 'string',
                  'timeSeriesCreationDate': datetime(2015, 1, 1),
                  'timeSeriesLastUpdateDate': datetime(2015, 1, 1),
                  'timeSeriesArn': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **TimeSeriesSummaries** *(list) --* 

        One or more time series summaries to list.

        
        

        - *(dict) --* 

          Contains a summary of a time series (data stream).

          
          

          - **assetId** *(string) --* 

            The ID of the asset in which the asset property was created.

            
          

          - **propertyId** *(string) --* 

            The ID of the asset property, in UUID format.

            
          

          - **alias** *(string) --* 

            The alias that identifies the time series.

            
          

          - **timeSeriesId** *(string) --* 

            The ID of the time series.

            
          

          - **dataType** *(string) --* 

            The data type of the time series.

             

            If you specify ``STRUCT``, you must also specify ``dataTypeSpec`` to identify the type of the structure for this time series.

            
          

          - **dataTypeSpec** *(string) --* 

            The data type of the structure for this time series. This parameter is required for time series that have the ``STRUCT`` data type.

             

            The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use ``AWS/ALARM_STATE`` for alarm state in alarm composite models.

            
          

          - **timeSeriesCreationDate** *(datetime) --* 

            The date that the time series was created, in Unix epoch time.

            
          

          - **timeSeriesLastUpdateDate** *(datetime) --* 

            The date that the time series was last updated, in Unix epoch time.

            
          

          - **timeSeriesArn** *(string) --* 

            The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the time series, which has the following format.

             

            ``arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}``

            
      
    
      

      - **nextToken** *(string) --* 

        The token for the next set of results, or null if there are no additional results.

        
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  