Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MigrationHub.NotifyMigrationTaskState

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods (==) :: NotifyMigrationTaskState -> NotifyMigrationTaskState -> Bool # (/=) :: NotifyMigrationTaskState -> NotifyMigrationTaskState -> Bool #
Read NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods readsPrec :: Int -> ReadS NotifyMigrationTaskState # readList :: ReadS [NotifyMigrationTaskState] # readPrec :: ReadPrec NotifyMigrationTaskState # readListPrec :: ReadPrec [NotifyMigrationTaskState] #
Show NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods showsPrec :: Int -> NotifyMigrationTaskState -> ShowS # show :: NotifyMigrationTaskState -> String # showList :: [NotifyMigrationTaskState] -> ShowS #
Generic NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Associated Types type Rep NotifyMigrationTaskState :: Type -> Type # Methods from :: NotifyMigrationTaskState -> Rep NotifyMigrationTaskState x # to :: Rep NotifyMigrationTaskState x -> NotifyMigrationTaskState #
NFData NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods rnf :: NotifyMigrationTaskState -> () #
Hashable NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods hashWithSalt :: Int -> NotifyMigrationTaskState -> Int # hash :: NotifyMigrationTaskState -> Int #
ToJSON NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods toJSON :: NotifyMigrationTaskState -> Value # toEncoding :: NotifyMigrationTaskState -> Encoding # toJSONList :: [NotifyMigrationTaskState] -> Value # toEncodingList :: [NotifyMigrationTaskState] -> Encoding #
AWSRequest NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Associated Types type AWSResponse NotifyMigrationTaskState # Methods request :: NotifyMigrationTaskState -> Request NotifyMigrationTaskState # response :: MonadResource m => Logger -> Service -> Proxy NotifyMigrationTaskState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse NotifyMigrationTaskState))) #
ToHeaders NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods toHeaders :: NotifyMigrationTaskState -> [Header] #
ToPath NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods toPath :: NotifyMigrationTaskState -> ByteString #
ToQuery NotifyMigrationTaskState Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods toQuery :: NotifyMigrationTaskState -> QueryString #
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 type AWSResponse NotifyMigrationTaskState = NotifyMigrationTaskStateResponse

newNotifyMigrationTaskState Source #

Arguments

:: Text	`$sel:progressUpdateStream:NotifyMigrationTaskState'`
-> Text	`$sel:migrationTaskName:NotifyMigrationTaskState'`
-> Task	`$sel:task:NotifyMigrationTaskState'`
-> UTCTime	`$sel:updateDateTime:NotifyMigrationTaskState'`
-> Natural	`$sel:nextUpdateSeconds:NotifyMigrationTaskState'`
-> NotifyMigrationTaskState

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_progressUpdateStream :: Lens' NotifyMigrationTaskState Text Source #

The name of the ProgressUpdateStream.

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_updateDateTime :: Lens' NotifyMigrationTaskState UTCTime Source #

The timestamp when the task was gathered.

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 httpStatus :: Int The response's http status code.

Instances

Instances details

Eq NotifyMigrationTaskStateResponse Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods (==) :: NotifyMigrationTaskStateResponse -> NotifyMigrationTaskStateResponse -> Bool # (/=) :: NotifyMigrationTaskStateResponse -> NotifyMigrationTaskStateResponse -> Bool #
Read NotifyMigrationTaskStateResponse Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods readsPrec :: Int -> ReadS NotifyMigrationTaskStateResponse # readList :: ReadS [NotifyMigrationTaskStateResponse] # readPrec :: ReadPrec NotifyMigrationTaskStateResponse # readListPrec :: ReadPrec [NotifyMigrationTaskStateResponse] #
Show NotifyMigrationTaskStateResponse Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods showsPrec :: Int -> NotifyMigrationTaskStateResponse -> ShowS # show :: NotifyMigrationTaskStateResponse -> String # showList :: [NotifyMigrationTaskStateResponse] -> ShowS #
Generic NotifyMigrationTaskStateResponse Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Associated Types type Rep NotifyMigrationTaskStateResponse :: Type -> Type # Methods from :: NotifyMigrationTaskStateResponse -> Rep NotifyMigrationTaskStateResponse x # to :: Rep NotifyMigrationTaskStateResponse x -> NotifyMigrationTaskStateResponse #
NFData NotifyMigrationTaskStateResponse Source #
Instance details Defined in Amazonka.MigrationHub.NotifyMigrationTaskState Methods rnf :: NotifyMigrationTaskStateResponse -> () #
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 #

Arguments

:: Int	`$sel:httpStatus:NotifyMigrationTaskStateResponse'`
-> NotifyMigrationTaskStateResponse

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

notifyMigrationTaskStateResponse_httpStatus :: Lens' NotifyMigrationTaskStateResponse Int Source #

The response's http status code.