:doc:`DataExchange <../../dataexchange>` / Paginator / ListDataSets

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



.. py:class:: DataExchange.Paginator.ListDataSets

  ::

    
    paginator = client.get_paginator('list_data_sets')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/dataexchange-2017-07-25/ListDataSets>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Origin='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Origin: string
    :param Origin: 

      A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

      

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

      
      ::

        {
            'DataSets': [
                {
                    'Arn': 'string',
                    'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API'|'S3_DATA_ACCESS'|'LAKE_FORMATION_DATA_PERMISSION',
                    'CreatedAt': datetime(2015, 1, 1),
                    'Description': 'string',
                    'Id': 'string',
                    'Name': 'string',
                    'Origin': 'OWNED'|'ENTITLED',
                    'OriginDetails': {
                        'ProductId': 'string',
                        'DataGrantId': 'string'
                    },
                    'SourceId': 'string',
                    'UpdatedAt': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **DataSets** *(list) --* 

          The data set objects listed by the request.

          
          

          - *(dict) --* 

            A data set is an AWS resource with one or more revisions.

            
            

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

              The ARN for the data set.

              
            

            - **AssetType** *(string) --* 

              The type of asset that is added to a data set.

              
            

            - **CreatedAt** *(datetime) --* 

              The date and time that the data set was created, in ISO 8601 format.

              
            

            - **Description** *(string) --* 

              The description for the data set.

              
            

            - **Id** *(string) --* 

              The unique identifier for the data set.

              
            

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

              The name of the data set.

              
            

            - **Origin** *(string) --* 

              A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

              
            

            - **OriginDetails** *(dict) --* 

              If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

              
              

              - **ProductId** *(string) --* 

                The product ID of the origin of the data set.

                
              

              - **DataGrantId** *(string) --* 

                The ID of the data grant.

                
          
            

            - **SourceId** *(string) --* 

              The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

              
            

            - **UpdatedAt** *(datetime) --* 

              The date and time that the data set was last updated, in ISO 8601 format.

              
        
      
    