Gets a description of a Server Message Block (SMB) file share settings from a file gateway¶

Description¶

Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

Usage¶

storagegateway_describe_smb_settings(GatewayARN)

Arguments¶

GatewayARN

[required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

Value¶

A list with the following syntax:

list(
  GatewayARN = "string",
  DomainName = "string",
  ActiveDirectoryStatus = "ACCESS_DENIED"|"DETACHED"|"JOINED"|"JOINING"|"NETWORK_ERROR"|"TIMEOUT"|"UNKNOWN_ERROR"|"INSUFFICIENT_PERMISSIONS",
  SMBGuestPasswordSet = TRUE|FALSE,
  SMBSecurityStrategy = "ClientSpecified"|"MandatorySigning"|"MandatoryEncryption"|"MandatoryEncryptionNoAes128",
  FileSharesVisible = TRUE|FALSE,
  SMBLocalGroups = list(
    GatewayAdmins = list(
      "string"
    )
  )
)

Request syntax¶

svc$describe_smb_settings(
  GatewayARN = "string"
)