MigrationHubStrategyRecommendations / Client / get_assessment

get_assessment

MigrationHubStrategyRecommendations.Client.get_assessment(**kwargs)

Retrieves the status of an on-going assessment.

See also: AWS API Documentation

Request Syntax

response = client.get_assessment(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The assessmentid returned by StartAssessment.

Return type:

dict

Returns:

Response Syntax

{
    'assessmentTargets': [
        {
            'condition': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS',
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    'dataCollectionDetails': {
        'completionTime': datetime(2015, 1, 1),
        'failed': 123,
        'inProgress': 123,
        'servers': 123,
        'startTime': datetime(2015, 1, 1),
        'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'STOPPED',
        'statusMessage': 'string',
        'success': 123
    },
    'id': 'string'
}

Response Structure

  • (dict) –

    • assessmentTargets (list) –

      List of criteria for assessment.

      • (dict) –

        Defines the criteria of assessment.

        • condition (string) –

          Condition of an assessment.

        • name (string) –

          Name of an assessment.

        • values (list) –

          Values of an assessment.

          • (string) –

    • dataCollectionDetails (dict) –

      Detailed information about the assessment.

      • completionTime (datetime) –

        The time the assessment completes.

      • failed (integer) –

        The number of failed servers in the assessment.

      • inProgress (integer) –

        The number of servers with the assessment status IN_PROGESS.

      • servers (integer) –

        The total number of servers in the assessment.

      • startTime (datetime) –

        The start time of assessment.

      • status (string) –

        The status of the assessment.

      • statusMessage (string) –

        The status message of the assessment.

      • success (integer) –

        The number of successful servers in the assessment.

    • id (string) –

      The ID for the specific assessment task.

Exceptions