AWS Storage Gateway

{'ForceDelete': 'boolean'}

Deletes a file share from a file gateway. This operation is only supported in the file gateway architecture.

See also: AWS API Documentation

Request Syntax

client.delete_file_share(
    FileShareARN='string',
    ForceDelete=True|False
)

type FileShareARN

string

param FileShareARN

[REQUIRED]

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

type ForceDelete

boolean

param ForceDelete

If set to true, 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.

rtype

dict

returns

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

• (dict) --

  DeleteFileShareOutput

  • FileShareARN (string) --

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