Skip to content

list_report_definitions async

list_report_definitions(
    *,
    config_overrides: Optional[AsyncApplicationCostProfilerClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[Integer] = None,
) -> ListReportDefinitionsResult

Retrieves a list of all reports and their configurations for your AWS account.

The maximum number of reports is one.

Parameters:

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

    The token value from a previous call to access the next page of results.

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

    The maximum number of results to return.

Raises:

Source code in docs_src/capo_applicationcostprofiler/_services/async_application_cost_profiler.py
async def list_report_definitions(
    self,
    *,
    config_overrides: Optional[AsyncApplicationCostProfilerClientConfig] = None,
    next_token: Optional["capo_applicationcostprofiler.types.token.Token"] = None,
    max_results: Optional[
        "capo_applicationcostprofiler.types.integer.Integer"
    ] = None,
) -> "capo_applicationcostprofiler.types.list_report_definitions_result.ListReportDefinitionsResult":
    """<p>Retrieves a list of all reports and their configurations for your AWS account.</p> <p>The maximum number of reports is one.</p>

    Args:
        next_token: <p>The token value from a previous call to access the next page of results.</p>
        max_results: <p>The maximum number of results to return.</p>

    Raises:
        capo_applicationcostprofiler.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this action.</p>
        capo_applicationcostprofiler.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_applicationcostprofiler.errors.throttling_exception.ThrottlingException: <p>The calls to AWS Application Cost Profiler API are throttled. The request was denied.</p>
        capo_applicationcostprofiler.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints for the API.</p>
        capo_applicationcostprofiler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_applicationcostprofiler.types.list_report_definitions_request.ListReportDefinitionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_applicationcostprofiler.types.list_report_definitions_result.ListReportDefinitionsResult"
    ]:
        import capo_applicationcostprofiler._operations.aws_application_cost_profiler.list_report_definitions

        (
            output,
            http_response,
        ) = await capo_applicationcostprofiler._operations.aws_application_cost_profiler.list_report_definitions.async_list_report_definitions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReportDefinitions")
    )
    input_: capo_applicationcostprofiler.types.list_report_definitions_request.ListReportDefinitionsRequest = {}
    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