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.

Synopsis¶

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

Options¶

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

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

(string)

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

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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.

Valid Values: CREATING | UPDATING | AVAILABLE | 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 AWS Region.

KMSEncrypted -> (boolean)

Set to 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.

Valid Values: true | false

KMSKey -> (string)

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. 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. A prefix name can be added to the S3 bucket name. It must end with a “/”.

DefaultStorageClass -> (string)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

ObjectACL -> (string)

A value that sets the access control list (ACL) 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. Set this value to true to set the write status to read-only, otherwise set to false .

Valid Values: true | 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, otherwise set to false . The default value is true .

Valid Values: true | false

RequesterPays -> (boolean)

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

Note

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

SMBACLEnabled -> (boolean)

If this value is set to true , it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false , it indicates that file and directory permissions are mapped to the POSIX permission.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide .

AdminUserList -> (list)

A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .

(string)

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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .

(string)

AuditDestinationARN -> (string)

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Authentication -> (string)

The authentication method of the file share. The default is ActiveDirectory .

Valid Values: ActiveDirectory | GuestAccess

CaseSensitivity -> (string)

The case of an object name in an Amazon S3 bucket. For ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .

Tags -> (list)

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

(structure)

A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

Key -> (string)

Tag key. The key can’t start with aws:.

Value -> (string)

Value of the tag key.

FileShareName -> (string)

The name of the file share. Optional.

Note

FileShareName must be set if an S3 prefix name is set in LocationARN .

CacheAttributes -> (structure)

Refresh cache information.

CacheStaleTimeoutInSeconds -> (integer)

Refreshes a file share’s cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory’s contents from the Amazon S3 bucket. The TTL duration is in seconds.

Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)

Table of Contents

Feedback

User Guide