Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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
- notifyMigrationTaskState :: Text -> Text -> Task -> UTCTime -> Natural -> NotifyMigrationTaskState
- data NotifyMigrationTaskState
- nmtsDryRun :: Lens' NotifyMigrationTaskState (Maybe Bool)
- nmtsProgressUpdateStream :: Lens' NotifyMigrationTaskState Text
- nmtsMigrationTaskName :: Lens' NotifyMigrationTaskState Text
- nmtsTask :: Lens' NotifyMigrationTaskState Task
- nmtsUpdateDateTime :: Lens' NotifyMigrationTaskState UTCTime
- nmtsNextUpdateSeconds :: Lens' NotifyMigrationTaskState Natural
- notifyMigrationTaskStateResponse :: Int -> NotifyMigrationTaskStateResponse
- data NotifyMigrationTaskStateResponse
- nmtsrsResponseStatus :: Lens' NotifyMigrationTaskStateResponse Int
Creating a Request
notifyMigrationTaskState Source #
Creates a value of NotifyMigrationTaskState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nmtsDryRun
- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.nmtsProgressUpdateStream
- The name of the ProgressUpdateStream.nmtsMigrationTaskName
- Unique identifier that references the migration task.nmtsTask
- Information about the task's progress and status.nmtsUpdateDateTime
- The timestamp when the task was gathered.nmtsNextUpdateSeconds
- 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.
data NotifyMigrationTaskState Source #
See: notifyMigrationTaskState
smart constructor.
Instances
Request Lenses
nmtsDryRun :: 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.
nmtsProgressUpdateStream :: Lens' NotifyMigrationTaskState Text Source #
The name of the ProgressUpdateStream.
nmtsMigrationTaskName :: Lens' NotifyMigrationTaskState Text Source #
Unique identifier that references the migration task.
nmtsTask :: Lens' NotifyMigrationTaskState Task Source #
Information about the task's progress and status.
nmtsUpdateDateTime :: Lens' NotifyMigrationTaskState UTCTime Source #
The timestamp when the task was gathered.
nmtsNextUpdateSeconds :: 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
notifyMigrationTaskStateResponse Source #
Creates a value of NotifyMigrationTaskStateResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nmtsrsResponseStatus
- -- | The response status code.
data NotifyMigrationTaskStateResponse Source #
See: notifyMigrationTaskStateResponse
smart constructor.
Instances
Response Lenses
nmtsrsResponseStatus :: Lens' NotifyMigrationTaskStateResponse Int Source #
- - | The response status code.