Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeSMBSettings

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

Request Syntax


{
   "GatewayARN": "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.

GatewayARN

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.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

Response Syntax


{
   "ActiveDirectoryStatus": "string",
   "DomainName": "string",
   "FileSharesVisible": boolean,
   "GatewayARN": "string",
   "SMBGuestPasswordSet": boolean,
   "SMBLocalGroups": { 
      "GatewayAdmins": [ "string" ]
   },
   "SMBSecurityStrategy": "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.

ActiveDirectoryStatus

Indicates the status of a gateway that is a member of the Active Directory domain.

ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.
DETACHED: Indicates that gateway is not joined to a domain.
JOINED: Indicates that the gateway has successfully joined a domain.
JOINING: Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.
TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

Type: String

DomainName

The name of the domain that the gateway is joined to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$

FileSharesVisible

The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

Type: Boolean

GatewayARN

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.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

SMBGuestPasswordSet

This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

Valid Values: true | false

Type: Boolean

SMBLocalGroups

A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

Type: SMBLocalGroups object

SMBSecurityStrategy

The type of security strategy that was specified for file gateway.

ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.
MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

Type: String

Valid Values: ClientSpecified | MandatorySigning | MandatoryEncryption

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