Network.AWS.MigrationHub.NotifyMigrationTaskState

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.

Creating a Request

notifyMigrationTaskState

Arguments

:: Text

nmtsProgressUpdateStream

-> Text

nmtsMigrationTaskName

-> Task

nmtsTask

-> UTCTime

nmtsUpdateDateTime

-> Natural

nmtsNextUpdateSeconds

-> NotifyMigrationTaskState

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

See: notifyMigrationTaskState smart constructor.

Instances

Eq NotifyMigrationTaskState

Methods

(==) :: NotifyMigrationTaskState -> NotifyMigrationTaskState -> Bool

(/=) :: NotifyMigrationTaskState -> NotifyMigrationTaskState -> Bool

Data NotifyMigrationTaskState

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NotifyMigrationTaskState -> c NotifyMigrationTaskState

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NotifyMigrationTaskState

toConstr :: NotifyMigrationTaskState -> Constr

dataTypeOf :: NotifyMigrationTaskState -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c NotifyMigrationTaskState)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NotifyMigrationTaskState)

gmapT :: (forall b. Data b => b -> b) -> NotifyMigrationTaskState -> NotifyMigrationTaskState

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NotifyMigrationTaskState -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NotifyMigrationTaskState -> r

gmapQ :: (forall d. Data d => d -> u) -> NotifyMigrationTaskState -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NotifyMigrationTaskState -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskState -> m NotifyMigrationTaskState

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskState -> m NotifyMigrationTaskState

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskState -> m NotifyMigrationTaskState

Read NotifyMigrationTaskState

Methods

readsPrec :: Int -> ReadS NotifyMigrationTaskState

readList :: ReadS [NotifyMigrationTaskState]

readPrec :: ReadPrec NotifyMigrationTaskState

readListPrec :: ReadPrec [NotifyMigrationTaskState]

Show NotifyMigrationTaskState

Methods

showsPrec :: Int -> NotifyMigrationTaskState -> ShowS

show :: NotifyMigrationTaskState -> String

showList :: [NotifyMigrationTaskState] -> ShowS

Generic NotifyMigrationTaskState

Associated Types

type Rep NotifyMigrationTaskState :: * -> *

Methods

from :: NotifyMigrationTaskState -> Rep NotifyMigrationTaskState x

to :: Rep NotifyMigrationTaskState x -> NotifyMigrationTaskState

Hashable NotifyMigrationTaskState

Methods

hashWithSalt :: Int -> NotifyMigrationTaskState -> Int

hash :: NotifyMigrationTaskState -> Int

ToJSON NotifyMigrationTaskState

Methods

toJSON :: NotifyMigrationTaskState -> Value

toEncoding :: NotifyMigrationTaskState -> Encoding

toJSONList :: [NotifyMigrationTaskState] -> Value

toEncodingList :: [NotifyMigrationTaskState] -> Encoding

NFData NotifyMigrationTaskState

Methods

rnf :: NotifyMigrationTaskState -> ()

AWSRequest NotifyMigrationTaskState

Associated Types

type Rs NotifyMigrationTaskState :: *

Methods

request :: NotifyMigrationTaskState -> Request NotifyMigrationTaskState

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * NotifyMigrationTaskState -> ClientResponse -> m (Response NotifyMigrationTaskState)

ToHeaders NotifyMigrationTaskState

Methods

toHeaders :: NotifyMigrationTaskState -> [Header]

ToPath NotifyMigrationTaskState

Methods

toPath :: NotifyMigrationTaskState -> ByteString

ToQuery NotifyMigrationTaskState

Methods

toQuery :: NotifyMigrationTaskState -> QueryString

type Rep NotifyMigrationTaskState

type Rep NotifyMigrationTaskState = D1 * (MetaData "NotifyMigrationTaskState" "Network.AWS.MigrationHub.NotifyMigrationTaskState" "amazonka-migrationhub-1.6.0-7kcto3lUXxtCXP9q5ELBxL" False) (C1 * (MetaCons "NotifyMigrationTaskState'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_nmtsDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_nmtsProgressUpdateStream") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_nmtsMigrationTaskName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_nmtsTask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Task)) ((:*:) * (S1 * (MetaSel (Just Symbol "_nmtsUpdateDateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX)) (S1 * (MetaSel (Just Symbol "_nmtsNextUpdateSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Nat))))))

