set_smb_guest_password

set_smb_guest_password(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.set_smb_guest_password(
    GatewayARN='string',
    Password='string'
)
Parameters
  • GatewayARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file share is associated with.

  • Password (string) --

    [REQUIRED]

    The password that you want to set for your SMB server.

Return type

dict

Returns

Response Syntax

{
    'GatewayARN': 'string'
}

Response Structure

  • (dict) --

    • GatewayARN (string) --

      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.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException
  • StorageGateway.Client.exceptions.InternalServerError