UpdateSMBLocalGroups

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

Request Syntax


{
   "GatewayARN": "string",
   "SMBLocalGroups": { 
      "GatewayAdmins": [ "string" ]
   }
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

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

Required: Yes

A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.

Required: Yes


{
   "GatewayARN": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

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

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.

error: A StorageGatewayError that provides more information about the cause of the error.
message: A human-readable message describing the error that occurred.

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.

error: A StorageGatewayError that provides more detail about the cause of the error.
message: A human-readable message describing the error that occurred.

HTTP Status Code: 400