type Rs NotifyMigrationTaskState

type Rs NotifyMigrationTaskState = NotifyMigrationTaskStateResponse

Request Lenses

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

nmtsProgressUpdateStream :: Lens' NotifyMigrationTaskState Text

The name of the ProgressUpdateStream.

nmtsMigrationTaskName :: Lens' NotifyMigrationTaskState Text

Unique identifier that references the migration task.

nmtsTask :: Lens' NotifyMigrationTaskState Task

Information about the task's progress and status.

nmtsUpdateDateTime :: Lens' NotifyMigrationTaskState UTCTime

The timestamp when the task was gathered.

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

Destructuring the Response

notifyMigrationTaskStateResponse

Arguments

:: Int

nmtsrsResponseStatus

-> NotifyMigrationTaskStateResponse

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

See: notifyMigrationTaskStateResponse smart constructor.

Instances

Eq NotifyMigrationTaskStateResponse

Methods

(==) :: NotifyMigrationTaskStateResponse -> NotifyMigrationTaskStateResponse -> Bool

(/=) :: NotifyMigrationTaskStateResponse -> NotifyMigrationTaskStateResponse -> Bool

Data NotifyMigrationTaskStateResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NotifyMigrationTaskStateResponse -> c NotifyMigrationTaskStateResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NotifyMigrationTaskStateResponse

toConstr :: NotifyMigrationTaskStateResponse -> Constr

dataTypeOf :: NotifyMigrationTaskStateResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c NotifyMigrationTaskStateResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NotifyMigrationTaskStateResponse)

gmapT :: (forall b. Data b => b -> b) -> NotifyMigrationTaskStateResponse -> NotifyMigrationTaskStateResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NotifyMigrationTaskStateResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NotifyMigrationTaskStateResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> NotifyMigrationTaskStateResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NotifyMigrationTaskStateResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskStateResponse -> m NotifyMigrationTaskStateResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskStateResponse -> m NotifyMigrationTaskStateResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NotifyMigrationTaskStateResponse -> m NotifyMigrationTaskStateResponse

Read NotifyMigrationTaskStateResponse

Methods

readsPrec :: Int -> ReadS NotifyMigrationTaskStateResponse

readList :: ReadS [NotifyMigrationTaskStateResponse]

readPrec :: ReadPrec NotifyMigrationTaskStateResponse

readListPrec :: ReadPrec [NotifyMigrationTaskStateResponse]

Show NotifyMigrationTaskStateResponse

Methods

showsPrec :: Int -> NotifyMigrationTaskStateResponse -> ShowS

show :: NotifyMigrationTaskStateResponse -> String

showList :: [NotifyMigrationTaskStateResponse] -> ShowS

Generic NotifyMigrationTaskStateResponse

Associated Types

type Rep NotifyMigrationTaskStateResponse :: * -> *

Methods

from :: NotifyMigrationTaskStateResponse -> Rep NotifyMigrationTaskStateResponse x

to :: Rep NotifyMigrationTaskStateResponse x -> NotifyMigrationTaskStateResponse

NFData NotifyMigrationTaskStateResponse

Methods

rnf :: NotifyMigrationTaskStateResponse -> ()

type Rep NotifyMigrationTaskStateResponse

type Rep NotifyMigrationTaskStateResponse = D1 * (MetaData "NotifyMigrationTaskStateResponse" "Network.AWS.MigrationHub.NotifyMigrationTaskState" "amazonka-migrationhub-1.6.0-7kcto3lUXxtCXP9q5ELBxL" True) (C1 * (MetaCons "NotifyMigrationTaskStateResponse'" PrefixI True) (S1 * (MetaSel (Just Symbol "_nmtsrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))

Response Lenses

nmtsrsResponseStatus :: Lens' NotifyMigrationTaskStateResponse Int

• - | The response status code.