DescribeSMBFileShares
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 File Gateways.
Request Syntax
{
"FileShareARNList": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
-
An array containing the Amazon Resource Name (ARN) of each file share to be described.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
Response Syntax
{
"SMBFileShareInfoList": [
{
"AccessBasedEnumeration": boolean,
"AdminUserList": [ "string" ],
"AuditDestinationARN": "string",
"Authentication": "string",
"BucketRegion": "string",
"CacheAttributes": {
"CacheStaleTimeoutInSeconds": number
},
"CaseSensitivity": "string",
"DefaultStorageClass": "string",
"EncryptionType": "string",
"FileShareARN": "string",
"FileShareId": "string",
"FileShareName": "string",
"FileShareStatus": "string",
"GatewayARN": "string",
"GuessMIMETypeEnabled": boolean,
"InvalidUserList": [ "string" ],
"KMSEncrypted": boolean,
"KMSKey": "string",
"LocationARN": "string",
"NotificationPolicy": "string",
"ObjectACL": "string",
"OplocksEnabled": boolean,
"Path": "string",
"ReadOnly": boolean,
"RequesterPays": boolean,
"Role": "string",
"SMBACLEnabled": boolean,
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"ValidUserList": [ "string" ],
"VPCEndpointDNSName": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
-
An array containing a description for each requested file share.
Type: Array of SMBFileShareInfo objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
Examples
Describe an SMB file share
In the following request, you get the description for a single SMB file share identified by its Amazon Resource Name (ARN).
Sample Request
{
"FileShareARNList": [
"arn:aws:storagegateway:us-east-2:204469490176:share/share-XXXXXX"
]
} Sample Response
{
"SMBFileShareInfoList": [
{
"Authentication": "ActiveDirectory",
"DefaultStorageClass": "S3_INTELLIGENT_TIERING",
"FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX",
"FileShareId": "share-XXXXXXXX",
"FileShareStatus": "AVAILABLE",
"GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-YYYYYYYY",
"GuessMIMETypeEnabled": "true",
"InvalidUserList": [
"user1",
"user2"
],
"KMSEncrypted": "false",
"LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket",
"ObjectACL": "bucket-owner-full-control",
"Path": "/my-path-alpha",
"ReadOnly": "false",
"RequesterPays": "false",
"Role": "arn:aws:iam::111122223333:role/my-role",
"ValidUserList": [
"user3",
"user4"
]
}
]
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
