StorageGateway / Client / delete_file_share

delete_file_share#

StorageGateway.Client.delete_file_share(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • FileShareARN (string) –

    [REQUIRED]

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

  • ForceDelete (boolean) –

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

    Valid Values: true | false

Return type:

dict

Returns:

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

  • (dict) –

    DeleteFileShareOutput

    • FileShareARN (string) –

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

Exceptions