libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MigrationHub.NotifyMigrationTaskState

Description

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

  • Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status.
  • MigrationTaskName is used for addressing updates to the correct target.
  • ProgressUpdateStream is used for access control and to provide a namespace for each migration tool.
Synopsis

Creating a Request

data NotifyMigrationTaskState Source #

See: newNotifyMigrationTaskState smart constructor.

Constructors

NotifyMigrationTaskState' 

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.

  • progressUpdateStream :: Text

    The name of the ProgressUpdateStream.

  • migrationTaskName :: Text

    Unique identifier that references the migration task. /Do not store personal data in this field./

  • task :: Task

    Information about the task's progress and status.

  • updateDateTime :: POSIX

    The timestamp when the task was gathered.

  • nextUpdateSeconds :: Natural

    Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

Instances

Instances details
Eq NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Read NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Show NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Generic NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Associated Types

type Rep NotifyMigrationTaskState :: Type -> Type #

NFData NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Hashable NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

ToJSON NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

AWSRequest NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

ToHeaders NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

ToPath NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

ToQuery NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

type Rep NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

type Rep NotifyMigrationTaskState = D1 ('MetaData "NotifyMigrationTaskState" "Amazonka.MigrationHub.NotifyMigrationTaskState" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "NotifyMigrationTaskState'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "progressUpdateStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "migrationTaskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Task) :*: (S1 ('MetaSel ('Just "updateDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "nextUpdateSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))))
type AWSResponse NotifyMigrationTaskState Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

newNotifyMigrationTaskState Source #

Create a value of NotifyMigrationTaskState 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:NotifyMigrationTaskState', notifyMigrationTaskState_dryRun - Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

$sel:progressUpdateStream:NotifyMigrationTaskState', notifyMigrationTaskState_progressUpdateStream - The name of the ProgressUpdateStream.

$sel:migrationTaskName:NotifyMigrationTaskState', notifyMigrationTaskState_migrationTaskName - Unique identifier that references the migration task. /Do not store personal data in this field./

$sel:task:NotifyMigrationTaskState', notifyMigrationTaskState_task - Information about the task's progress and status.

$sel:updateDateTime:NotifyMigrationTaskState', notifyMigrationTaskState_updateDateTime - The timestamp when the task was gathered.

$sel:nextUpdateSeconds:NotifyMigrationTaskState', notifyMigrationTaskState_nextUpdateSeconds - Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

Request Lenses

notifyMigrationTaskState_dryRun :: Lens' NotifyMigrationTaskState (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.

notifyMigrationTaskState_migrationTaskName :: Lens' NotifyMigrationTaskState Text Source #

Unique identifier that references the migration task. /Do not store personal data in this field./

notifyMigrationTaskState_task :: Lens' NotifyMigrationTaskState Task Source #

Information about the task's progress and status.

notifyMigrationTaskState_nextUpdateSeconds :: Lens' NotifyMigrationTaskState Natural Source #

Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

Destructuring the Response

data NotifyMigrationTaskStateResponse Source #

See: newNotifyMigrationTaskStateResponse smart constructor.

Constructors

NotifyMigrationTaskStateResponse' 

Fields

Instances

Instances details
Eq NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Read NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Show NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Generic NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

Associated Types

type Rep NotifyMigrationTaskStateResponse :: Type -> Type #

NFData NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

type Rep NotifyMigrationTaskStateResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.NotifyMigrationTaskState

type Rep NotifyMigrationTaskStateResponse = D1 ('MetaData "NotifyMigrationTaskStateResponse" "Amazonka.MigrationHub.NotifyMigrationTaskState" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "NotifyMigrationTaskStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newNotifyMigrationTaskStateResponse Source #

Create a value of NotifyMigrationTaskStateResponse 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:NotifyMigrationTaskStateResponse', notifyMigrationTaskStateResponse_httpStatus - The response's http status code.

Response Lenses