Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datasync ]

describe-location-smb

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-location-smb
--location-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--location-arn (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

LocationArn -> (string)

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

LocationUri -> (string)

The URL of the source SBM 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 -> (structure)

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

Version -> (string)

The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC . That is, DataSync automatically selects a version based on negotiation with the SMB server.

CreationTime -> (timestamp)

The time that the SMB location was created.