Skip to content

ListMetricsInput

Source code in docs_src/capo_cloudwatch/types/list_metrics_input.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ListMetricsInput(TypedDict, closed=True):
    namespace: NotRequired["capo_cloudwatch.types.namespace.Namespace"]
    """<p>The metric namespace to filter against. Only the namespace that matches exactly will be returned.</p>"""
    metric_name: NotRequired["capo_cloudwatch.types.metric_name.MetricName"]
    """<p>The name of the metric to filter against. Only the metrics with names that match exactly will be returned.</p>"""
    dimensions: NotRequired["capo_cloudwatch.types.dimension_filters.DimensionFilters"]
    """<p>The dimensions to filter against. Only the dimension with names that match exactly will be returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.</p>"""
    next_token: NotRequired["capo_cloudwatch.types.next_token.NextToken"]
    """<p>The token returned by a previous call to indicate that there is more data available.</p>"""
    recently_active: NotRequired["capo_cloudwatch.types.recently_active.RecentlyActive"]
    """<p>To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of <code>PT3H</code>. This is the only valid value for this parameter.</p> <p>The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 50 minutes more than the specified time interval.</p>"""
    include_linked_accounts: NotRequired[
        "capo_cloudwatch.types.include_linked_accounts.IncludeLinkedAccounts"
    ]
    """<p>If you are using this operation in a monitoring account, specify <code>true</code> to include metrics from source accounts in the returned data.</p> <p>The default is <code>false</code>.</p>"""
    owning_account: NotRequired["capo_cloudwatch.types.account_id.AccountId"]
    """<p>When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify <code>true</code> for <code>IncludeLinkedAccounts</code>.</p>"""

dimensions instance-attribute 

dimensions: NotRequired[DimensionFilters]

The dimensions to filter against. Only the dimension with names that match exactly will be returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.

include_linked_accounts instance-attribute 

include_linked_accounts: NotRequired[IncludeLinkedAccounts]

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

metric_name instance-attribute 

metric_name: NotRequired[MetricName]

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

namespace instance-attribute 

namespace: NotRequired[Namespace]

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token returned by a previous call to indicate that there is more data available.

owning_account instance-attribute 

owning_account: NotRequired[AccountId]

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

recently_active instance-attribute 

recently_active: NotRequired[RecentlyActive]

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 50 minutes more than the specified time interval.