CloudWatchRUM / Client / list_rum_metrics_destinations

list_rum_metrics_destinations#

CloudWatchRUM.Client.list_rum_metrics_destinations(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_rum_metrics_destinations(
    AppMonitorName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AppMonitorName (string) –

    [REQUIRED]

    The name of the app monitor associated with the destinations that you want to retrieve.

  • MaxResults (integer) –

    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.

  • NextToken (string) – Use the token returned by the previous operation to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Destinations': [
        {
            'Destination': 'CloudWatch'|'Evidently',
            'DestinationArn': 'string',
            'IamRoleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Destinations (list) –

      The list of CloudWatch RUM extended metrics destinations associated with the app monitor that you specified.

      • (dict) –

        A structure that displays information about one destination that CloudWatch RUM sends extended metrics to.

        • Destination (string) –

          Specifies whether the destination is CloudWatch or Evidently.

        • DestinationArn (string) –

          If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives the metrics.

        • IamRoleArn (string) –

          This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.

    • NextToken (string) –

      A token that you can use in a subsequent operation to retrieve the next set of results.

Exceptions

  • CloudWatchRUM.Client.exceptions.ResourceNotFoundException

  • CloudWatchRUM.Client.exceptions.InternalServerException

  • CloudWatchRUM.Client.exceptions.ValidationException

  • CloudWatchRUM.Client.exceptions.AccessDeniedException