storagegateway_describe_smb_file_shares: Gets a description for one or more Server Message Block (SMB)...

Description Usage Arguments Value Request syntax

View source: R/storagegateway_operations.R

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.

Usage

1

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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"
    )
  )
)

Request syntax

1
2
3
4
5
svc$describe_smb_file_shares(
  FileShareARNList = list(
    "string"
  )
)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.