SetSMBGuestPassword
Sets the password for the guest user smbguest. The smbguest
user is the user when the authentication method for the file share is set to
GuestAccess. This operation only supported for S3 File Gateways
Request Syntax
{
"GatewayARN": "string",
"Password": "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 S3 File Gateway the SMB file share is associated with.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: Yes
- Password
-
The password that you want to set for your SMB server.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 512.
Pattern:
^[ -~]+$Required: Yes
Response Syntax
{
"GatewayARN": "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.
- GatewayARN
-
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.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
