2017/08/14 - AWS Migration Hub - 16 new api methods
Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:
Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.
The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b .
Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.
See also: AWS API Documentation
Request Syntax
client.associate_created_artifact(
ProgressUpdateStream='string',
MigrationTaskName='string',
CreatedArtifact={
'Name': 'string',
'Description': 'string'
},
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task.
dict
[REQUIRED]
An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
Name (string) -- [REQUIRED]
An ARN that uniquely identifies the result of a migration task.
Description (string) --
A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the migration status of an application.
See also: AWS API Documentation
Request Syntax
client.describe_application_state(
ApplicationId='string'
)
string
[REQUIRED]
The configurationId in ADS that uniquely identifies the grouped application.
dict
Response Syntax
{
'ApplicationStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'LastUpdatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ApplicationStatus (string) --
Status of the application - Not Started, In-Progress, Complete.
LastUpdatedTime (datetime) --
The timestamp when the application status was last updated.
Lists progress update streams associated with the user account making this call.
See also: AWS API Documentation
Request Syntax
client.list_progress_update_streams(
NextToken='string',
MaxResults=123
)
string
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken .
integer
Filter to limit the maximum number of results to list per page.
dict
Response Syntax
{
'ProgressUpdateStreamSummaryList': [
{
'ProgressUpdateStreamName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProgressUpdateStreamSummaryList (list) --
List of progress update streams up to the max number of results passed in the input.
(dict) --
Summary of the AWS resource used for access control that is implicitly linked to your AWS account.
ProgressUpdateStreamName (string) --
The name of the ProgressUpdateStream.
NextToken (string) --
If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:
The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).
The call will return, and a background process will asynchronously be doing the actual delete of the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).
If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.
CreateProgressUpdateStream , ImportMigrationTask , NotifyMigrationTaskState , and all Associate[*] APIs realted to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted.
Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).
See also: AWS API Documentation
Request Syntax
client.delete_progress_update_stream(
ProgressUpdateStreamName='string',
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Sets the migration state of an application. For a given application identified by the value passed to ApplicationId , its status is set or updated by passing one of three values to Status : NOT_STARTED | IN_PROGRESS | COMPLETED .
See also: AWS API Documentation
Request Syntax
client.notify_application_state(
ApplicationId='string',
Status='NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
DryRun=True|False
)
string
[REQUIRED]
The configurationId in ADS that uniquely identifies the grouped application.
string
[REQUIRED]
Status of the application - Not Started, In-Progress, Complete.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.
This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub.
See also: AWS API Documentation
Request Syntax
client.import_migration_task(
ProgressUpdateStream='string',
MigrationTaskName='string',
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves a list of all attributes associated with a specific migration task.
See also: AWS API Documentation
Request Syntax
client.describe_migration_task(
ProgressUpdateStream='string',
MigrationTaskName='string'
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
The identifier given to the MigrationTask.
dict
Response Syntax
{
'MigrationTask': {
'ProgressUpdateStream': 'string',
'MigrationTaskName': 'string',
'Task': {
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'StatusDetail': 'string',
'ProgressPercent': 123
},
'UpdateDateTime': datetime(2015, 1, 1),
'ResourceAttributeList': [
{
'Type': 'IPV4_ADDRESS'|'IPV6_ADDRESS'|'MAC_ADDRESS'|'FQDN'|'VM_MANAGER_ID'|'VM_MANAGED_OBJECT_REFERENCE'|'VM_NAME'|'VM_PATH'|'BIOS_ID'|'MOTHERBOARD_SERIAL_NUMBER'|'LABEL',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
MigrationTask (dict) --
Object encapsulating information about the migration task.
ProgressUpdateStream (string) --
A name that identifies the vendor of the migration tool being used.
MigrationTaskName (string) --
Unique identifier that references the migration task.
Task (dict) --
Task object encapsulating task information.
Status (string) --
Status of the task - Not Started, In-Progress, Complete.
StatusDetail (string) --
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.
ProgressPercent (integer) --
Indication of the percentage completion of the task.
UpdateDateTime (datetime) --
The timestamp when the task was gathered.
ResourceAttributeList (list) --
(dict) --
Attribute associated with a resource.
Type (string) --
Type of resource.
Value (string) --
Value of the resource type.
Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
See also: AWS API Documentation
Request Syntax
client.associate_discovered_resource(
ProgressUpdateStream='string',
MigrationTaskName='string',
DiscoveredResource={
'ConfigurationId': 'string',
'Description': 'string'
},
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
The identifier given to the MigrationTask.
dict
[REQUIRED]
Object representing a Resource.
ConfigurationId (string) -- [REQUIRED]
The configurationId in ADS that uniquely identifies the on-premise resource.
Description (string) --
A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:
Gets the list of the created artifacts while migration is taking place.
Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.
Lists created artifacts in a paginated interface.
See also: AWS API Documentation
Request Syntax
client.list_created_artifacts(
ProgressUpdateStream='string',
MigrationTaskName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task.
string
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken .
integer
Maximum number of results to be returned per page.
dict
Response Syntax
{
'NextToken': 'string',
'CreatedArtifactList': [
{
'Name': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
CreatedArtifactList (list) --
List of created artifacts up to the maximum number of results specified in the request.
(dict) --
An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).
Name (string) --
An ARN that uniquely identifies the result of a migration task.
Description (string) --
A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.
Lists discovered resources associated with the given MigrationTask .
See also: AWS API Documentation
Request Syntax
client.list_discovered_resources(
ProgressUpdateStream='string',
MigrationTaskName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
The name of the MigrationTask.
string
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken .
integer
The maximum number of results returned per page.
dict
Response Syntax
{
'NextToken': 'string',
'DiscoveredResourceList': [
{
'ConfigurationId': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
DiscoveredResourceList (list) --
Returned list of discovered resources associated with the given MigrationTask.
(dict) --
Object representing the on-premises resource being migrated.
ConfigurationId (string) --
The configurationId in ADS that uniquely identifies the on-premise resource.
Description (string) --
A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.
Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:
Can show a summary list of the most recent migration tasks.
Can show a summary list of migration tasks associated with a given discovered resource.
Lists migration tasks in a paginated interface.
See also: AWS API Documentation
Request Syntax
client.list_migration_tasks(
NextToken='string',
MaxResults=123,
ResourceName='string'
)
string
If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken .
integer
Value to specify how many results are returned per page.
string
Filter migration tasks by discovered resource name.
dict
Response Syntax
{
'NextToken': 'string',
'MigrationTaskSummaryList': [
{
'ProgressUpdateStream': 'string',
'MigrationTaskName': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'ProgressPercent': 123,
'StatusDetail': 'string',
'UpdateDateTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.
MigrationTaskSummaryList (list) --
Lists the migration task's summary which includes: MigrationTaskName , ProgressPercent , ProgressUpdateStream , Status , and the UpdateDateTime for each task.
(dict) --
MigrationTaskSummary includes MigrationTaskName , ProgressPercent , ProgressUpdateStream , Status , and UpdateDateTime for each task.
ProgressUpdateStream (string) --
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.
MigrationTaskName (string) --
Unique identifier that references the migration task.
Status (string) --
Status of the task.
ProgressPercent (integer) --
StatusDetail (string) --
Detail information of what is being done within the overall status state.
UpdateDateTime (datetime) --
The timestamp when the task was gathered.
Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after PutResourceAttributes returns.
Warning
Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overiding the MAC address.
Note
Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListAssociatedResource .
See also: AWS API Documentation
Request Syntax
client.put_resource_attributes(
ProgressUpdateStream='string',
MigrationTaskName='string',
ResourceAttributeList=[
{
'Type': 'IPV4_ADDRESS'|'IPV6_ADDRESS'|'MAC_ADDRESS'|'FQDN'|'VM_MANAGER_ID'|'VM_MANAGED_OBJECT_REFERENCE'|'VM_NAME'|'VM_PATH'|'BIOS_ID'|'MOTHERBOARD_SERIAL_NUMBER'|'LABEL',
'Value': 'string'
},
],
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task.
list
[REQUIRED]
Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.
(dict) --
Attribute associated with a resource.
Type (string) -- [REQUIRED]
Type of resource.
Value (string) -- [REQUIRED]
Value of the resource type.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.
See also: AWS API Documentation
Request Syntax
client.create_progress_update_stream(
ProgressUpdateStreamName='string',
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:
A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.
The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b .
Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.
See also: AWS API Documentation
Request Syntax
client.disassociate_created_artifact(
ProgressUpdateStream='string',
MigrationTaskName='string',
CreatedArtifactName='string',
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task to be disassociated with the artifact.
string
[REQUIRED]
An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.notify_migration_task_state(
ProgressUpdateStream='string',
MigrationTaskName='string',
Task={
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
'StatusDetail': 'string',
'ProgressPercent': 123
},
UpdateDateTime=datetime(2015, 1, 1),
NextUpdateSeconds=123,
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
Unique identifier that references the migration task.
dict
[REQUIRED]
Information about the task's progress and status.
Status (string) -- [REQUIRED]
Status of the task - Not Started, In-Progress, Complete.
StatusDetail (string) --
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.
ProgressPercent (integer) --
Indication of the percentage completion of the task.
datetime
[REQUIRED]
The timestamp when the task was gathered.
integer
[REQUIRED]
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.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
See also: AWS API Documentation
Request Syntax
client.disassociate_discovered_resource(
ProgressUpdateStream='string',
MigrationTaskName='string',
ConfigurationId='string',
DryRun=True|False
)
string
[REQUIRED]
The name of the ProgressUpdateStream.
string
[REQUIRED]
The identifier given to the MigrationTask.
string
[REQUIRED]
ConfigurationId of the ADS resource to be disassociated.
boolean
Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
dict
Response Syntax
{}
Response Structure
(dict) --