POST

/#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare

http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways. <note> To leave a file share field unchanged, set the corresponding input field to null. </note> <important> File gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your file gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the Identity and Access Management User Guide. File gateways don't support creating hard or symbolic links on a file share. </important>

Access Token Required: API Key

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://storagegateway.{region}.amazonaws.com/#X-Amz-Target=StorageGateway_20130630.UpdateSMBFileShare' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}