:doc:`DataSync <../../datasync>` / Client / describe_location_efs

*********************
describe_location_efs
*********************



.. py:method:: DataSync.Client.describe_location_efs(**kwargs)

  

  Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfs>`_  


  **Request Syntax**
  ::

    response = client.describe_location_efs(
        LocationArn='string'
    )
    
  :type LocationArn: string
  :param LocationArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.

    

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

    
    ::

      {
          'LocationArn': 'string',
          'LocationUri': 'string',
          'Ec2Config': {
              'SubnetArn': 'string',
              'SecurityGroupArns': [
                  'string',
              ]
          },
          'CreationTime': datetime(2015, 1, 1),
          'AccessPointArn': 'string',
          'FileSystemAccessRoleArn': 'string',
          'InTransitEncryption': 'NONE'|'TLS1_2'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      DescribeLocationEfsResponse

      
      

      - **LocationArn** *(string) --* 

        The ARN of the Amazon EFS file system location.

        
      

      - **LocationUri** *(string) --* 

        The URL of the Amazon EFS file system location.

        
      

      - **Ec2Config** *(dict) --* 

        The subnet and security groups that DataSync uses to connect to one of your Amazon EFS file system's `mount targets <https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html>`__.

        
        

        - **SubnetArn** *(string) --* 

          Specifies the ARN of a subnet where DataSync creates the `network interfaces <https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces>`__ for managing traffic during your transfer.

           

          The subnet must be located:

           

          
          * In the same virtual private cloud (VPC) as the Amazon EFS file system.
           
          * In the same Availability Zone as at least one mount target for the Amazon EFS file system.
          

           

          .. note::

            

            You don't need to specify a subnet that includes a file system mount target.

            

          
        

        - **SecurityGroupArns** *(list) --* 

          Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

          
          

          - *(string) --* 
      
    
      

      - **CreationTime** *(datetime) --* 

        The time that the location was created.

        
      

      - **AccessPointArn** *(string) --* 

        The ARN of the access point that DataSync uses to access the Amazon EFS file system.

         

        For more information, see `Accessing restricted file systems <https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam>`__.

        
      

      - **FileSystemAccessRoleArn** *(string) --* 

        The Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

         

        For more information, see `Creating a DataSync IAM role for file system access <https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role>`__.

        
      

      - **InTransitEncryption** *(string) --* 

        Indicates whether DataSync uses Transport Layer Security (TLS) encryption when transferring data to or from the Amazon EFS file system.

        
  
  **Exceptions**
  
  *   :py:class:`DataSync.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`DataSync.Client.exceptions.InternalException`

  