Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DeleteFileShare

Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.

Request Syntax


{
   "FileShareARN": "string",
   "ForceDelete": boolean
}

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.

FileShareARN

The Amazon Resource Name (ARN) of the file share to be deleted.

Type: String

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

Required: Yes

ForceDelete

If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

Valid Values: true | false

Type: Boolean

Required: No

Response Syntax


{
   "FileShareARN": "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.

FileShareARN

The Amazon Resource Name (ARN) of the deleted file share.

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

Examples

Delete a file share

In the following request, you delete a file share from a S3 File Gateway.

Sample Request


{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX"
}

Sample Response


{
    "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXXX"
}