describe_location_smb

DataSync.Client.describe_location_smb(**kwargs)

Returns metadata, such as the path and user information about an SMB location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_smb(
    LocationArn='string'
)

Parameters

LocationArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the SMB location to describe.

Return type

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)
}

Response Structure

• (dict) --

  DescribeLocationSmbResponse

  • LocationArn (string) --

    The Amazon Resource Name (ARN) of the SMB location that was described.

  • LocationUri (string) --

    The URL of the source SMB location that was described.

  • AgentArns (list) --

    The Amazon Resource Name (ARN) of the source SMB file system location that is created.

    • (string) --
  • User (string) --

    The user who can mount the share, has the permissions to access files and folders in the SMB share.

  • Domain (string) --

    The name of the Windows domain that the SMB server belongs to.

  • MountOptions (dict) --

    The mount options that are available for DataSync to use to access an SMB location.

    • 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 a protocol version that they mutually support. (DataSync supports SMB versions 1.0 and later.) 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.

  • CreationTime (datetime) --

    The time that the SMB location was created.

Exceptions

• DataSync.Client.exceptions.InvalidRequestException
• DataSync.Client.exceptions.InternalException