Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.
You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).
Parameters:
-
next_token
(Optional[str], default:
None
)
–
The token for the next set of results. You receive this token from a previous call.
-
max_results
(Optional[InternetEventMaxResults], default:
None
)
–
The number of query results that you want to return with this call.
-
start_time
(Optional[datetime], default:
None
)
–
The start time of the time window that you want to get a list of internet events for.
-
end_time
(Optional[datetime], default:
None
)
–
The end time of the time window that you want to get a list of internet events for.
-
event_status
(Optional[str], default:
None
)
–
The status of an internet event.
-
event_type
(Optional[str], default:
None
)
–
The type of network impairment.
Raises:
Source code in docs_src/capo_internetmonitor/_services/internet_monitor.py
| def list_internet_events(
self,
*,
config_overrides: Optional[InternetMonitorClientConfig] = None,
next_token: Optional[str] = None,
max_results: Optional[
"capo_internetmonitor.types.internet_event_max_results.InternetEventMaxResults"
] = None,
start_time: Optional[datetime.datetime] = None,
end_time: Optional[datetime.datetime] = None,
event_status: Optional[str] = None,
event_type: Optional[str] = None,
) -> "capo_internetmonitor.types.list_internet_events_output.ListInternetEventsOutput":
"""<p>Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. </p> <p>You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.</p> <p>You can also limit the events returned to a specific status (<code>ACTIVE</code> or <code>RESOLVED</code>) or type (<code>PERFORMANCE</code> or <code>AVAILABILITY</code>).</p>
Args:
next_token: <p>The token for the next set of results. You receive this token from a previous call.</p>
max_results: <p>The number of query results that you want to return with this call.</p>
start_time: <p>The start time of the time window that you want to get a list of internet events for.</p>
end_time: <p>The end time of the time window that you want to get a list of internet events for.</p>
event_status: <p>The status of an internet event.</p>
event_type: <p>The type of network impairment.</p>
Raises:
capo_internetmonitor.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
capo_internetmonitor.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
capo_internetmonitor.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_internetmonitor.errors.validation_exception.ValidationException: <p>Invalid request.</p>
capo_internetmonitor.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_internetmonitor.types.list_internet_events_input.ListInternetEventsInput]",
) -> OperationResponse[
"capo_internetmonitor.types.list_internet_events_output.ListInternetEventsOutput"
]:
import capo_internetmonitor._operations.internet_monitor20210603.list_internet_events
output, http_response = (
capo_internetmonitor._operations.internet_monitor20210603.list_internet_events.list_internet_events(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListInternetEvents")
)
input_: capo_internetmonitor.types.list_internet_events_input.ListInternetEventsInput = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if start_time is not None:
input_["start_time"] = start_time
if end_time is not None:
input_["end_time"] = end_time
if event_status is not None:
input_["event_status"] = event_status
if event_type is not None:
input_["event_type"] = event_type
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|