Skip to content

get_scheduled_report async

get_scheduled_report(
    arn: ScheduledReportArn,
    *,
    config_overrides: Optional[AsyncBCMDashboardsClientConfig] = None,
) -> GetScheduledReportResponse

Retrieves the configuration and metadata of a specified scheduled report.

Parameters:

Raises:

  • AccessDeniedException –

    You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

  • InternalServerException –

    An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.

  • ResourceNotFoundException –

    The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.

  • ThrottlingException –

    The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

  • ValidationException –

    The input parameters do not satisfy the requirements. Check the error message for specific validation details.

  • UnknownServiceError –

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

Source code in docs_src/capo_bcm_dashboards/_services/async_bcm_dashboards.py
async def get_scheduled_report(
    self,
    arn: "capo_bcm_dashboards.types.scheduled_report_arn.ScheduledReportArn",
    *,
    config_overrides: Optional[AsyncBCMDashboardsClientConfig] = None,
) -> "capo_bcm_dashboards.types.get_scheduled_report_response.GetScheduledReportResponse":
    """<p>Retrieves the configuration and metadata of a specified scheduled report.</p>

    Args:
        arn: <p>The ARN of the scheduled report to retrieve.</p>

    Raises:
        capo_bcm_dashboards.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.</p>
        capo_bcm_dashboards.errors.internal_server_exception.InternalServerException: <p>An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Web Services Support.</p>
        capo_bcm_dashboards.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.</p>
        capo_bcm_dashboards.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.</p>
        capo_bcm_dashboards.errors.validation_exception.ValidationException: <p>The input parameters do not satisfy the requirements. Check the error message for specific validation details.</p>
        capo_bcm_dashboards.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bcm_dashboards.types.get_scheduled_report_request.GetScheduledReportRequest]",
    ) -> AsyncOperationResponse[
        "capo_bcm_dashboards.types.get_scheduled_report_response.GetScheduledReportResponse"
    ]:
        import capo_bcm_dashboards._operations.awsbcm_dashboards_service.get_scheduled_report

        (
            output,
            http_response,
        ) = await capo_bcm_dashboards._operations.awsbcm_dashboards_service.get_scheduled_report.async_get_scheduled_report(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetScheduledReport")
    )
    input_: capo_bcm_dashboards.types.get_scheduled_report_request.GetScheduledReportRequest = {
        "arn": arn
    }

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