5.0.0 • Published 7 years ago
@datafire/amazonaws_mgh v5.0.0
@datafire/amazonaws_mgh
Client library for AWS Migration Hub
Installation and Usage
npm install --save @datafire/amazonaws_mgh
let amazonaws_mgh = require('@datafire/amazonaws_mgh').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_mgh.AssociateCreatedArtifact({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"CreatedArtifact": {
"Name": ""
}
}).then(data => {
console.log(data);
});
Description
Actions
AssociateCreatedArtifact
amazonaws_mgh.AssociateCreatedArtifact({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"CreatedArtifact": {
"Name": ""
}
}, context)
Input
- input
object
- CreatedArtifact required CreatedArtifact
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
AssociateDiscoveredResource
amazonaws_mgh.AssociateDiscoveredResource({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"DiscoveredResource": {
"ConfigurationId": ""
}
}, context)
Input
- input
object
- DiscoveredResource required DiscoveredResource
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
CreateProgressUpdateStream
amazonaws_mgh.CreateProgressUpdateStream({
"ProgressUpdateStreamName": ""
}, context)
Input
- input
object
- DryRun DryRun
- ProgressUpdateStreamName required ProgressUpdateStream
Output
DeleteProgressUpdateStream
amazonaws_mgh.DeleteProgressUpdateStream({
"ProgressUpdateStreamName": ""
}, context)
Input
- input
object
- DryRun DryRun
- ProgressUpdateStreamName required ProgressUpdateStream
Output
DescribeApplicationState
amazonaws_mgh.DescribeApplicationState({
"ApplicationId": ""
}, context)
Input
- input
object
- ApplicationId required ApplicationId
Output
DescribeMigrationTask
amazonaws_mgh.DescribeMigrationTask({
"ProgressUpdateStream": "",
"MigrationTaskName": ""
}, context)
Input
- input
object
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
- output DescribeMigrationTaskResult
DisassociateCreatedArtifact
amazonaws_mgh.DisassociateCreatedArtifact({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"CreatedArtifactName": ""
}, context)
Input
- input
object
- CreatedArtifactName required CreatedArtifactName
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
DisassociateDiscoveredResource
amazonaws_mgh.DisassociateDiscoveredResource({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"ConfigurationId": ""
}, context)
Input
- input
object
- ConfigurationId required ConfigurationId
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
ImportMigrationTask
amazonaws_mgh.ImportMigrationTask({
"ProgressUpdateStream": "",
"MigrationTaskName": ""
}, context)
Input
- input
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
Output
- output ImportMigrationTaskResult
ListCreatedArtifacts
amazonaws_mgh.ListCreatedArtifacts({
"ProgressUpdateStream": "",
"MigrationTaskName": ""
}, context)
Input
- input
object
- MaxResults MaxResultsCreatedArtifacts
- MigrationTaskName required MigrationTaskName
- NextToken Token
- ProgressUpdateStream required ProgressUpdateStream
Output
- output ListCreatedArtifactsResult
ListDiscoveredResources
amazonaws_mgh.ListDiscoveredResources({
"ProgressUpdateStream": "",
"MigrationTaskName": ""
}, context)
Input
- input
object
- MaxResults MaxResultsResources
- MigrationTaskName required MigrationTaskName
- NextToken Token
- ProgressUpdateStream required ProgressUpdateStream
Output
ListMigrationTasks
amazonaws_mgh.ListMigrationTasks({}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken Token
- ResourceName ResourceName
Output
- output ListMigrationTasksResult
ListProgressUpdateStreams
amazonaws_mgh.ListProgressUpdateStreams({}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken Token
Output
NotifyApplicationState
amazonaws_mgh.NotifyApplicationState({
"ApplicationId": "",
"Status": ""
}, context)
Input
- input
object
- ApplicationId required ApplicationId
- DryRun DryRun
- Status required ApplicationStatus
Output
- output NotifyApplicationStateResult
NotifyMigrationTaskState
amazonaws_mgh.NotifyMigrationTaskState({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"Task": {
"Status": ""
},
"UpdateDateTime": "",
"NextUpdateSeconds": 0
}, context)
Input
- input
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- NextUpdateSeconds required NextUpdateSeconds
- ProgressUpdateStream required ProgressUpdateStream
- Task required Task
- UpdateDateTime required UpdateDateTime
Output
PutResourceAttributes
amazonaws_mgh.PutResourceAttributes({
"ProgressUpdateStream": "",
"MigrationTaskName": "",
"ResourceAttributeList": []
}, context)
Input
- input
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
- ResourceAttributeList required ResourceAttributeList
Output
- output PutResourceAttributesResult
Definitions
AccessDeniedException
- AccessDeniedException
object
: Exception raised when the account making the call is not whitelisted or there are other authentication errors.- Message ErrorMessage
ApplicationId
- ApplicationId
string
ApplicationStatus
- ApplicationStatus
string
(values: NOT_STARTED, IN_PROGRESS, COMPLETED)
AssociateCreatedArtifactRequest
- AssociateCreatedArtifactRequest
object
- CreatedArtifact required CreatedArtifact
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
AssociateCreatedArtifactResult
- AssociateCreatedArtifactResult
object
AssociateDiscoveredResourceRequest
- AssociateDiscoveredResourceRequest
object
- DiscoveredResource required DiscoveredResource
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
AssociateDiscoveredResourceResult
- AssociateDiscoveredResourceResult
object
ConfigurationId
- ConfigurationId
string
CreateProgressUpdateStreamRequest
- CreateProgressUpdateStreamRequest
object
- DryRun DryRun
- ProgressUpdateStreamName required ProgressUpdateStream
CreateProgressUpdateStreamResult
- CreateProgressUpdateStreamResult
object
CreatedArtifact
- CreatedArtifact
object
: An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).- Description CreatedArtifactDescription
- Name required CreatedArtifactName
CreatedArtifactDescription
- CreatedArtifactDescription
string
CreatedArtifactList
- CreatedArtifactList
array
- items CreatedArtifact
CreatedArtifactName
- CreatedArtifactName
string
DeleteProgressUpdateStreamRequest
- DeleteProgressUpdateStreamRequest
object
- DryRun DryRun
- ProgressUpdateStreamName required ProgressUpdateStream
DeleteProgressUpdateStreamResult
- DeleteProgressUpdateStreamResult
object
DescribeApplicationStateRequest
- DescribeApplicationStateRequest
object
- ApplicationId required ApplicationId
DescribeApplicationStateResult
- DescribeApplicationStateResult
object
- ApplicationStatus ApplicationStatus
- LastUpdatedTime UpdateDateTime
DescribeMigrationTaskRequest
- DescribeMigrationTaskRequest
object
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
DescribeMigrationTaskResult
- DescribeMigrationTaskResult
object
- MigrationTask MigrationTask
DisassociateCreatedArtifactRequest
- DisassociateCreatedArtifactRequest
object
- CreatedArtifactName required CreatedArtifactName
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
DisassociateCreatedArtifactResult
- DisassociateCreatedArtifactResult
object
DisassociateDiscoveredResourceRequest
- DisassociateDiscoveredResourceRequest
object
- ConfigurationId required ConfigurationId
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
DisassociateDiscoveredResourceResult
- DisassociateDiscoveredResourceResult
object
DiscoveredResource
- DiscoveredResource
object
: Object representing the on-premises resource being migrated.- ConfigurationId required ConfigurationId
- Description DiscoveredResourceDescription
DiscoveredResourceDescription
- DiscoveredResourceDescription
string
DiscoveredResourceList
- DiscoveredResourceList
array
- items DiscoveredResource
DryRun
- DryRun
boolean
DryRunOperation
- DryRunOperation
object
: Exception raised to indicate a successfully authorized action when the DryRun flag is set to "true".- Message ErrorMessage
ErrorMessage
- ErrorMessage
string
ImportMigrationTaskRequest
- ImportMigrationTaskRequest
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
ImportMigrationTaskResult
- ImportMigrationTaskResult
object
InternalServerError
- InternalServerError
object
: Exception raised when there is an internal, configuration, or dependency error encountered.- Message ErrorMessage
InvalidInputException
- InvalidInputException
object
: Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.- Message ErrorMessage
LatestResourceAttributeList
- LatestResourceAttributeList
array
- items ResourceAttribute
ListCreatedArtifactsRequest
- ListCreatedArtifactsRequest
object
- MaxResults MaxResultsCreatedArtifacts
- MigrationTaskName required MigrationTaskName
- NextToken Token
- ProgressUpdateStream required ProgressUpdateStream
ListCreatedArtifactsResult
- ListCreatedArtifactsResult
object
- CreatedArtifactList CreatedArtifactList
- NextToken Token
ListDiscoveredResourcesRequest
- ListDiscoveredResourcesRequest
object
- MaxResults MaxResultsResources
- MigrationTaskName required MigrationTaskName
- NextToken Token
- ProgressUpdateStream required ProgressUpdateStream
ListDiscoveredResourcesResult
- ListDiscoveredResourcesResult
object
- DiscoveredResourceList DiscoveredResourceList
- NextToken Token
ListMigrationTasksRequest
- ListMigrationTasksRequest
object
- MaxResults MaxResults
- NextToken Token
- ResourceName ResourceName
ListMigrationTasksResult
- ListMigrationTasksResult
object
- MigrationTaskSummaryList MigrationTaskSummaryList
- NextToken Token
ListProgressUpdateStreamsRequest
- ListProgressUpdateStreamsRequest
object
- MaxResults MaxResults
- NextToken Token
ListProgressUpdateStreamsResult
- ListProgressUpdateStreamsResult
object
- NextToken Token
- ProgressUpdateStreamSummaryList ProgressUpdateStreamSummaryList
MaxResults
- MaxResults
integer
MaxResultsCreatedArtifacts
- MaxResultsCreatedArtifacts
integer
MaxResultsResources
- MaxResultsResources
integer
MigrationTask
- MigrationTask
object
: Represents a migration task in a migration tool.- MigrationTaskName MigrationTaskName
- ProgressUpdateStream ProgressUpdateStream
- ResourceAttributeList LatestResourceAttributeList
- Task Task
- UpdateDateTime UpdateDateTime
MigrationTaskName
- MigrationTaskName
string
MigrationTaskSummary
- MigrationTaskSummary
object
: MigrationTaskSummary includes MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and UpdateDateTime for each task.- MigrationTaskName MigrationTaskName
- ProgressPercent ProgressPercent
- ProgressUpdateStream ProgressUpdateStream
- Status Status
- StatusDetail StatusDetail
- UpdateDateTime UpdateDateTime
MigrationTaskSummaryList
- MigrationTaskSummaryList
array
- items MigrationTaskSummary
NextUpdateSeconds
- NextUpdateSeconds
integer
NotifyApplicationStateRequest
- NotifyApplicationStateRequest
object
- ApplicationId required ApplicationId
- DryRun DryRun
- Status required ApplicationStatus
NotifyApplicationStateResult
- NotifyApplicationStateResult
object
NotifyMigrationTaskStateRequest
- NotifyMigrationTaskStateRequest
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- NextUpdateSeconds required NextUpdateSeconds
- ProgressUpdateStream required ProgressUpdateStream
- Task required Task
- UpdateDateTime required UpdateDateTime
NotifyMigrationTaskStateResult
- NotifyMigrationTaskStateResult
object
PolicyErrorException
- PolicyErrorException
object
: Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the ADSCaller role is missing or not configured correctly.- Message ErrorMessage
ProgressPercent
- ProgressPercent
integer
ProgressUpdateStream
- ProgressUpdateStream
string
ProgressUpdateStreamSummary
- ProgressUpdateStreamSummary
object
: Summary of the AWS resource used for access control that is implicitly linked to your AWS account.- ProgressUpdateStreamName ProgressUpdateStream
ProgressUpdateStreamSummaryList
- ProgressUpdateStreamSummaryList
array
PutResourceAttributesRequest
- PutResourceAttributesRequest
object
- DryRun DryRun
- MigrationTaskName required MigrationTaskName
- ProgressUpdateStream required ProgressUpdateStream
- ResourceAttributeList required ResourceAttributeList
PutResourceAttributesResult
- PutResourceAttributesResult
object
ResourceAttribute
- ResourceAttribute
object
: Attribute associated with a resource.- Type required ResourceAttributeType
- Value required ResourceAttributeValue
ResourceAttributeList
- ResourceAttributeList
array
- items ResourceAttribute
ResourceAttributeType
- ResourceAttributeType
string
(values: IPV4_ADDRESS, IPV6_ADDRESS, MAC_ADDRESS, FQDN, VM_MANAGER_ID, VM_MANAGED_OBJECT_REFERENCE, VM_NAME, VM_PATH, BIOS_ID, MOTHERBOARD_SERIAL_NUMBER, LABEL)
ResourceAttributeValue
- ResourceAttributeValue
string
ResourceName
- ResourceName
string
ResourceNotFoundException
- ResourceNotFoundException
object
: 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.- Message ErrorMessage
ServiceUnavailableException
- ServiceUnavailableException
object
: Exception raised when the service encounters throttled communication with upstream dependencies or is overloaded with requests.- Message ErrorMessage
Status
- Status
string
(values: NOT_STARTED, IN_PROGRESS, FAILED, COMPLETED)
StatusDetail
- StatusDetail
string
Task
- Task
object
: Task object encapsulating task information.- ProgressPercent ProgressPercent
- Status required Status
- StatusDetail StatusDetail
Token
- Token
string
UnauthorizedOperation
- UnauthorizedOperation
object
: Exception raised to indicate a request was not authorized when the DryRun flag is set to "true".- Message ErrorMessage
UpdateDateTime
- UpdateDateTime
string