amazonka-migrationhub-2.0: Amazon Migration Hub SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MigrationHub.DeleteProgressUpdateStream

Description

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).
Synopsis

Creating a Request

data DeleteProgressUpdateStream Source #

See: newDeleteProgressUpdateStream smart constructor.

Constructors

DeleteProgressUpdateStream' 

Fields

  • dryRun :: Maybe Bool

    Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

  • progressUpdateStreamName :: Text

    The name of the ProgressUpdateStream. /Do not store personal data in this field./

Instances

Instances details
ToJSON DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

ToHeaders DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

ToPath DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

ToQuery DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

AWSRequest DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Generic DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Associated Types

type Rep DeleteProgressUpdateStream :: Type -> Type #

Read DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Show DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

NFData DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Eq DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Hashable DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

type AWSResponse DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

type Rep DeleteProgressUpdateStream Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

type Rep DeleteProgressUpdateStream = D1 ('MetaData "DeleteProgressUpdateStream" "Amazonka.MigrationHub.DeleteProgressUpdateStream" "amazonka-migrationhub-2.0-HPFHfkzHnlJDPxcpvPbrRQ" 'False) (C1 ('MetaCons "DeleteProgressUpdateStream'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "progressUpdateStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteProgressUpdateStream Source #

Create a value of DeleteProgressUpdateStream with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:DeleteProgressUpdateStream', 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.

DeleteProgressUpdateStream, deleteProgressUpdateStream_progressUpdateStreamName - The name of the ProgressUpdateStream. /Do not store personal data in this field./

Request Lenses

deleteProgressUpdateStream_dryRun :: Lens' DeleteProgressUpdateStream (Maybe Bool) Source #

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

deleteProgressUpdateStream_progressUpdateStreamName :: Lens' DeleteProgressUpdateStream Text Source #

The name of the ProgressUpdateStream. /Do not store personal data in this field./

Destructuring the Response

data DeleteProgressUpdateStreamResponse Source #

Constructors

DeleteProgressUpdateStreamResponse' 

Fields

Instances

Instances details
Generic DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Associated Types

type Rep DeleteProgressUpdateStreamResponse :: Type -> Type #

Read DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Show DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

NFData DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

Eq DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

type Rep DeleteProgressUpdateStreamResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.DeleteProgressUpdateStream

type Rep DeleteProgressUpdateStreamResponse = D1 ('MetaData "DeleteProgressUpdateStreamResponse" "Amazonka.MigrationHub.DeleteProgressUpdateStream" "amazonka-migrationhub-2.0-HPFHfkzHnlJDPxcpvPbrRQ" 'False) (C1 ('MetaCons "DeleteProgressUpdateStreamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteProgressUpdateStreamResponse Source #

Create a value of DeleteProgressUpdateStreamResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteProgressUpdateStreamResponse', deleteProgressUpdateStreamResponse_httpStatus - The response's http status code.

Response Lenses