Returns a list of scheduled reports in your account.
Parameters:
-
next_token
(Optional[NextPageToken], default:
None
)
–
The token for the next page of results. Use the value returned in the previous response.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in a single call. Valid range is 1 to 100. The default value is 50.
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.
-
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/bcm_dashboards.py
| def list_scheduled_reports(
self,
*,
config_overrides: Optional[BCMDashboardsClientConfig] = None,
next_token: Optional[
"capo_bcm_dashboards.types.next_page_token.NextPageToken"
] = None,
max_results: Optional[
"capo_bcm_dashboards.types.max_results.MaxResults"
] = None,
) -> "capo_bcm_dashboards.types.list_scheduled_reports_response.ListScheduledReportsResponse":
"""<p>Returns a list of scheduled reports in your account.</p>
Args:
next_token: <p>The token for the next page of results. Use the value returned in the previous response.</p>
max_results: <p>The maximum number of results to return in a single call. Valid range is 1 to 100. The default value is 50.</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.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.
"""
def _handler(
req: "OperationRequest[capo_bcm_dashboards.types.list_scheduled_reports_request.ListScheduledReportsRequest]",
) -> OperationResponse[
"capo_bcm_dashboards.types.list_scheduled_reports_response.ListScheduledReportsResponse"
]:
import capo_bcm_dashboards._operations.awsbcm_dashboards_service.list_scheduled_reports
output, http_response = (
capo_bcm_dashboards._operations.awsbcm_dashboards_service.list_scheduled_reports.list_scheduled_reports(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListScheduledReports")
)
input_: capo_bcm_dashboards.types.list_scheduled_reports_request.ListScheduledReportsRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|