ResilienceHub / Client / start_resource_grouping_recommendation_task

start_resource_grouping_recommendation_task#

ResilienceHub.Client.start_resource_grouping_recommendation_task(**kwargs)#

Starts grouping recommendation task.

Request Syntax

response = client.start_resource_grouping_recommendation_task(
    appArn='string'
)

Parameters:

appArn (string) –

[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'appArn': 'string',
    'errorMessage': 'string',
    'groupingId': 'string',
    'status': 'Pending'|'InProgress'|'Failed'|'Success'
}

Response Structure

(dict) –
- 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.
- errorMessage (string) –
  
  Error that occurred while executing a grouping recommendation task.
- groupingId (string) –
  
  Identifier of the grouping recommendation task.
- status (string) –
  
  Status of the action.

Exceptions

ResilienceHub.Client.exceptions.InternalServerException
ResilienceHub.Client.exceptions.ResourceNotFoundException
ResilienceHub.Client.exceptions.ConflictException
ResilienceHub.Client.exceptions.ThrottlingException
ResilienceHub.Client.exceptions.ValidationException
ResilienceHub.Client.exceptions.AccessDeniedException