AWS Migration Hub

2024/12/11 - AWS Migration Hub - 4 new api methods

Changes  API and documentation updates for AWS MigrationHub related to adding support for listing migration task updates and associating, disassociating and listing source resources

ListMigrationTaskUpdates (new) Link ¶

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

client.list_migration_task_updates(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    NextToken='string',
    MaxResults=123
)
type ProgressUpdateStream:

string

param ProgressUpdateStream:

[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.

type MigrationTaskName:

string

param MigrationTaskName:

[REQUIRED]

A unique identifier that references the migration task. Do not include sensitive data in this field.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

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.

rtype:

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.

AssociateSourceResource (new) Link ¶

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

client.associate_source_resource(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    SourceResource={
        'Name': 'string',
        'Description': 'string',
        'StatusDetail': 'string'
    },
    DryRun=True|False
)
type ProgressUpdateStream:

string

param ProgressUpdateStream:

[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.

type MigrationTaskName:

string

param MigrationTaskName:

[REQUIRED]

A unique identifier that references the migration task. Do not include sensitive data in this field.

type SourceResource:

dict

param SourceResource:

[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.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DisassociateSourceResource (new) Link ¶

Removes the association between a source resource and a migration task.

See also: AWS API Documentation

Request Syntax

client.disassociate_source_resource(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    SourceResourceName='string',
    DryRun=True|False
)
type ProgressUpdateStream:

string

param ProgressUpdateStream:

[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.

type MigrationTaskName:

string

param MigrationTaskName:

[REQUIRED]

A unique identifier that references the migration task. Do not include sensitive data in this field.

type SourceResourceName:

string

param SourceResourceName:

[REQUIRED]

The name that was specified for the source resource.

type DryRun:

boolean

param DryRun:

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListSourceResources (new) Link ¶

Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.

See also: AWS API Documentation

Request Syntax

client.list_source_resources(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    NextToken='string',
    MaxResults=123
)
type ProgressUpdateStream:

string

param ProgressUpdateStream:

[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.

type MigrationTaskName:

string

param MigrationTaskName:

[REQUIRED]

A unique identifier that references the migration task. Do not store confidential data in this field.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

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.

rtype:

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.