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