:doc:`StorageGateway <../../storagegateway>` / Client / list_file_system_associations

*****************************
list_file_system_associations
*****************************



.. py:method:: StorageGateway.Client.list_file_system_associations(**kwargs)

  

  Gets a list of ``FileSystemAssociationSummary`` objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileSystemAssociations>`_  


  **Request Syntax**
  ::

    response = client.list_file_system_associations(
        GatewayARN='string',
        Limit=123,
        Marker='string'
    )
    
  :type GatewayARN: string
  :param GatewayARN: 

    The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of file system associations to return in the response. If present, ``Limit`` must be an integer with a value greater than zero. Optional.

    

  
  :type Marker: string
  :param Marker: 

    Opaque pagination token returned from a previous ``ListFileSystemAssociations`` operation. If present, ``Marker`` specifies where to continue the list from after a previous call to ``ListFileSystemAssociations``. Optional.

    

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

    
    ::

      {
          'Marker': 'string',
          'NextMarker': 'string',
          'FileSystemAssociationSummaryList': [
              {
                  'FileSystemAssociationId': 'string',
                  'FileSystemAssociationARN': 'string',
                  'FileSystemAssociationStatus': 'string',
                  'GatewayARN': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        If the request includes ``Marker``, the response returns that value in this field.

        
      

      - **NextMarker** *(string) --* 

        If a value is present, there are more file system associations to return. In a subsequent request, use ``NextMarker`` as the value for ``Marker`` to retrieve the next set of file system associations.

        
      

      - **FileSystemAssociationSummaryList** *(list) --* 

        An array of information about the Amazon FSx gateway's file system associations.

        
        

        - *(dict) --* 

          Gets the summary returned by ``ListFileSystemAssociation``, which is a summary of a created file system association.

          
          

          - **FileSystemAssociationId** *(string) --* 

            The ID of the file system association.

            
          

          - **FileSystemAssociationARN** *(string) --* 

            The Amazon Resource Name (ARN) of the file system association.

            
          

          - **FileSystemAssociationStatus** *(string) --* 

            The status of the file share. Valid Values: ``AVAILABLE`` | ``CREATING`` | ``DELETING`` | ``FORCE_DELETING`` | ``UPDATING`` | ``ERROR``

            
          

          - **GatewayARN** *(string) --* 

            The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  