Skip to content

ListMetricsRequest

Source code in docs_src/capo_resiliencehub/types/list_metrics_request.py
class ListMetricsRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_resiliencehub.types.next_token.NextToken"]
    """<p>Null, or the token from a previous call to get the next set of results.</p>"""
    max_results: NotRequired["capo_resiliencehub.types.max_results.MaxResults"]
    """<p>Maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>"""
    fields: NotRequired["capo_resiliencehub.types.field_list.FieldList"]
    """<p>Indicates the list of fields in the data source.</p>"""
    data_source: NotRequired["capo_resiliencehub.types.string255.String255"]
    """<p>Indicates the data source of the metrics.</p>"""
    conditions: NotRequired["capo_resiliencehub.types.condition_list.ConditionList"]
    """<p>Indicates the list of all the conditions that were applied on the metrics.</p>"""
    sorts: NotRequired["capo_resiliencehub.types.sort_list.SortList"]
    """<p>(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.</p>"""

conditions instance-attribute

conditions: NotRequired[ConditionList]

Indicates the list of all the conditions that were applied on the metrics.

data_source instance-attribute

data_source: NotRequired[String255]

Indicates the data source of the metrics.

fields instance-attribute

fields: NotRequired[FieldList]

Indicates the list of fields in the data source.

max_results instance-attribute

max_results: NotRequired[MaxResults]

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

next_token instance-attribute

next_token: NotRequired[NextToken]

Null, or the token from a previous call to get the next set of results.

sorts instance-attribute

sorts: NotRequired[SortList]

(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.