Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.
Parameters:
-
filters
(Optional[AutomationEventFilterList], default:
None
)
–
The filters to apply to the list of automation event summaries.
-
start_date_inclusive
(Optional[str], default:
None
)
–
The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.
-
end_date_exclusive
(Optional[str], default:
None
)
–
The end date for filtering automation event summaries, exclusive. Events created before this date will be included.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.
-
next_token
(Optional[NextToken], default:
None
)
–
A token used for pagination to retrieve the next set of results when the response is truncated.
Raises:
Source code in docs_src/capo_compute_optimizer_automation/_services/compute_optimizer_automation.py
| def list_automation_event_summaries(
self,
*,
config_overrides: Optional[ComputeOptimizerAutomationClientConfig] = None,
filters: Optional[
"capo_compute_optimizer_automation.types.automation_event_filter_list.AutomationEventFilterList"
] = None,
start_date_inclusive: Optional[str] = None,
end_date_exclusive: Optional[str] = None,
max_results: Optional[int] = None,
next_token: Optional[
"capo_compute_optimizer_automation.types.next_token.NextToken"
] = None,
) -> "capo_compute_optimizer_automation.types.list_automation_event_summaries_response.ListAutomationEventSummariesResponse":
"""<p>Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary. </p>
Args:
filters: <p> The filters to apply to the list of automation event summaries. </p>
start_date_inclusive: <p>The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.</p>
end_date_exclusive: <p>The end date for filtering automation event summaries, exclusive. Events created before this date will be included.</p>
max_results: <p>The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.</p>
next_token: <p>A token used for pagination to retrieve the next set of results when the response is truncated.</p>
Raises:
capo_compute_optimizer_automation.errors.access_denied_exception.AccessDeniedException: <p> You do not have sufficient permissions to perform this action. </p>
capo_compute_optimizer_automation.errors.forbidden_exception.ForbiddenException: <p> You are not authorized to perform this action. </p>
capo_compute_optimizer_automation.errors.internal_server_exception.InternalServerException: <p> An internal error occurred while processing the request. </p>
capo_compute_optimizer_automation.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p> One or more parameter values are not valid. </p>
capo_compute_optimizer_automation.errors.opt_in_required_exception.OptInRequiredException: <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
capo_compute_optimizer_automation.errors.service_unavailable_exception.ServiceUnavailableException: <p> The service is temporarily unavailable. </p>
capo_compute_optimizer_automation.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
capo_compute_optimizer_automation.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_compute_optimizer_automation.types.list_automation_event_summaries_request.ListAutomationEventSummariesRequest]",
) -> OperationResponse[
"capo_compute_optimizer_automation.types.list_automation_event_summaries_response.ListAutomationEventSummariesResponse"
]:
import capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.list_automation_event_summaries
output, http_response = (
capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.list_automation_event_summaries.list_automation_event_summaries(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAutomationEventSummaries")
)
input_: capo_compute_optimizer_automation.types.list_automation_event_summaries_request.ListAutomationEventSummariesRequest = {}
if filters is not None:
input_["filters"] = filters
if start_date_inclusive is not None:
input_["start_date_inclusive"] = start_date_inclusive
if end_date_exclusive is not None:
input_["end_date_exclusive"] = end_date_exclusive
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|