:doc:`FinSpaceData <../../finspace-data>` / Paginator / ListDataViews

*************
ListDataViews
*************



.. py:class:: FinSpaceData.Paginator.ListDataViews

  ::

    
    paginator = client.get_paginator('list_data_views')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`FinSpaceData.Client.list_data_views`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          datasetId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type datasetId: string
    :param datasetId: **[REQUIRED]** 

      The unique identifier of the Dataset for which to retrieve Dataviews.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'dataViews': [
                {
                    'dataViewId': 'string',
                    'dataViewArn': 'string',
                    'datasetId': 'string',
                    'asOfTimestamp': 123,
                    'partitionColumns': [
                        'string',
                    ],
                    'sortColumns': [
                        'string',
                    ],
                    'status': 'RUNNING'|'STARTING'|'FAILED'|'CANCELLED'|'TIMEOUT'|'SUCCESS'|'PENDING'|'FAILED_CLEANUP_FAILED',
                    'errorInfo': {
                        'errorMessage': 'string',
                        'errorCategory': 'VALIDATION'|'SERVICE_QUOTA_EXCEEDED'|'ACCESS_DENIED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INTERNAL_SERVICE_EXCEPTION'|'CANCELLED'|'USER_RECOVERABLE'
                    },
                    'destinationTypeProperties': {
                        'destinationType': 'string',
                        's3DestinationExportFileFormat': 'PARQUET'|'DELIMITED_TEXT',
                        's3DestinationExportFileFormatOptions': {
                            'string': 'string'
                        }
                    },
                    'autoUpdate': True|False,
                    'createTime': 123,
                    'lastModifiedTime': 123
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **dataViews** *(list) --* 

          A list of Dataviews.

          
          

          - *(dict) --* 

            Structure for the summary of a Dataview.

            
            

            - **dataViewId** *(string) --* 

              The unique identifier for the Dataview.

              
            

            - **dataViewArn** *(string) --* 

              The ARN identifier of the Dataview.

              
            

            - **datasetId** *(string) --* 

              Th unique identifier for the Dataview Dataset.

              
            

            - **asOfTimestamp** *(integer) --* 

              Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

              
            

            - **partitionColumns** *(list) --* 

              Ordered set of column names used to partition data.

              
              

              - *(string) --* 1 - 255 character String
          
            

            - **sortColumns** *(list) --* 

              Columns to be used for sorting the data.

              
              

              - *(string) --* 1 - 255 character String
          
            

            - **status** *(string) --* 

              The status of a Dataview creation.

               

              
              * ``RUNNING`` – Dataview creation is running.
               
              * ``STARTING`` – Dataview creation is starting.
               
              * ``FAILED`` – Dataview creation has failed.
               
              * ``CANCELLED`` – Dataview creation has been cancelled.
               
              * ``TIMEOUT`` – Dataview creation has timed out.
               
              * ``SUCCESS`` – Dataview creation has succeeded.
               
              * ``PENDING`` – Dataview creation is pending.
               
              * ``FAILED_CLEANUP_FAILED`` – Dataview creation failed and resource cleanup failed.
              

              
            

            - **errorInfo** *(dict) --* 

              The structure with error messages.

              
              

              - **errorMessage** *(string) --* 

                The text of the error message.

                
              

              - **errorCategory** *(string) --* 

                The category of the error.

                 

                
                * ``VALIDATION`` – The inputs to this request are invalid.
                 
                * ``SERVICE_QUOTA_EXCEEDED`` – Service quotas have been exceeded. Please contact AWS support to increase quotas.
                 
                * ``ACCESS_DENIED`` – Missing required permission to perform this request.
                 
                * ``RESOURCE_NOT_FOUND`` – One or more inputs to this request were not found.
                 
                * ``THROTTLING`` – The system temporarily lacks sufficient resources to process the request.
                 
                * ``INTERNAL_SERVICE_EXCEPTION`` – An internal service error has occurred.
                 
                * ``CANCELLED`` – Cancelled.
                 
                * ``USER_RECOVERABLE`` – A user recoverable error has occurred.
                

                
          
            

            - **destinationTypeProperties** *(dict) --* 

              Information about the Dataview destination.

              
              

              - **destinationType** *(string) --* 

                Destination type for a Dataview.

                 

                
                * ``GLUE_TABLE`` – Glue table destination type.
                 
                * ``S3`` – S3 destination type.
                

                
              

              - **s3DestinationExportFileFormat** *(string) --* 

                Dataview export file format.

                 

                
                * ``PARQUET`` – Parquet export file format.
                 
                * ``DELIMITED_TEXT`` – Delimited text export file format.
                

                
              

              - **s3DestinationExportFileFormatOptions** *(dict) --* 

                Format Options for S3 Destination type.

                 

                Here is an example of how you could specify the ``s3DestinationExportFileFormatOptions``

                 

                ``{ "header": "true", "delimiter": ",", "compression": "gzip" }``

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
            

            - **autoUpdate** *(boolean) --* 

              The flag to indicate Dataview should be updated automatically.

              
            

            - **createTime** *(integer) --* 

              The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

              
            

            - **lastModifiedTime** *(integer) --* 

              The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

              
        
      
        

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

          A token to resume pagination.

          
    