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