CloudWatchRUM / Paginator / ListRumMetricsDestinations

ListRumMetricsDestinations¶

class CloudWatchRUM.Paginator.ListRumMetricsDestinations¶

paginator = client.get_paginator('list_rum_metrics_destinations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CloudWatchRUM.Client.list_rum_metrics_destinations().

Request Syntax

response_iterator = paginator.paginate(
    AppMonitorName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

AppMonitorName (string) –
[REQUIRED]

The name of the app monitor associated with the destinations that you want to retrieve.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Destinations': [
        {
            'Destination': 'CloudWatch'|'Evidently',
            'DestinationArn': 'string',
            'IamRoleArn': '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.