ResilienceHub / Client / describe_resource_grouping_recommendation_task

describe_resource_grouping_recommendation_task#

ResilienceHub.Client.describe_resource_grouping_recommendation_task(**kwargs)#

Describes the resource grouping recommendation tasks run by Resilience Hub for your application.

See also: AWS API Documentation

Request Syntax

response = client.describe_resource_grouping_recommendation_task(
    appArn='string',
    groupingId='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.

  • groupingId (string) – Indicates the identifier of the grouping recommendation task.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • errorMessage (string) –

      Indicates the error that occurred while generating a grouping recommendation.

    • groupingId (string) –

      Indicates the identifier of the grouping recommendation task.

    • status (string) –

      Status of the action.

Exceptions

  • ResilienceHub.Client.exceptions.InternalServerException

  • ResilienceHub.Client.exceptions.ResourceNotFoundException

  • ResilienceHub.Client.exceptions.ThrottlingException

  • ResilienceHub.Client.exceptions.ValidationException

  • ResilienceHub.Client.exceptions.AccessDeniedException