portfolio_summaries

Creates, updates, deletes, gets or lists a portfolio_summaries resource.

Overview

Name	portfolio_summaries
Type	Resource
Id	aws.migrationhubstrategy.portfolio_summaries

Fields

The following fields are returned by SELECT queries:

get_portfolio_summary

Name	Datatype	Description
antipattern_report_s3_object	object	Contains the S3 bucket name and the Amazon S3 key name.
antipattern_report_status	string	The status of the anti-pattern report. (FAILED, IN_PROGRESS, SUCCESS)
antipattern_report_status_message	string	The status message of the anti-pattern report. (pattern: <code>.\S.</code>)
last_analyzed_timestamp	string (date-time)	The time the assessment was performed.
list_antipattern_severity_summary	array	List of AntipatternSeveritySummary.
list_application_component_status_summary	array	List of status summaries of the analyzed application components.
list_application_component_strategy_summary	array	List of ApplicationComponentStrategySummary.
list_application_component_summary	array	List of ApplicationComponentSummary.
list_server_status_summary	array	List of status summaries of the analyzed servers.
list_server_strategy_summary	array	List of ServerStrategySummary.
list_server_summary	array	List of ServerSummary.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_portfolio_summary	select	region		Retrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_portfolio_summary

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

SELECT
antipattern_report_s3_object,
antipattern_report_status,
antipattern_report_status_message,
last_analyzed_timestamp,
list_antipattern_severity_summary,
list_application_component_status_summary,
list_application_component_strategy_summary,
list_application_component_summary,
list_server_status_summary,
list_server_strategy_summary,
list_server_summary
FROM aws.migrationhubstrategy.portfolio_summaries
WHERE region = '{{ region }}' -- required
;