How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares API

The #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares API from Amazon Storage Gateway — 1 operation(s) for #x amz target=storagegateway 20130630.describenfsfileshares.

Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares API is one of 95 APIs that Amazon Storage Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 1 operation across 1 path, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 2013-06-30.

Requests are made against 4 base URLs: http://storagegateway.{region}.amazonaws.com, https://storagegateway.{region}.amazonaws.com, http://storagegateway.{region}.amazonaws.com.cn, https://storagegateway.{region}.amazonaws.com.cn.

1 operations 1 paths 36 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2013-06-30
Base URL
https://storagegateway.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

#X Amz Target=StorageGateway 20130630.DescribeNFSFileShares 1
POST
/#X-Amz-Target=StorageGateway_20130630.DescribeNFSFileShares
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 File Gateways.
DescribeNFSFileShares 8 params body → 200480481

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are NFSFileShareInfo (24 properties), NFSFileShareDefaults (4 properties), Tag (2 properties), DescribeNFSFileSharesInput (1 property). Each schema is shown below with its type and property counts.

InternalServerError
IPV4AddressCIDR
string
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 anonymou…
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…
CacheAttributes
object
The refresh cache information for the file share or FSx file systems.
1 property
FileShareStatus
string
The status of the file share. Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
ObjectACL
string
A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private…
AuditDestinationARN
string
boolean
boolean
PermissionMode
string
DescribeNFSFileSharesOutput
object
DescribeNFSFileSharesOutput
1 property
Path
string
The file share path used by the NFS client to identify the mount point.
DNSHostName
string
FileShareId
string
The ID of the file share.
PermissionId
integer
NFSFileShareDefaults
object
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 pe…
4 properties
InvalidGatewayRequestException
StorageClass
string
DescribeNFSFileSharesInput
object
DescribeNFSFileSharesInput
1 property 1 required
TagValue
string
TagKey
string
FileShareARNList
array
FileShareName
string
GatewayARN
string
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
NFSFileShareInfoList
array
Boolean
boolean
Role
string
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
NFSFileShareInfo
object
The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This opera…
24 properties
Tags
array
Tag
object
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, an…
2 properties 2 required
RegionId
string
FileShareARN
string
The Amazon Resource Name (ARN) of the file share.
LocationARN
string
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must e…
NotificationPolicy
string
CacheStaleTimeoutInSeconds
integer
FileShareClientList
array
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-storage-gateway-x-amz-target-storagegateway-20130630-describenfsfileshares-api-openapi.yml Raw ↑

Other APIs Amazon Storage Gateway publishes across the network.

Amazon Storage Gateway Amazon Storage Gateway REST API API
Amazon Storage Gateway #CreateNFSFileShare API
Amazon Storage Gateway #DescribeGatewayInformation API
Amazon Storage Gateway #ListGateways API
Amazon Storage Gateway #ListVolumes API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.ActivateGateway API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AddCache API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AddTagsToResource API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AddUploadBuffer API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AddWorkingStorage API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AssignTapePool API
Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.AssociateFileSystem API
Where this information came from

This is an independent, third-party profile of Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.DescribeNFSFileShares API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.