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

*********************
describe_location_smb
*********************



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

  

  Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

  

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


  **Request Syntax**
  ::

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

    Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

    

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

    
    ::

      {
          'LocationArn': 'string',
          'LocationUri': 'string',
          'AgentArns': [
              'string',
          ],
          'User': 'string',
          'Domain': 'string',
          'MountOptions': {
              'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
          },
          'CreationTime': datetime(2015, 1, 1),
          'DnsIpAddresses': [
              'string',
          ],
          'KerberosPrincipal': 'string',
          'AuthenticationType': 'NTLM'|'KERBEROS',
          'ManagedSecretConfig': {
              'SecretArn': 'string'
          },
          'CmkSecretConfig': {
              'SecretArn': 'string',
              'KmsKeyArn': 'string'
          },
          'CustomSecretConfig': {
              'SecretArn': 'string',
              'SecretAccessRoleArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      DescribeLocationSmbResponse

      
      

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

        The ARN of the SMB location.

        
      

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

        The URI of the SMB location.

        
      

      - **AgentArns** *(list) --* 

        The ARNs of the DataSync agents that can connect with your SMB file server.

        
        

        - *(string) --* 
    
      

      - **User** *(string) --* 

        The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if ``AuthenticationType`` is set to ``NTLM``.

        
      

      - **Domain** *(string) --* 

        The name of the Windows domain that the SMB file server belongs to. This element applies only if ``AuthenticationType`` is set to ``NTLM``.

        
      

      - **MountOptions** *(dict) --* 

        The SMB protocol version that DataSync uses to access your SMB file server.

        
        

        - **Version** *(string) --* 

          By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

           

          These are the following options for configuring the SMB version:

           

          
          * ``AUTOMATIC`` (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an ``Operation Not Supported`` error.
           
          * ``SMB3``: Restricts the protocol negotiation to only SMB version 3.0.2.
           
          * ``SMB2``: Restricts the protocol negotiation to only SMB version 2.1.
           
          * ``SMB2_0``: Restricts the protocol negotiation to only SMB version 2.0.
           
          * ``SMB1``: Restricts the protocol negotiation to only SMB version 1.0. 

          .. note::

            The ``SMB1`` option isn't available when `creating an Amazon FSx for NetApp ONTAP location <https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html>`__.

          
          

          
    
      

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

        The time that the SMB location was created.

        
      

      - **DnsIpAddresses** *(list) --* 

        The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if ``AuthenticationType`` is set to ``KERBEROS``.

        
        

        - *(string) --* 
    
      

      - **KerberosPrincipal** *(string) --* 

        The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.

        
      

      - **AuthenticationType** *(string) --* 

        The authentication protocol that DataSync uses to connect to your SMB file server.

        
      

      - **ManagedSecretConfig** *(dict) --* 

        Describes configuration information for a DataSync-managed secret, such as a ``Password`` or ``KerberosKeytab`` that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

        
        

        - **SecretArn** *(string) --* 

          Specifies the ARN for an Secrets Manager secret.

          
    
      

      - **CmkSecretConfig** *(dict) --* 

        Describes configuration information for a DataSync-managed secret, such as a ``Password`` or ``KerberosKeytab`` that DataSync uses to access a specific storage location, with a customer-managed KMS key.

        
        

        - **SecretArn** *(string) --* 

          Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn``.

          
        

        - **KmsKeyArn** *(string) --* 

          Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for ``SecretArn``. DataSync provides this key to Secrets Manager.

          
    
      

      - **CustomSecretConfig** *(dict) --* 

        Describes configuration information for a customer-managed secret, such as a ``Password`` or ``KerberosKeytab`` that DataSync uses to access a specific storage location, with a customer-managed KMS key.

        
        

        - **SecretArn** *(string) --* 

          Specifies the ARN for an Secrets Manager secret.

          
        

        - **SecretAccessRoleArn** *(string) --* 

          Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for ``SecretArn``.

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

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

  