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 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateDiscoveredResource
- CreateProgressUpdateStream
- ListCreatedArtifacts
- DisassociateDiscoveredResource
- NotifyApplicationState
- DeleteProgressUpdateStream
- ListProgressUpdateStreams
- DisassociateCreatedArtifact
- ImportMigrationTask
- DescribeMigrationTask
- PutResourceAttributes
- AssociateCreatedArtifact
- NotifyMigrationTaskState
- DescribeApplicationState
- ListMigrationTasks
- ListDiscoveredResources
- Types
The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.
- migrationHub :: Service
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _DryRunOperation :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedOperation :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.MigrationHub.AssociateDiscoveredResource
- module Network.AWS.MigrationHub.CreateProgressUpdateStream
- module Network.AWS.MigrationHub.ListCreatedArtifacts
- module Network.AWS.MigrationHub.DisassociateDiscoveredResource
- module Network.AWS.MigrationHub.NotifyApplicationState
- module Network.AWS.MigrationHub.DeleteProgressUpdateStream
- module Network.AWS.MigrationHub.ListProgressUpdateStreams
- module Network.AWS.MigrationHub.DisassociateCreatedArtifact
- module Network.AWS.MigrationHub.ImportMigrationTask
- module Network.AWS.MigrationHub.DescribeMigrationTask
- module Network.AWS.MigrationHub.PutResourceAttributes
- module Network.AWS.MigrationHub.AssociateCreatedArtifact
- module Network.AWS.MigrationHub.NotifyMigrationTaskState
- module Network.AWS.MigrationHub.DescribeApplicationState
- module Network.AWS.MigrationHub.ListMigrationTasks
- module Network.AWS.MigrationHub.ListDiscoveredResources
- data ApplicationStatus
- data MigrationStatus
- data ResourceAttributeType
- data CreatedArtifact
- createdArtifact :: Text -> CreatedArtifact
- caDescription :: Lens' CreatedArtifact (Maybe Text)
- caName :: Lens' CreatedArtifact Text
- data DiscoveredResource
- discoveredResource :: Text -> DiscoveredResource
- drDescription :: Lens' DiscoveredResource (Maybe Text)
- drConfigurationId :: Lens' DiscoveredResource Text
- data MigrationTask
- migrationTask :: MigrationTask
- mtUpdateDateTime :: Lens' MigrationTask (Maybe UTCTime)
- mtResourceAttributeList :: Lens' MigrationTask [ResourceAttribute]
- mtTask :: Lens' MigrationTask (Maybe Task)
- mtProgressUpdateStream :: Lens' MigrationTask (Maybe Text)
- mtMigrationTaskName :: Lens' MigrationTask (Maybe Text)
- data MigrationTaskSummary
- migrationTaskSummary :: MigrationTaskSummary
- mtsStatus :: Lens' MigrationTaskSummary (Maybe MigrationStatus)
- mtsUpdateDateTime :: Lens' MigrationTaskSummary (Maybe UTCTime)
- mtsProgressPercent :: Lens' MigrationTaskSummary (Maybe Natural)
- mtsStatusDetail :: Lens' MigrationTaskSummary (Maybe Text)
- mtsProgressUpdateStream :: Lens' MigrationTaskSummary (Maybe Text)
- mtsMigrationTaskName :: Lens' MigrationTaskSummary (Maybe Text)
- data ProgressUpdateStreamSummary
- progressUpdateStreamSummary :: ProgressUpdateStreamSummary
- pussProgressUpdateStreamName :: Lens' ProgressUpdateStreamSummary (Maybe Text)
- data ResourceAttribute
- resourceAttribute :: ResourceAttributeType -> Text -> ResourceAttribute
- raType :: Lens' ResourceAttribute ResourceAttributeType
- raValue :: Lens' ResourceAttribute Text
- data Task
- task :: MigrationStatus -> Task
- tProgressPercent :: Lens' Task (Maybe Natural)
- tStatusDetail :: Lens' Task (Maybe Text)
- tStatus :: Lens' Task MigrationStatus
Service Configuration
migrationHub :: Service Source #
API version 2017-05-31
of the Amazon Migration Hub SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MigrationHub
.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient access to perform this action.
DryRunOperation
_DryRunOperation :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised to indicate a successfully authorized action when the DryRun
flag is set to "true".
PolicyErrorException
_PolicyErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery
role is missing or not configured correctly.
InternalServerError
_InternalServerError :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised when there is an internal, configuration, or dependency error encountered.
InvalidInputException
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised when there is an internal, configuration, or dependency error encountered.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised when the request references a resource (ADS configuration, update stream, migration task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.
UnauthorizedOperation
_UnauthorizedOperation :: AsError a => Getting (First ServiceError) a ServiceError Source #
Exception raised to indicate a request was not authorized when the DryRun
flag is set to "true".
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateDiscoveredResource
CreateProgressUpdateStream
ListCreatedArtifacts
DisassociateDiscoveredResource
NotifyApplicationState
DeleteProgressUpdateStream
ListProgressUpdateStreams
DisassociateCreatedArtifact
ImportMigrationTask
DescribeMigrationTask
PutResourceAttributes
AssociateCreatedArtifact
NotifyMigrationTaskState
DescribeApplicationState
ListMigrationTasks
ListDiscoveredResources
Types
ApplicationStatus
data ApplicationStatus Source #
MigrationStatus
data MigrationStatus Source #
ResourceAttributeType
data ResourceAttributeType Source #
BiosId | |
Fqdn | |
IPV4Address | |
IPV6Address | |
MACAddress | |
MotherboardSerialNumber | |
VMManagedObjectReference | |
VMManagerId | |
VMName | |
VMPath |
CreatedArtifact
data CreatedArtifact Source #
An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).
See: createdArtifact
smart constructor.
Creates a value of CreatedArtifact
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caDescription
- A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.caName
- An ARN that uniquely identifies the result of a migration task.
caDescription :: Lens' CreatedArtifact (Maybe Text) Source #
A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.
caName :: Lens' CreatedArtifact Text Source #
An ARN that uniquely identifies the result of a migration task.
DiscoveredResource
data DiscoveredResource Source #
Object representing the on-premises resource being migrated.
See: discoveredResource
smart constructor.
Creates a value of DiscoveredResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drDescription
- A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.drConfigurationId
- The configurationId in ADS that uniquely identifies the on-premise resource.
drDescription :: Lens' DiscoveredResource (Maybe Text) Source #
A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.
drConfigurationId :: Lens' DiscoveredResource Text Source #
The configurationId in ADS that uniquely identifies the on-premise resource.
MigrationTask
data MigrationTask Source #
Represents a migration task in a migration tool.
See: migrationTask
smart constructor.
migrationTask :: MigrationTask Source #
Creates a value of MigrationTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtUpdateDateTime
- The timestamp when the task was gathered.mtResourceAttributeList
-mtTask
- Task object encapsulating task information.mtProgressUpdateStream
- A name that identifies the vendor of the migration tool being used.mtMigrationTaskName
- Unique identifier that references the migration task.
mtUpdateDateTime :: Lens' MigrationTask (Maybe UTCTime) Source #
The timestamp when the task was gathered.
mtProgressUpdateStream :: Lens' MigrationTask (Maybe Text) Source #
A name that identifies the vendor of the migration tool being used.
mtMigrationTaskName :: Lens' MigrationTask (Maybe Text) Source #
Unique identifier that references the migration task.
MigrationTaskSummary
data MigrationTaskSummary Source #
MigrationTaskSummary includes MigrationTaskName
, ProgressPercent
, ProgressUpdateStream
, Status
, and UpdateDateTime
for each task.
See: migrationTaskSummary
smart constructor.
migrationTaskSummary :: MigrationTaskSummary Source #
Creates a value of MigrationTaskSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtsStatus
- Status of the task.mtsUpdateDateTime
- The timestamp when the task was gathered.mtsProgressPercent
-mtsStatusDetail
- Detail information of what is being done within the overall status state.mtsProgressUpdateStream
- An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.mtsMigrationTaskName
- Unique identifier that references the migration task.
mtsStatus :: Lens' MigrationTaskSummary (Maybe MigrationStatus) Source #
Status of the task.
mtsUpdateDateTime :: Lens' MigrationTaskSummary (Maybe UTCTime) Source #
The timestamp when the task was gathered.
mtsStatusDetail :: Lens' MigrationTaskSummary (Maybe Text) Source #
Detail information of what is being done within the overall status state.
mtsProgressUpdateStream :: Lens' MigrationTaskSummary (Maybe Text) Source #
An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.
mtsMigrationTaskName :: Lens' MigrationTaskSummary (Maybe Text) Source #
Unique identifier that references the migration task.
ProgressUpdateStreamSummary
data ProgressUpdateStreamSummary Source #
Summary of the AWS resource used for access control that is implicitly linked to your AWS account.
See: progressUpdateStreamSummary
smart constructor.
progressUpdateStreamSummary :: ProgressUpdateStreamSummary Source #
Creates a value of ProgressUpdateStreamSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pussProgressUpdateStreamName
- The name of the ProgressUpdateStream.
pussProgressUpdateStreamName :: Lens' ProgressUpdateStreamSummary (Maybe Text) Source #
The name of the ProgressUpdateStream.
ResourceAttribute
data ResourceAttribute Source #
Attribute associated with a resource.
Note the corresponding format required per type listed below:
- IPV4 *
x.x.x.x
where x is an integer in the range [0,255]
- IPV6 *
y : y : y : y : y : y : y : y
where y is a hexadecimal between 0 and FFFF. [0, FFFF]
- MAC_ADDRESS *
^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
- FQDN *
^[^<>{}\\/?,=\p{Cntrl}]{1,256}$
See: resourceAttribute
smart constructor.
Creates a value of ResourceAttribute
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raType :: Lens' ResourceAttribute ResourceAttributeType Source #
Type of resource.
Task
Task object encapsulating task information.
See: task
smart constructor.
Creates a value of Task
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tProgressPercent
- Indication of the percentage completion of the task.tStatusDetail
- Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.tStatus
- Status of the task - Not Started, In-Progress, Complete.
tProgressPercent :: Lens' Task (Maybe Natural) Source #
Indication of the percentage completion of the task.