- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateSMBLocalGroupsCommand
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { StorageGatewayClient, UpdateSMBLocalGroupsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import
// const { StorageGatewayClient, UpdateSMBLocalGroupsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import
const client = new StorageGatewayClient(config);
const input = { // UpdateSMBLocalGroupsInput
GatewayARN: "STRING_VALUE", // required
SMBLocalGroups: { // SMBLocalGroups
GatewayAdmins: [ // UserList
"STRING_VALUE",
],
},
};
const command = new UpdateSMBLocalGroupsCommand(input);
const response = await client.send(command);
// { // UpdateSMBLocalGroupsOutput
// GatewayARN: "STRING_VALUE",
// };
UpdateSMBLocalGroupsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
GatewayARN Required | string | undefined | 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. |
SMBLocalGroups Required | SMBLocalGroups | undefined | A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway. |
UpdateSMBLocalGroupsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
GatewayARN | string | undefined | 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. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServerError | server | An internal server error has occurred during the request. For more information, see the error and message fields. |
InvalidGatewayRequestException | client | An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields. |
StorageGatewayServiceException | Base exception class for all service exceptions from StorageGateway service. |