:doc:`MigrationHubStrategyRecommendations <../../migrationhubstrategy>` / Client / get_portfolio_summary

*********************
get_portfolio_summary
*********************



.. py:method:: MigrationHubStrategyRecommendations.Client.get_portfolio_summary()

  

  Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/migrationhubstrategy-2020-02-19/GetPortfolioSummary>`_  


  **Request Syntax**
  ::

    response = client.get_portfolio_summary()
    
    
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'assessmentSummary': {
              'antipatternReportS3Object': {
                  's3Bucket': 'string',
                  's3key': 'string'
              },
              'antipatternReportStatus': 'FAILED'|'IN_PROGRESS'|'SUCCESS',
              'antipatternReportStatusMessage': 'string',
              'lastAnalyzedTimestamp': datetime(2015, 1, 1),
              'listAntipatternSeveritySummary': [
                  {
                      'count': 123,
                      'severity': 'HIGH'|'MEDIUM'|'LOW'
                  },
              ],
              'listApplicationComponentStatusSummary': [
                  {
                      'count': 123,
                      'srcCodeOrDbAnalysisStatus': 'ANALYSIS_TO_BE_SCHEDULED'|'ANALYSIS_STARTED'|'ANALYSIS_SUCCESS'|'ANALYSIS_FAILED'|'ANALYSIS_PARTIAL_SUCCESS'|'UNCONFIGURED'|'CONFIGURED'
                  },
              ],
              'listApplicationComponentStrategySummary': [
                  {
                      'count': 123,
                      'strategy': 'Rehost'|'Retirement'|'Refactor'|'Replatform'|'Retain'|'Relocate'|'Repurchase'
                  },
              ],
              'listApplicationComponentSummary': [
                  {
                      'appType': 'DotNetFramework'|'Java'|'SQLServer'|'IIS'|'Oracle'|'Other'|'Tomcat'|'JBoss'|'Spring'|'Mongo DB'|'DB2'|'Maria DB'|'MySQL'|'Sybase'|'PostgreSQLServer'|'Cassandra'|'IBM WebSphere'|'Oracle WebLogic'|'Visual Basic'|'Unknown'|'DotnetCore'|'Dotnet',
                      'count': 123
                  },
              ],
              'listServerStatusSummary': [
                  {
                      'count': 123,
                      'runTimeAssessmentStatus': 'dataCollectionTaskToBeScheduled'|'dataCollectionTaskScheduled'|'dataCollectionTaskStarted'|'dataCollectionTaskStopped'|'dataCollectionTaskSuccess'|'dataCollectionTaskFailed'|'dataCollectionTaskPartialSuccess'
                  },
              ],
              'listServerStrategySummary': [
                  {
                      'count': 123,
                      'strategy': 'Rehost'|'Retirement'|'Refactor'|'Replatform'|'Retain'|'Relocate'|'Repurchase'
                  },
              ],
              'listServerSummary': [
                  {
                      'ServerOsType': 'WindowsServer'|'AmazonLinux'|'EndOfSupportWindowsServer'|'Redhat'|'Other',
                      'count': 123
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **assessmentSummary** *(dict) --* 

        An assessment summary for the portfolio including the number of servers to rehost and the overall number of anti-patterns.

        
        

        - **antipatternReportS3Object** *(dict) --* 

          The Amazon S3 object containing the anti-pattern report.

          
          

          - **s3Bucket** *(string) --* 

            The S3 bucket name.

            
          

          - **s3key** *(string) --* 

            The Amazon S3 key name.

            
      
        

        - **antipatternReportStatus** *(string) --* 

          The status of the anti-pattern report.

          
        

        - **antipatternReportStatusMessage** *(string) --* 

          The status message of the anti-pattern report.

          
        

        - **lastAnalyzedTimestamp** *(datetime) --* 

          The time the assessment was performed.

          
        

        - **listAntipatternSeveritySummary** *(list) --* 

          List of AntipatternSeveritySummary.

          
          

          - *(dict) --* 

            Contains the summary of anti-patterns and their severity.

            
            

            - **count** *(integer) --* 

              Contains the count of anti-patterns.

              
            

            - **severity** *(string) --* 

              Contains the severity of anti-patterns.

              
        
      
        

        - **listApplicationComponentStatusSummary** *(list) --* 

          List of status summaries of the analyzed application components.

          
          

          - *(dict) --* 

            Summary of the analysis status of the application component.

            
            

            - **count** *(integer) --* 

              The number of application components successfully analyzed, partially successful or failed analysis.

              
            

            - **srcCodeOrDbAnalysisStatus** *(string) --* 

              The status of database analysis.

              
        
      
        

        - **listApplicationComponentStrategySummary** *(list) --* 

          List of ApplicationComponentStrategySummary.

          
          

          - *(dict) --* 

            Object containing the summary of the strategy recommendations.

            
            

            - **count** *(integer) --* 

              The count of recommendations per strategy.

              
            

            - **strategy** *(string) --* 

              The name of recommended strategy.

              
        
      
        

        - **listApplicationComponentSummary** *(list) --* 

          List of ApplicationComponentSummary.

          
          

          - *(dict) --* 

            Contains the summary of application components.

            
            

            - **appType** *(string) --* 

              Contains the name of application types.

              
            

            - **count** *(integer) --* 

              Contains the count of application type.

              
        
      
        

        - **listServerStatusSummary** *(list) --* 

          List of status summaries of the analyzed servers.

          
          

          - *(dict) --* 

            The status summary of the server analysis.

            
            

            - **count** *(integer) --* 

              The number of servers successfully analyzed, partially successful or failed analysis.

              
            

            - **runTimeAssessmentStatus** *(string) --* 

              The status of the run time.

              
        
      
        

        - **listServerStrategySummary** *(list) --* 

          List of ServerStrategySummary.

          
          

          - *(dict) --* 

            Object containing the summary of the strategy recommendations.

            
            

            - **count** *(integer) --* 

              The count of recommendations per strategy.

              
            

            - **strategy** *(string) --* 

              The name of recommended strategy.

              
        
      
        

        - **listServerSummary** *(list) --* 

          List of ServerSummary.

          
          

          - *(dict) --* 

            Object containing details about the servers imported by Application Discovery Service

            
            

            - **ServerOsType** *(string) --* 

              Type of operating system for the servers.

              
            

            - **count** *(integer) --* 

              Number of servers.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MigrationHubStrategyRecommendations.Client.exceptions.InternalServerException`

  