MigrationHub ************ Client ====== class MigrationHub.Client A low-level client representing AWS Migration Hub 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. Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a "HomeRegionNotSetException" error will be returned. Also, you must make the API calls while in your home region. import boto3 client = boto3.client('mgh') These are the available methods: * associate_created_artifact * associate_discovered_resource * associate_source_resource * can_paginate * close * create_progress_update_stream * delete_progress_update_stream * describe_application_state * describe_migration_task * disassociate_created_artifact * disassociate_discovered_resource * disassociate_source_resource * get_paginator * get_waiter * import_migration_task * list_application_states * list_created_artifacts * list_discovered_resources * list_migration_task_updates * list_migration_tasks * list_progress_update_streams * list_source_resources * notify_application_state * notify_migration_task_state * put_resource_attributes Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplicationStates * ListCreatedArtifacts * ListDiscoveredResources * ListMigrationTaskUpdates * ListMigrationTasks * ListProgressUpdateStreams * ListSourceResources MigrationHub / Paginator / ListProgressUpdateStreams ListProgressUpdateStreams ************************* class MigrationHub.Paginator.ListProgressUpdateStreams paginator = client.get_paginator('list_progress_update_streams') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_progress_update_streams()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ProgressUpdateStreamSummaryList': [ { 'ProgressUpdateStreamName': '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. *Do not store personal data in this field.* MigrationHub / Paginator / ListMigrationTaskUpdates ListMigrationTaskUpdates ************************ class MigrationHub.Paginator.ListMigrationTaskUpdates paginator = client.get_paginator('list_migration_task_updates') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_migration_task_updates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProgressUpdateStream='string', MigrationTaskName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not include sensitive data in this field.* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MigrationTaskUpdateList': [ { 'UpdateDateTime': datetime(2015, 1, 1), 'UpdateType': 'MIGRATION_TASK_STATE_UPDATED', 'MigrationTaskState': { 'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED', 'StatusDetail': 'string', 'ProgressPercent': 123 } }, ] } **Response Structure** * *(dict) --* * **MigrationTaskUpdateList** *(list) --* The list of migration-task updates. * *(dict) --* A migration-task progress update. * **UpdateDateTime** *(datetime) --* The timestamp for the update. * **UpdateType** *(string) --* The type of the update. * **MigrationTaskState** *(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. MigrationHub / Paginator / ListApplicationStates ListApplicationStates ********************* class MigrationHub.Paginator.ListApplicationStates paginator = client.get_paginator('list_application_states') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_application_states()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ApplicationIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ApplicationIds** (*list*) -- The configurationIds from the Application Discovery Service that uniquely identifies your applications. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationStateList': [ { 'ApplicationId': 'string', 'ApplicationStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'LastUpdatedTime': datetime(2015, 1, 1) }, ], } **Response Structure** * *(dict) --* * **ApplicationStateList** *(list) --* A list of Applications that exist in Application Discovery Service. * *(dict) --* The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent. * **ApplicationId** *(string) --* The configurationId from the Application Discovery Service that uniquely identifies an application. * **ApplicationStatus** *(string) --* The current status of an application. * **LastUpdatedTime** *(datetime) --* The timestamp when the application status was last updated. MigrationHub / Paginator / ListMigrationTasks ListMigrationTasks ****************** class MigrationHub.Paginator.ListMigrationTasks paginator = client.get_paginator('list_migration_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_migration_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceName** (*string*) -- Filter migration tasks by discovered resource name. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'MigrationTaskSummaryList': [ { 'ProgressUpdateStream': 'string', 'MigrationTaskName': 'string', 'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED', 'ProgressPercent': 123, 'StatusDetail': 'string', 'UpdateDateTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **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. *Do not store personal data in this field.* * **Status** *(string) --* Status of the task. * **ProgressPercent** *(integer) --* Indication of the percentage completion of the task. * **StatusDetail** *(string) --* Detail information of what is being done within the overall status state. * **UpdateDateTime** *(datetime) --* The timestamp when the task was gathered. MigrationHub / Paginator / ListCreatedArtifacts ListCreatedArtifacts ******************** class MigrationHub.Paginator.ListCreatedArtifacts paginator = client.get_paginator('list_created_artifacts') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_created_artifacts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProgressUpdateStream='string', MigrationTaskName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'CreatedArtifactList': [ { 'Name': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **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. MigrationHub / Paginator / ListDiscoveredResources ListDiscoveredResources *********************** class MigrationHub.Paginator.ListDiscoveredResources paginator = client.get_paginator('list_discovered_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_discovered_resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProgressUpdateStream='string', MigrationTaskName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** The name of the MigrationTask. *Do not store personal data in this field.* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DiscoveredResourceList': [ { 'ConfigurationId': 'string', 'Description': 'string' }, ] } **Response Structure** * *(dict) --* * **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 Application Discovery Service 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. MigrationHub / Paginator / ListSourceResources ListSourceResources ******************* class MigrationHub.Paginator.ListSourceResources paginator = client.get_paginator('list_source_resources') paginate(**kwargs) Creates an iterator that will paginate through responses from "MigrationHub.Client.list_source_resources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ProgressUpdateStream='string', MigrationTaskName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not store confidential data in this field.* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SourceResourceList': [ { 'Name': 'string', 'Description': 'string', 'StatusDetail': 'string' }, ] } **Response Structure** * *(dict) --* * **SourceResourceList** *(list) --* The list of source resources. * *(dict) --* A source resource can be a source server, a migration wave, an application, or any other resource that you track. * **Name** *(string) --* This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource. * **Description** *(string) --* A description that can be free-form text to record additional detail about the resource for clarity or later reference. * **StatusDetail** *(string) --* A free-form description of the status of the resource. MigrationHub / Client / notify_application_state notify_application_state ************************ MigrationHub.Client.notify_application_state(**kwargs) 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** response = client.notify_application_state( ApplicationId='string', Status='NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', UpdateDateTime=datetime(2015, 1, 1), DryRun=True|False ) Parameters: * **ApplicationId** (*string*) -- **[REQUIRED]** The configurationId in Application Discovery Service that uniquely identifies the grouped application. * **Status** (*string*) -- **[REQUIRED]** Status of the application - Not Started, In-Progress, Complete. * **UpdateDateTime** (*datetime*) -- The timestamp when the application state changed. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.PolicyErrorException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / get_paginator get_paginator ************* MigrationHub.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. MigrationHub / Client / describe_migration_task describe_migration_task *********************** MigrationHub.Client.describe_migration_task(**kwargs) Retrieves a list of all attributes associated with a specific migration task. See also: AWS API Documentation **Request Syntax** response = client.describe_migration_task( ProgressUpdateStream='string', MigrationTaskName='string' ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** The identifier given to the MigrationTask. *Do not store personal data in this field.* Return type: dict Returns: **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', '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. *Do not store personal data in this field.* * **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) --* 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 repository. * *(dict) --* 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}$" * **Type** *(string) --* Type of resource. * **Value** *(string) --* Value of the resource type. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / describe_application_state describe_application_state ************************** MigrationHub.Client.describe_application_state(**kwargs) Gets the migration status of an application. See also: AWS API Documentation **Request Syntax** response = client.describe_application_state( ApplicationId='string' ) Parameters: **ApplicationId** (*string*) -- **[REQUIRED]** The configurationId in Application Discovery Service that uniquely identifies the grouped application. Return type: dict Returns: **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. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.PolicyErrorException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / can_paginate can_paginate ************ MigrationHub.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. MigrationHub / Client / list_discovered_resources list_discovered_resources ************************* MigrationHub.Client.list_discovered_resources(**kwargs) Lists discovered resources associated with the given "MigrationTask". See also: AWS API Documentation **Request Syntax** response = client.list_discovered_resources( ProgressUpdateStream='string', MigrationTaskName='string', NextToken='string', MaxResults=123 ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** The name of the MigrationTask. *Do not store personal data in this field.* * **NextToken** (*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". * **MaxResults** (*integer*) -- The maximum number of results returned per page. Return type: dict Returns: **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 Application Discovery Service 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. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / list_application_states list_application_states *********************** MigrationHub.Client.list_application_states(**kwargs) Lists all the migration statuses for your applications. If you use the optional "ApplicationIds" parameter, only the migration statuses for those applications will be returned. See also: AWS API Documentation **Request Syntax** response = client.list_application_states( ApplicationIds=[ 'string', ], NextToken='string', MaxResults=123 ) Parameters: * **ApplicationIds** (*list*) -- The configurationIds from the Application Discovery Service that uniquely identifies your applications. * *(string) --* * **NextToken** (*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". * **MaxResults** (*integer*) -- Maximum number of results to be returned per page. Return type: dict Returns: **Response Syntax** { 'ApplicationStateList': [ { 'ApplicationId': 'string', 'ApplicationStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED', 'LastUpdatedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationStateList** *(list) --* A list of Applications that exist in Application Discovery Service. * *(dict) --* The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent. * **ApplicationId** *(string) --* The configurationId from the Application Discovery Service that uniquely identifies an application. * **ApplicationStatus** *(string) --* The current status of an application. * **LastUpdatedTime** *(datetime) --* The timestamp when the application status was last updated. * **NextToken** *(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". **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / associate_source_resource associate_source_resource ************************* MigrationHub.Client.associate_source_resource(**kwargs) Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave. See also: AWS API Documentation **Request Syntax** response = client.associate_source_resource( ProgressUpdateStream='string', MigrationTaskName='string', SourceResource={ 'Name': 'string', 'Description': 'string', 'StatusDetail': 'string' }, DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress- update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not include sensitive data in this field.* * **SourceResource** (*dict*) -- **[REQUIRED]** The source resource that you want to associate. * **Name** *(string) --* **[REQUIRED]** This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource. * **Description** *(string) --* A description that can be free-form text to record additional detail about the resource for clarity or later reference. * **StatusDetail** *(string) --* A free-form description of the status of the resource. * **DryRun** (*boolean*) -- This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to "true" to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" MigrationHub / Client / delete_progress_update_stream delete_progress_update_stream ***************************** MigrationHub.Client.delete_progress_update_stream(**kwargs) 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 delete 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 related 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** response = client.delete_progress_update_stream( ProgressUpdateStreamName='string', DryRun=True|False ) Parameters: * **ProgressUpdateStreamName** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. *Do not store personal data in this field.* * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / associate_created_artifact associate_created_artifact ************************** MigrationHub.Client.associate_created_artifact(**kwargs) 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** response = client.associate_created_artifact( ProgressUpdateStream='string', MigrationTaskName='string', CreatedArtifact={ 'Name': 'string', 'Description': 'string' }, DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **CreatedArtifact** (*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. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / disassociate_created_artifact disassociate_created_artifact ***************************** MigrationHub.Client.disassociate_created_artifact(**kwargs) 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** response = client.disassociate_created_artifact( ProgressUpdateStream='string', MigrationTaskName='string', CreatedArtifactName='string', DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task to be disassociated with the artifact. *Do not store personal data in this field.* * **CreatedArtifactName** (*string*) -- **[REQUIRED]** An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / put_resource_attributes put_resource_attributes *********************** MigrationHub.Client.put_resource_attributes(**kwargs) Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service 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 overriding the MAC address. * Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value. 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 "ListDiscoveredResources". See also: AWS API Documentation **Request Syntax** response = 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', 'Value': 'string' }, ], DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **ResourceAttributeList** (*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 repository. Note: Takes the object array of "ResourceAttribute" where the "Type" field is reserved for the following values: "IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER" where the identifying value can be a string up to 256 characters. Warning: * If any "VM" related value is set for a "ResourceAttribute" object, it is required that "VM_MANAGER_ID", as a minimum, is always set. If "VM_MANAGER_ID" is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values. * If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the "ResourceAttributeList" parameter to maximize the chances of matching. * *(dict) --* 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}$" * **Type** *(string) --* **[REQUIRED]** Type of resource. * **Value** *(string) --* **[REQUIRED]** Value of the resource type. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / list_source_resources list_source_resources ********************* MigrationHub.Client.list_source_resources(**kwargs) Lists all the source resource that are associated with the specified "MigrationTaskName" and "ProgressUpdateStream". See also: AWS API Documentation **Request Syntax** response = client.list_source_resources( ProgressUpdateStream='string', MigrationTaskName='string', NextToken='string', MaxResults=123 ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress- update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not store confidential data in this field.* * **NextToken** (*string*) -- If "NextToken" was returned by a previous call, there are more results available. The value of "NextToken" is a unique pagination token for each page. To retrieve the next page of results, specify the "NextToken" value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. * **MaxResults** (*integer*) -- The maximum number of results to include in the response. If more results exist than the value that you specify here for "MaxResults", the response will include a token that you can use to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'SourceResourceList': [ { 'Name': 'string', 'Description': 'string', 'StatusDetail': 'string' }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If the response includes a "NextToken" value, that means that there are more results available. The value of "NextToken" is a unique pagination token for each page. To retrieve the next page of results, call this API again and specify this "NextToken" value in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. * **SourceResourceList** *(list) --* The list of source resources. * *(dict) --* A source resource can be a source server, a migration wave, an application, or any other resource that you track. * **Name** *(string) --* This is the name that you want to use to identify the resource. If the resource is an AWS resource, we recommend that you set this parameter to the ARN of the resource. * **Description** *(string) --* A description that can be free-form text to record additional detail about the resource for clarity or later reference. * **StatusDetail** *(string) --* A free-form description of the status of the resource. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" MigrationHub / Client / import_migration_task import_migration_task ********************* MigrationHub.Client.import_migration_task(**kwargs) 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** response = client.import_migration_task( ProgressUpdateStream='string', MigrationTaskName='string', DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. > * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / get_waiter get_waiter ********** MigrationHub.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" MigrationHub / Client / create_progress_update_stream create_progress_update_stream ***************************** MigrationHub.Client.create_progress_update_stream(**kwargs) 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** response = client.create_progress_update_stream( ProgressUpdateStreamName='string', DryRun=True|False ) Parameters: * **ProgressUpdateStreamName** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. *Do not store personal data in this field.* * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / list_migration_task_updates list_migration_task_updates *************************** MigrationHub.Client.list_migration_task_updates(**kwargs) This is a paginated API that returns all the migration-task states for the specified "MigrationTaskName" and "ProgressUpdateStream". See also: AWS API Documentation **Request Syntax** response = client.list_migration_task_updates( ProgressUpdateStream='string', MigrationTaskName='string', NextToken='string', MaxResults=123 ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress- update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not include sensitive data in this field.* * **NextToken** (*string*) -- If "NextToken" was returned by a previous call, there are more results available. The value of "NextToken" is a unique pagination token for each page. To retrieve the next page of results, specify the "NextToken" value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. * **MaxResults** (*integer*) -- The maximum number of results to include in the response. If more results exist than the value that you specify here for "MaxResults", the response will include a token that you can use to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'MigrationTaskUpdateList': [ { 'UpdateDateTime': datetime(2015, 1, 1), 'UpdateType': 'MIGRATION_TASK_STATE_UPDATED', 'MigrationTaskState': { 'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED', 'StatusDetail': 'string', 'ProgressPercent': 123 } }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* If the response includes a "NextToken" value, that means that there are more results available. The value of "NextToken" is a unique pagination token for each page. To retrieve the next page of results, call this API again and specify this "NextToken" value in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. * **MigrationTaskUpdateList** *(list) --* The list of migration-task updates. * *(dict) --* A migration-task progress update. * **UpdateDateTime** *(datetime) --* The timestamp for the update. * **UpdateType** *(string) --* The type of the update. * **MigrationTaskState** *(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. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" MigrationHub / Client / disassociate_source_resource disassociate_source_resource **************************** MigrationHub.Client.disassociate_source_resource(**kwargs) Removes the association between a source resource and a migration task. See also: AWS API Documentation **Request Syntax** response = client.disassociate_source_resource( ProgressUpdateStream='string', MigrationTaskName='string', SourceResourceName='string', DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress- update stream 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. * **MigrationTaskName** (*string*) -- **[REQUIRED]** A unique identifier that references the migration task. *Do not include sensitive data in this field.* * **SourceResourceName** (*string*) -- **[REQUIRED]** The name that was specified for the source resource. * **DryRun** (*boolean*) -- This is an optional parameter that you can use to test whether the call will succeed. Set this parameter to "true" to verify that you have the permissions that are required to make the call, and that you have specified the other parameters in the call correctly. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" MigrationHub / Client / list_created_artifacts list_created_artifacts ********************** MigrationHub.Client.list_created_artifacts(**kwargs) 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** response = client.list_created_artifacts( ProgressUpdateStream='string', MigrationTaskName='string', NextToken='string', MaxResults=123 ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **NextToken** (*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". * **MaxResults** (*integer*) -- Maximum number of results to be returned per page. Return type: dict Returns: **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. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / close close ***** MigrationHub.Client.close() Closes underlying endpoint connections. MigrationHub / Client / notify_migration_task_state notify_migration_task_state *************************** MigrationHub.Client.notify_migration_task_state(**kwargs) 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** response = 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 ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** Unique identifier that references the migration task. *Do not store personal data in this field.* * **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. * **UpdateDateTime** (*datetime*) -- **[REQUIRED]** The timestamp when the task was gathered. * **NextUpdateSeconds** (*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. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / disassociate_discovered_resource disassociate_discovered_resource ******************************** MigrationHub.Client.disassociate_discovered_resource(**kwargs) Disassociate an Application Discovery Service discovered resource from a migration task. See also: AWS API Documentation **Request Syntax** response = client.disassociate_discovered_resource( ProgressUpdateStream='string', MigrationTaskName='string', ConfigurationId='string', DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** The identifier given to the MigrationTask. *Do not store personal data in this field.* * **ConfigurationId** (*string*) -- **[REQUIRED]** ConfigurationId of the Application Discovery Service resource to be disassociated. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / list_migration_tasks list_migration_tasks ******************** MigrationHub.Client.list_migration_tasks(**kwargs) 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** response = client.list_migration_tasks( NextToken='string', MaxResults=123, ResourceName='string' ) Parameters: * **NextToken** (*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". * **MaxResults** (*integer*) -- Value to specify how many results are returned per page. * **ResourceName** (*string*) -- Filter migration tasks by discovered resource name. Return type: dict Returns: **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. *Do not store personal data in this field.* * **Status** *(string) --* Status of the task. * **ProgressPercent** *(integer) --* Indication of the percentage completion of the task. * **StatusDetail** *(string) --* Detail information of what is being done within the overall status state. * **UpdateDateTime** *(datetime) --* The timestamp when the task was gathered. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.PolicyErrorException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / list_progress_update_streams list_progress_update_streams **************************** MigrationHub.Client.list_progress_update_streams(**kwargs) Lists progress update streams associated with the user account making this call. See also: AWS API Documentation **Request Syntax** response = client.list_progress_update_streams( NextToken='string', MaxResults=123 ) Parameters: * **NextToken** (*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". * **MaxResults** (*integer*) -- Filter to limit the maximum number of results to list per page. Return type: dict Returns: **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. *Do not store personal data in this field.* * **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. **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException" MigrationHub / Client / associate_discovered_resource associate_discovered_resource ***************************** MigrationHub.Client.associate_discovered_resource(**kwargs) Associates a discovered resource ID from Application Discovery Service with a migration task. See also: AWS API Documentation **Request Syntax** response = client.associate_discovered_resource( ProgressUpdateStream='string', MigrationTaskName='string', DiscoveredResource={ 'ConfigurationId': 'string', 'Description': 'string' }, DryRun=True|False ) Parameters: * **ProgressUpdateStream** (*string*) -- **[REQUIRED]** The name of the ProgressUpdateStream. * **MigrationTaskName** (*string*) -- **[REQUIRED]** The identifier given to the MigrationTask. *Do not store personal data in this field.* * **DiscoveredResource** (*dict*) -- **[REQUIRED]** Object representing a Resource. * **ConfigurationId** *(string) --* **[REQUIRED]** The configurationId in Application Discovery Service 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. * **DryRun** (*boolean*) -- Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "MigrationHub.Client.exceptions.AccessDeniedException" * "MigrationHub.Client.exceptions.ThrottlingException" * "MigrationHub.Client.exceptions.InternalServerError" * "MigrationHub.Client.exceptions.ServiceUnavailableException" * "MigrationHub.Client.exceptions.DryRunOperation" * "MigrationHub.Client.exceptions.UnauthorizedOperation" * "MigrationHub.Client.exceptions.InvalidInputException" * "MigrationHub.Client.exceptions.PolicyErrorException" * "MigrationHub.Client.exceptions.ResourceNotFoundException" * "MigrationHub.Client.exceptions.HomeRegionNotSetException"