Skip to content

list_recommendations

list_recommendations(
    insight_id: InsightId,
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    next_token: Optional[UuidNextToken] = None,
    locale: Optional[Locale] = None,
    account_id: Optional[AwsAccountId] = None,
) -> ListRecommendationsResponse

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Parameters:

  • insight_id (InsightId) –

    The ID of the requested insight.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • locale (Optional[Locale], default: None ) –

    A locale that specifies the language to use for recommendations.

  • account_id (Optional[AwsAccountId], default: None ) –

    The ID of the Amazon Web Services account.

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. For more information, see Access Management in the IAM User Guide.

  • InternalServerException –

    An internal failure in an Amazon service occurred.

  • ResourceNotFoundException –

    A requested resource could not be found

  • ThrottlingException –

    The request was denied due to a request throttling.

  • ValidationException –

    Contains information about data passed in to a field during a request that is not valid.

  • UnknownServiceError –

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

Source code in docs_src/capo_devops_guru/_services/dev_ops_guru.py
def list_recommendations(
    self,
    insight_id: "capo_devops_guru.types.insight_id.InsightId",
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    next_token: Optional[
        "capo_devops_guru.types.uuid_next_token.UuidNextToken"
    ] = None,
    locale: Optional["capo_devops_guru.types.locale.Locale"] = None,
    account_id: Optional[
        "capo_devops_guru.types.aws_account_id.AwsAccountId"
    ] = None,
) -> "capo_devops_guru.types.list_recommendations_response.ListRecommendationsResponse":
    """<p> Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. </p>

    Args:
        insight_id: <p> The ID of the requested insight. </p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
        locale: <p>A locale that specifies the language to use for recommendations.</p>
        account_id: <p>The ID of the Amazon Web Services account. </p>

    Raises:
        capo_devops_guru.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. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </p>
        capo_devops_guru.errors.internal_server_exception.InternalServerException: <p>An internal failure in an Amazon service occurred.</p>
        capo_devops_guru.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource could not be found</p>
        capo_devops_guru.errors.throttling_exception.ThrottlingException: <p>The request was denied due to a request throttling.</p>
        capo_devops_guru.errors.validation_exception.ValidationException: <p> Contains information about data passed in to a field during a request that is not valid. </p>
        capo_devops_guru.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_devops_guru.types.list_recommendations_request.ListRecommendationsRequest]",
    ) -> OperationResponse[
        "capo_devops_guru.types.list_recommendations_response.ListRecommendationsResponse"
    ]:
        import capo_devops_guru._operations.capstone_control_plane_service.list_recommendations

        output, http_response = (
            capo_devops_guru._operations.capstone_control_plane_service.list_recommendations.list_recommendations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecommendations")
    )
    input_: capo_devops_guru.types.list_recommendations_request.ListRecommendationsRequest = {
        "insight_id": insight_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if locale is not None:
        input_["locale"] = locale
    if account_id is not None:
        input_["account_id"] = account_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output