Describe Smb File Shares

storagegateway_describe_smb_file_shares

R Documentation

Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway

Description

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.

Usage

storagegateway_describe_smb_file_shares(FileShareARNList)

Arguments

FileShareARNList

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

Value

A list with the following syntax:

list(
  SMBFileShareInfoList = list(
    list(
      FileShareARN = "string",
      FileShareId = "string",
      FileShareStatus = "string",
      GatewayARN = "string",
      KMSEncrypted = TRUE|FALSE,
      KMSKey = "string",
      Path = "string",
      Role = "string",
      LocationARN = "string",
      DefaultStorageClass = "string",
      ObjectACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"aws-exec-read",
      ReadOnly = TRUE|FALSE,
      GuessMIMETypeEnabled = TRUE|FALSE,
      RequesterPays = TRUE|FALSE,
      SMBACLEnabled = TRUE|FALSE,
      AccessBasedEnumeration = TRUE|FALSE,
      AdminUserList = list(
        "string"
      ),
      ValidUserList = list(
        "string"
      ),
      InvalidUserList = list(
        "string"
      ),
      AuditDestinationARN = "string",
      Authentication = "string",
      CaseSensitivity = "ClientSpecified"|"CaseSensitive",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      FileShareName = "string",
      CacheAttributes = list(
        CacheStaleTimeoutInSeconds = 123
      ),
      NotificationPolicy = "string",
      VPCEndpointDNSName = "string",
      BucketRegion = "string",
      OplocksEnabled = TRUE|FALSE
    )
  )
)

Request syntax

svc$describe_smb_file_shares(
  FileShareARNList = list(
    "string"
  )
)