Table Of Contents

Feedback

User Guide

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

[ aws . storagegateway ]

describe-smb-file-shares

Description

Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-smb-file-shares
--file-share-arn-list <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--file-share-arn-list (list)

An array containing the Amazon Resource Name (ARN) of each file share to be described.

Syntax:

"string" "string" ...

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

SMBFileShareInfoList -> (list)

An array containing a description for each requested file share.

(structure)

The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

FileShareARN -> (string)

The Amazon Resource Name (ARN) of the file share.

FileShareId -> (string)

The ID of the file share.

FileShareStatus -> (string)

The status of the file share. Possible values are CREATING , UPDATING , AVAILABLE and DELETING .

GatewayARN -> (string)

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

KMSEncrypted -> (boolean)

True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

KMSKey -> (string)

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Path -> (string)

The file share path used by the SMB client to identify the mount point.

Role -> (string)

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

LocationARN -> (string)

The ARN of the backend storage used for storing file data.

DefaultStorageClass -> (string)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD , S3_STANDARD_IA , or S3_ONEZONE_IA . If this field is not populated, the default value S3_STANDARD is used. Optional.

ObjectACL -> (string)

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

ReadOnly -> (boolean)

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

GuessMIMETypeEnabled -> (boolean)

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

RequesterPays -> (boolean)

A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private .

ValidUserList -> (list)

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1 . Can only be set if Authentication is set to ActiveDirectory .

(string)

InvalidUserList -> (list)

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1 . Can only be set if Authentication is set to ActiveDirectory .

(string)

Authentication -> (string)

The authentication method of the file share.

Valid values are ActiveDirectory or GuestAccess . The default is ActiveDirectory .