resource_grouping_recommendations

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

Overview

Name	resource_grouping_recommendations
Type	Resource
Id	aws.resiliencehub.resource_grouping_recommendations

Fields

The following fields are returned by SELECT queries:

list_resource_grouping_recommendations

Name	Datatype	Description
confidence_level	string	Indicates the confidence level of Resilience Hub on the grouping recommendation. (High, Medium)
creation_time	string (date-time)	Indicates the creation time of the grouping recommendation.
grouping_app_component	object	Indicates the name of the recommended Application Component (AppComponent).
grouping_recommendation_id	string	Indicates all the reasons available for rejecting a grouping recommendation.
recommendation_reasons	array	Indicates all the reasons available for rejecting a grouping recommendation.
rejection_reason	string	Indicates the reason you had selected while rejecting a grouping recommendation. (DistinctBusinessPurpose, SeparateDataConcern, DistinctUserGroupHandling, Other)
resources	array	Indicates the resources that are grouped in a recommended AppComponent.
score	number (double)	Indicates the confidence level of the grouping recommendation.
status	string	Indicates the status of grouping resources into AppComponents. (Accepted, Rejected, PendingDecision)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_resource_grouping_recommendations	select	region	appArn, maxResults, nextToken	Lists the resource grouping recommendations suggested by Resilience Hub for your application.
accept_resource_grouping_recommendations	exec	region, appArn, entries		Accepts the resource grouping recommendations suggested by Resilience Hub for your application.
reject_resource_grouping_recommendations	exec	region, appArn, entries		Rejects resource grouping recommendations.
start_resource_grouping_recommendation_task	exec	region, appArn		Starts grouping recommendation task.

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)
appArn	string	Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.
maxResults	integer	Maximum number of grouping recommendations to be displayed per Resilience Hub application.
nextToken	string	Null, or the token from a previous call to get the next set of results.

SELECT examples

list_resource_grouping_recommendations

Lists the resource grouping recommendations suggested by Resilience Hub for your application.

SELECT
confidence_level,
creation_time,
grouping_app_component,
grouping_recommendation_id,
recommendation_reasons,
rejection_reason,
resources,
score,
status
FROM aws.resiliencehub.resource_grouping_recommendations
WHERE region = '{{ region }}' -- required
AND appArn = '{{ appArn }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

Lifecycle Methods

accept_resource_grouping_recommendations

Accepts the resource grouping recommendations suggested by Resilience Hub for your application.

EXEC aws.resiliencehub.resource_grouping_recommendations.accept_resource_grouping_recommendations 
@region='{{ region }}' --required 
@@json=
'{
"appArn": "{{ appArn }}", 
"entries": "{{ entries }}"
}'
;

reject_resource_grouping_recommendations

Rejects resource grouping recommendations.

EXEC aws.resiliencehub.resource_grouping_recommendations.reject_resource_grouping_recommendations 
@region='{{ region }}' --required 
@@json=
'{
"appArn": "{{ appArn }}", 
"entries": "{{ entries }}"
}'
;

start_resource_grouping_recommendation_task

Starts grouping recommendation task.

EXEC aws.resiliencehub.resource_grouping_recommendations.start_resource_grouping_recommendation_task 
@region='{{ region }}' --required 
@@json=
'{
"appArn": "{{ appArn }}"
}'
;