{-# 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.MigrationHub.DeleteProgressUpdateStream -- 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 progress update stream, including all of its tasks, which was -- previously created as an AWS resource used for access control. This API -- has the following traits: -- -- - The only parameter needed for @DeleteProgressUpdateStream@ is the -- stream name (same as a @CreateProgressUpdateStream@ call). -- -- - The call will return, and a background process will asynchronously -- delete the stream and all of its resources (tasks, associated -- resources, resource attributes, created artifacts). -- -- - If the stream takes time to be deleted, it might still show up on a -- @ListProgressUpdateStreams@ call. -- -- - @CreateProgressUpdateStream@, @ImportMigrationTask@, -- @NotifyMigrationTaskState@, and all Associate[*] APIs related to the -- tasks belonging to the stream will throw \"InvalidInputException\" -- if the stream of the same name is in the process of being deleted. -- -- - Once the stream and all of its resources are deleted, -- @CreateProgressUpdateStream@ for a stream of the same name will -- succeed, and that stream will be an entirely new logical resource -- (without any resources associated with the old stream). module Amazonka.MigrationHub.DeleteProgressUpdateStream ( -- * Creating a Request DeleteProgressUpdateStream (..), newDeleteProgressUpdateStream, -- * Request Lenses deleteProgressUpdateStream_dryRun, deleteProgressUpdateStream_progressUpdateStreamName, -- * Destructuring the Response DeleteProgressUpdateStreamResponse (..), newDeleteProgressUpdateStreamResponse, -- * Response Lenses deleteProgressUpdateStreamResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.MigrationHub.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDeleteProgressUpdateStream' smart constructor. data DeleteProgressUpdateStream = DeleteProgressUpdateStream' { -- | Optional boolean flag to indicate whether any effect should take place. -- Used to test if the caller has permission to make the call. dryRun :: Prelude.Maybe Prelude.Bool, -- | The name of the ProgressUpdateStream. /Do not store personal data in -- this field./ progressUpdateStreamName :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteProgressUpdateStream' 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: -- -- 'dryRun', 'deleteProgressUpdateStream_dryRun' - Optional boolean flag to indicate whether any effect should take place. -- Used to test if the caller has permission to make the call. -- -- 'progressUpdateStreamName', 'deleteProgressUpdateStream_progressUpdateStreamName' - The name of the ProgressUpdateStream. /Do not store personal data in -- this field./ newDeleteProgressUpdateStream :: -- | 'progressUpdateStreamName' Prelude.Text -> DeleteProgressUpdateStream newDeleteProgressUpdateStream pProgressUpdateStreamName_ = DeleteProgressUpdateStream' { dryRun = Prelude.Nothing, progressUpdateStreamName = pProgressUpdateStreamName_ } -- | Optional boolean flag to indicate whether any effect should take place. -- Used to test if the caller has permission to make the call. deleteProgressUpdateStream_dryRun :: Lens.Lens' DeleteProgressUpdateStream (Prelude.Maybe Prelude.Bool) deleteProgressUpdateStream_dryRun = Lens.lens (\DeleteProgressUpdateStream' {dryRun} -> dryRun) (\s@DeleteProgressUpdateStream' {} a -> s {dryRun = a} :: DeleteProgressUpdateStream) -- | The name of the ProgressUpdateStream. /Do not store personal data in -- this field./ deleteProgressUpdateStream_progressUpdateStreamName :: Lens.Lens' DeleteProgressUpdateStream Prelude.Text deleteProgressUpdateStream_progressUpdateStreamName = Lens.lens (\DeleteProgressUpdateStream' {progressUpdateStreamName} -> progressUpdateStreamName) (\s@DeleteProgressUpdateStream' {} a -> s {progressUpdateStreamName = a} :: DeleteProgressUpdateStream) instance Core.AWSRequest DeleteProgressUpdateStream where type AWSResponse DeleteProgressUpdateStream = DeleteProgressUpdateStreamResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveEmpty ( \s h x -> DeleteProgressUpdateStreamResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DeleteProgressUpdateStream where hashWithSalt _salt DeleteProgressUpdateStream' {..} = _salt `Prelude.hashWithSalt` dryRun `Prelude.hashWithSalt` progressUpdateStreamName instance Prelude.NFData DeleteProgressUpdateStream where rnf DeleteProgressUpdateStream' {..} = Prelude.rnf dryRun `Prelude.seq` Prelude.rnf progressUpdateStreamName instance Data.ToHeaders DeleteProgressUpdateStream where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSMigrationHub.DeleteProgressUpdateStream" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DeleteProgressUpdateStream where toJSON DeleteProgressUpdateStream' {..} = Data.object ( Prelude.catMaybes [ ("DryRun" Data..=) Prelude.<$> dryRun, Prelude.Just ( "ProgressUpdateStreamName" Data..= progressUpdateStreamName ) ] ) instance Data.ToPath DeleteProgressUpdateStream where toPath = Prelude.const "/" instance Data.ToQuery DeleteProgressUpdateStream where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDeleteProgressUpdateStreamResponse' smart constructor. data DeleteProgressUpdateStreamResponse = DeleteProgressUpdateStreamResponse' { -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DeleteProgressUpdateStreamResponse' 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: -- -- 'httpStatus', 'deleteProgressUpdateStreamResponse_httpStatus' - The response's http status code. newDeleteProgressUpdateStreamResponse :: -- | 'httpStatus' Prelude.Int -> DeleteProgressUpdateStreamResponse newDeleteProgressUpdateStreamResponse pHttpStatus_ = DeleteProgressUpdateStreamResponse' { httpStatus = pHttpStatus_ } -- | The response's http status code. deleteProgressUpdateStreamResponse_httpStatus :: Lens.Lens' DeleteProgressUpdateStreamResponse Prelude.Int deleteProgressUpdateStreamResponse_httpStatus = Lens.lens (\DeleteProgressUpdateStreamResponse' {httpStatus} -> httpStatus) (\s@DeleteProgressUpdateStreamResponse' {} a -> s {httpStatus = a} :: DeleteProgressUpdateStreamResponse) instance Prelude.NFData DeleteProgressUpdateStreamResponse where rnf DeleteProgressUpdateStreamResponse' {..} = Prelude.rnf httpStatus