:doc:`QuickSight <../../quicksight>` / Paginator / ListDataSets

************
ListDataSets
************



.. py:class:: QuickSight.Paginator.ListDataSets

  ::

    
    paginator = client.get_paginator('list_data_sets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`QuickSight.Client.list_data_sets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSets>`_    


    **Request Syntax**
    ::

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

      The Amazon Web Services account ID.

      

    
    :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**

      
      ::

        {
            'DataSetSummaries': [
                {
                    'Arn': 'string',
                    'DataSetId': 'string',
                    'Name': 'string',
                    'CreatedTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'ImportMode': 'SPICE'|'DIRECT_QUERY',
                    'RowLevelPermissionDataSet': {
                        'Namespace': 'string',
                        'Arn': 'string',
                        'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
                        'FormatVersion': 'VERSION_1'|'VERSION_2',
                        'Status': 'ENABLED'|'DISABLED'
                    },
                    'RowLevelPermissionDataSetMap': {
                        'string': {
                            'Namespace': 'string',
                            'Arn': 'string',
                            'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
                            'FormatVersion': 'VERSION_1'|'VERSION_2',
                            'Status': 'ENABLED'|'DISABLED'
                        }
                    },
                    'RowLevelPermissionTagConfigurationApplied': True|False,
                    'ColumnLevelPermissionRulesApplied': True|False,
                    'UseAs': 'RLS_RULES'
                },
            ],
            'RequestId': 'string',
            'Status': 123
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **DataSetSummaries** *(list) --* 

          The list of dataset summaries.

          
          

          - *(dict) --* 

            Dataset summary.

            
            

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

              The Amazon Resource Name (ARN) of the dataset.

              
            

            - **DataSetId** *(string) --* 

              The ID of the dataset.

              
            

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

              A display name for the dataset.

              
            

            - **CreatedTime** *(datetime) --* 

              The time that this dataset was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The last time that this dataset was updated.

              
            

            - **ImportMode** *(string) --* 

              A value that indicates whether you want to import the data into SPICE.

              
            

            - **RowLevelPermissionDataSet** *(dict) --* 

              The row-level security configuration for the dataset in the legacy data preparation experience.

              
              

              - **Namespace** *(string) --* 

                The namespace associated with the dataset that contains permissions for RLS.

                
              

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

                The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

                
              

              - **PermissionPolicy** *(string) --* 

                The type of permissions to use when interpreting the permissions for RLS. ``DENY_ACCESS`` is included for backward compatibility only.

                
              

              - **FormatVersion** *(string) --* 

                The user or group rules associated with the dataset that contains permissions for RLS.

                 

                By default, ``FormatVersion`` is ``VERSION_1``. When ``FormatVersion`` is ``VERSION_1``, ``UserName`` and ``GroupName`` are required. When ``FormatVersion`` is ``VERSION_2``, ``UserARN`` and ``GroupARN`` are required, and ``Namespace`` must not exist.

                
              

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

                The status of the row-level security permission dataset. If enabled, the status is ``ENABLED``. If disabled, the status is ``DISABLED``.

                
          
            

            - **RowLevelPermissionDataSetMap** *(dict) --* 

              The row-level security configuration for the dataset in the new data preparation experience.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see `Using Row-Level Security (RLS) to Restrict Access to a Dataset <https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html>`__ in the *Quick Sight User Guide*.

                   

                  The option to deny permissions by setting ``PermissionPolicy`` to ``DENY_ACCESS`` is not supported for new RLS datasets.

                  
                  

                  - **Namespace** *(string) --* 

                    The namespace associated with the dataset that contains permissions for RLS.

                    
                  

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

                    The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

                    
                  

                  - **PermissionPolicy** *(string) --* 

                    The type of permissions to use when interpreting the permissions for RLS. ``DENY_ACCESS`` is included for backward compatibility only.

                    
                  

                  - **FormatVersion** *(string) --* 

                    The user or group rules associated with the dataset that contains permissions for RLS.

                     

                    By default, ``FormatVersion`` is ``VERSION_1``. When ``FormatVersion`` is ``VERSION_1``, ``UserName`` and ``GroupName`` are required. When ``FormatVersion`` is ``VERSION_2``, ``UserARN`` and ``GroupARN`` are required, and ``Namespace`` must not exist.

                    
                  

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

                    The status of the row-level security permission dataset. If enabled, the status is ``ENABLED``. If disabled, the status is ``DISABLED``.

                    
              
          
        
            

            - **RowLevelPermissionTagConfigurationApplied** *(boolean) --* 

              Whether or not the row level permission tags are applied.

              
            

            - **ColumnLevelPermissionRulesApplied** *(boolean) --* 

              A value that indicates if the dataset has column level permission configured.

              
            

            - **UseAs** *(string) --* 

              The usage of the dataset.

              
        
      
        

        - **RequestId** *(string) --* 

          The Amazon Web Services request ID for this operation.

          
        

        - **Status** *(integer) --* 

          The HTTP status of the request.

          
    