Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.
For more information about extended metrics, see AddRumMetrics.
Parameters:
-
app_monitor_name
(AppMonitorName)
–
The name of the app monitor associated with the destinations that you want to retrieve.
-
max_results
(Optional[MaxResultsInteger], default:
None
)
–
The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.
To retrieve the remaining results, make another call with the returned NextToken value.
-
next_token
(Optional[str], default:
None
)
–
Use the token returned by the previous operation to request the next page of results.
Raises:
Source code in docs_src/capo_rum/_services/async_rum.py
| async def list_rum_metrics_destinations(
self,
app_monitor_name: "capo_rum.types.app_monitor_name.AppMonitorName",
*,
config_overrides: Optional[AsyncRUMClientConfig] = None,
max_results: Optional[
"capo_rum.types.max_results_integer.MaxResultsInteger"
] = None,
next_token: Optional[str] = None,
) -> "capo_rum.types.list_rum_metrics_destinations_response.ListRumMetricsDestinationsResponse":
"""<p>Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.</p> <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html">AddRumMetrics</a>.</p>
Args:
app_monitor_name: <p>The name of the app monitor associated with the destinations that you want to retrieve.</p>
max_results: <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.</p> <p>To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>
next_token: <p>Use the token returned by the previous operation to request the next page of results.</p>
Raises:
capo_rum.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
capo_rum.errors.internal_server_exception.InternalServerException: <p>Internal service exception.</p>
capo_rum.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
capo_rum.errors.validation_exception.ValidationException: <p>One of the arguments for the request is not valid.</p>
capo_rum.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_rum.types.list_rum_metrics_destinations_request.ListRumMetricsDestinationsRequest]",
) -> AsyncOperationResponse[
"capo_rum.types.list_rum_metrics_destinations_response.ListRumMetricsDestinationsResponse"
]:
import capo_rum._operations.rum.list_rum_metrics_destinations
(
output,
http_response,
) = await capo_rum._operations.rum.list_rum_metrics_destinations.async_list_rum_metrics_destinations(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListRumMetricsDestinations")
)
input_: capo_rum.types.list_rum_metrics_destinations_request.ListRumMetricsDestinationsRequest = {
"app_monitor_name": app_monitor_name
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|