Table Of Contents


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 . storagegateway ]



Gets a description for one or more Network File System (NFS) 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.


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


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

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


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


NFSFileShareInfoList -> (list)

An array containing a description for each requested file share.


The Unix 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 in file gateways.

NFSFileShareDefaults -> (structure)

Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.

FileMode -> (string)

The Unix file mode in the form "nnnn". For example, "0666" represents the default file mode inside the file share. The default value is 0666.

DirectoryMode -> (string)

The Unix directory mode in the form "nnnn". For example, "0666" represents the default access mode for all directories inside the file share. The default value is 0777.

GroupId -> (long)

The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

OwnerId -> (long)

The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

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 AWS 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 NFS 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".

ClientList -> (list)

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.


Squash -> (string)

The user mapped to anonymous user. Valid options are the following:

  • RootSquash - Only root is mapped to anonymous user.
  • NoSquash - No one is mapped to anonymous user
  • AllSquash - Everyone is mapped to anonymous user.

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


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.

Tags -> (list)

A list of up to 50 tags assigned to the NFS 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.


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 (String). The key can't start with aws:.

Value -> (string)

Value of the tag key.