Skip to content

list_resource_grouping_recommendations async

list_resource_grouping_recommendations(
    *,
    config_overrides: Optional[AsyncresiliencehubClientConfig] = None,
    app_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListResourceGroupingRecommendationsResponse

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

Parameters:

  • app_arn (Optional[Arn], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

    Null, or the token from a previous call to get the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    Maximum number of grouping recommendations to be displayed per Resilience Hub application.

Raises:

  • AccessDeniedException –

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

  • InternalServerException –

    This exception occurs when there is an internal failure in the Resilience Hub service.

  • ResourceNotFoundException –

    This exception occurs when the specified resource could not be found.

  • ThrottlingException –

    This exception occurs when you have exceeded the limit on the number of requests per second.

  • ValidationException –

    This exception occurs when a request is not valid.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_resiliencehub/_services/async_resiliencehub.py
async def list_resource_grouping_recommendations(
    self,
    *,
    config_overrides: Optional[AsyncresiliencehubClientConfig] = None,
    app_arn: Optional["capo_resiliencehub.types.arn.Arn"] = None,
    next_token: Optional["capo_resiliencehub.types.next_token.NextToken"] = None,
    max_results: Optional["capo_resiliencehub.types.max_results.MaxResults"] = None,
) -> "capo_resiliencehub.types.list_resource_grouping_recommendations_response.ListResourceGroupingRecommendationsResponse":
    """<p>Lists the resource grouping recommendations suggested by Resilience Hub for your application.</p>

    Args:
        app_arn: <p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>
        next_token: <p>Null, or the token from a previous call to get the next set of results.</p>
        max_results: <p>Maximum number of grouping recommendations to be displayed per Resilience Hub application.</p>

    Raises:
        capo_resiliencehub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.</p>
        capo_resiliencehub.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Resilience Hub service.</p>
        capo_resiliencehub.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception occurs when the specified resource could not be found.</p>
        capo_resiliencehub.errors.throttling_exception.ThrottlingException: <p>This exception occurs when you have exceeded the limit on the number of requests per second.</p>
        capo_resiliencehub.errors.validation_exception.ValidationException: <p>This exception occurs when a request is not valid.</p>
        capo_resiliencehub.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_resiliencehub.types.list_resource_grouping_recommendations_request.ListResourceGroupingRecommendationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_resiliencehub.types.list_resource_grouping_recommendations_response.ListResourceGroupingRecommendationsResponse"
    ]:
        import capo_resiliencehub._operations.aws_resilience_hub.list_resource_grouping_recommendations

        (
            output,
            http_response,
        ) = await capo_resiliencehub._operations.aws_resilience_hub.list_resource_grouping_recommendations.async_list_resource_grouping_recommendations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListResourceGroupingRecommendations")
    )
    input_: capo_resiliencehub.types.list_resource_grouping_recommendations_request.ListResourceGroupingRecommendationsRequest = {}
    if app_arn is not None:
        input_["app_arn"] = app_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output