{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.StorageGateway.DeleteFileShare -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Deletes a file share from an S3 File Gateway. This operation is only -- supported for S3 File Gateways. module Amazonka.StorageGateway.DeleteFileShare ( -- * Creating a Request DeleteFileShare (..), newDeleteFileShare, -- * Request Lenses deleteFileShare_forceDelete, deleteFileShare_fileShareARN, -- * Destructuring the Response DeleteFileShareResponse (..), newDeleteFileShareResponse, -- * Response Lenses deleteFileShareResponse_fileShareARN, deleteFileShareResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.StorageGateway.Types -- | DeleteFileShareInput -- -- /See:/ 'newDeleteFileShare' smart constructor. data DeleteFileShare = DeleteFileShare' { -- | 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@ forceDelete :: Prelude.Maybe Prelude.Bool, -- | The Amazon Resource Name (ARN) of the file share to be deleted. fileShareARN :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteFileShare' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'forceDelete', 'deleteFileShare_forceDelete' - 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@ -- -- 'fileShareARN', 'deleteFileShare_fileShareARN' - The Amazon Resource Name (ARN) of the file share to be deleted. newDeleteFileShare :: -- | 'fileShareARN' Prelude.Text -> DeleteFileShare newDeleteFileShare pFileShareARN_ = DeleteFileShare' { forceDelete = Prelude.Nothing, fileShareARN = pFileShareARN_ } -- | 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@ deleteFileShare_forceDelete :: Lens.Lens' DeleteFileShare (Prelude.Maybe Prelude.Bool) deleteFileShare_forceDelete = Lens.lens (\DeleteFileShare' {forceDelete} -> forceDelete) (\s@DeleteFileShare' {} a -> s {forceDelete = a} :: DeleteFileShare) -- | The Amazon Resource Name (ARN) of the file share to be deleted. deleteFileShare_fileShareARN :: Lens.Lens' DeleteFileShare Prelude.Text deleteFileShare_fileShareARN = Lens.lens (\DeleteFileShare' {fileShareARN} -> fileShareARN) (\s@DeleteFileShare' {} a -> s {fileShareARN = a} :: DeleteFileShare) instance Core.AWSRequest DeleteFileShare where type AWSResponse DeleteFileShare = DeleteFileShareResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DeleteFileShareResponse' Prelude.<$> (x Data..?> "FileShareARN") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DeleteFileShare where hashWithSalt _salt DeleteFileShare' {..} = _salt `Prelude.hashWithSalt` forceDelete `Prelude.hashWithSalt` fileShareARN instance Prelude.NFData DeleteFileShare where rnf DeleteFileShare' {..} = Prelude.rnf forceDelete `Prelude.seq` Prelude.rnf fileShareARN instance Data.ToHeaders DeleteFileShare where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "StorageGateway_20130630.DeleteFileShare" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DeleteFileShare where toJSON DeleteFileShare' {..} = Data.object ( Prelude.catMaybes [ ("ForceDelete" Data..=) Prelude.<$> forceDelete, Prelude.Just ("FileShareARN" Data..= fileShareARN) ] ) instance Data.ToPath DeleteFileShare where toPath = Prelude.const "/" instance Data.ToQuery DeleteFileShare where toQuery = Prelude.const Prelude.mempty -- | DeleteFileShareOutput -- -- /See:/ 'newDeleteFileShareResponse' smart constructor. data DeleteFileShareResponse = DeleteFileShareResponse' { -- | The Amazon Resource Name (ARN) of the deleted file share. fileShareARN :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteFileShareResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'fileShareARN', 'deleteFileShareResponse_fileShareARN' - The Amazon Resource Name (ARN) of the deleted file share. -- -- 'httpStatus', 'deleteFileShareResponse_httpStatus' - The response's http status code. newDeleteFileShareResponse :: -- | 'httpStatus' Prelude.Int -> DeleteFileShareResponse newDeleteFileShareResponse pHttpStatus_ = DeleteFileShareResponse' { fileShareARN = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The Amazon Resource Name (ARN) of the deleted file share. deleteFileShareResponse_fileShareARN :: Lens.Lens' DeleteFileShareResponse (Prelude.Maybe Prelude.Text) deleteFileShareResponse_fileShareARN = Lens.lens (\DeleteFileShareResponse' {fileShareARN} -> fileShareARN) (\s@DeleteFileShareResponse' {} a -> s {fileShareARN = a} :: DeleteFileShareResponse) -- | The response's http status code. deleteFileShareResponse_httpStatus :: Lens.Lens' DeleteFileShareResponse Prelude.Int deleteFileShareResponse_httpStatus = Lens.lens (\DeleteFileShareResponse' {httpStatus} -> httpStatus) (\s@DeleteFileShareResponse' {} a -> s {httpStatus = a} :: DeleteFileShareResponse) instance Prelude.NFData DeleteFileShareResponse where rnf DeleteFileShareResponse' {..} = Prelude.rnf fileShareARN `Prelude.seq` Prelude.rnf httpStatus