get_recommendation_report_details

MigrationHubStrategyRecommendations.Client.get_recommendation_report_details(**kwargs)

Retrieves detailed information about the specified recommendation report.

See also: AWS API Documentation

Request Syntax

response = client.get_recommendation_report_details(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

The recommendation report generation task id returned by StartRecommendationReportGeneration.

Return type
dict
Returns
Response Syntax
{
    'id': 'string',
    'recommendationReportDetails': {
        'completionTime': datetime(2015, 1, 1),
        's3Bucket': 'string',
        's3Keys': [
            'string',
        ],
        'startTime': datetime(2015, 1, 1),
        'status': 'FAILED'|'IN_PROGRESS'|'SUCCESS',
        'statusMessage': 'string'
    }
}

Response Structure

  • (dict) --
    • id (string) --

      The ID of the recommendation report generation task. See the response of StartRecommendationReportGeneration.

    • recommendationReportDetails (dict) --

      Detailed information about the recommendation report.

      • completionTime (datetime) --

        The time that the recommendation report generation task completes.

      • s3Bucket (string) --

        The S3 bucket where the report file is located.

      • s3Keys (list) --

        The Amazon S3 key name of the report file.

        • (string) --
      • startTime (datetime) --

        The time that the recommendation report generation task starts.

      • status (string) --

        The status of the recommendation report generation task.

      • statusMessage (string) --

        The status message for recommendation report generation.

Exceptions

  • MigrationHubStrategyRecommendations.Client.exceptions.ResourceNotFoundException
  • MigrationHubStrategyRecommendations.Client.exceptions.AccessDeniedException
  • MigrationHubStrategyRecommendations.Client.exceptions.ThrottlingException
  • MigrationHubStrategyRecommendations.Client.exceptions.ValidationException
  • MigrationHubStrategyRecommendations.Client.exceptions.InternalServerException