:doc:`DeadlineCloud <../../deadline>` / Paginator / ListStorageProfiles

*******************
ListStorageProfiles
*******************



.. py:class:: DeadlineCloud.Paginator.ListStorageProfiles

  ::

    
    paginator = client.get_paginator('list_storage_profiles')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DeadlineCloud.Client.list_storage_profiles`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/deadline-2023-10-12/ListStorageProfiles>`_    


    **Request Syntax**
    ::

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

      The farm ID of the storage profile.

      

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

      
      ::

        {
            'storageProfiles': [
                {
                    'storageProfileId': 'string',
                    'displayName': 'string',
                    'osFamily': 'WINDOWS'|'LINUX'|'MACOS'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **storageProfiles** *(list) --* 

          The storage profiles.

          
          

          - *(dict) --* 

            The details of a storage profile.

            
            

            - **storageProfileId** *(string) --* 

              The storage profile ID.

              
            

            - **displayName** *(string) --* 

              The display name of the storage profile summary to update.

               

              .. warning::

                 

                This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

                

              
            

            - **osFamily** *(string) --* 

              The operating system (OS) family.

              
        
      
        

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

          A token to resume pagination.

          
    