get_resource_metrics async ¶

async def get_resource_metrics(
    self,
    service_type: "capo_pi.types.service_type.ServiceType",
    identifier: "capo_pi.types.identifier_string.IdentifierString",
    metric_queries: "capo_pi.types.metric_query_list.MetricQueryList",
    start_time: "capo_pi.types.iso_timestamp.ISOTimestamp",
    end_time: "capo_pi.types.iso_timestamp.ISOTimestamp",
    *,
    config_overrides: Optional[AsyncPIClientConfig] = None,
    period_in_seconds: Optional["capo_pi.types.integer.Integer"] = None,
    max_results: Optional["capo_pi.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_pi.types.next_token.NextToken"] = None,
    period_alignment: Optional[
        "capo_pi.types.period_alignment.PeriodAlignment"
    ] = None,
) -> "capo_pi.types.get_resource_metrics_response.GetResourceMetricsResponse":
    """<p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.</p> <note> <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.</p> </note>

    Args:
        service_type: <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p> <ul> <li> <p> <code>RDS</code> </p> </li> <li> <p> <code>DOCDB</code> </p> </li> </ul>
        identifier: <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is returned as <code>DbiResourceId</code>.</p> <p>To use a DB instance as a data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
        metric_queries: <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric <code>db.load</code> you must use <code>db.load.avg</code>. Valid values for aggregate functions include <code>.avg</code>, <code>.min</code>, <code>.max</code>, and <code>.sum</code>.</p>
        start_time: <p>The date and time specifying the beginning of the requested time series query range. You can't specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is <i>inclusive</i>. Thus, the command returns data points equal to or greater than <code>StartTime</code>.</p> <p>The value for <code>StartTime</code> must be earlier than the value for <code>EndTime</code>.</p>
        end_time: <p>The date and time specifying the end of the requested time series query range. The value specified is <i>exclusive</i>. Thus, the command returns data points less than (but not equal to) <code>EndTime</code>.</p> <p>The value for <code>EndTime</code> must be later than the value for <code>StartTime</code>.</p>
        period_in_seconds: <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:</p> <ul> <li> <p> <code>1</code> (one second)</p> </li> <li> <p> <code>60</code> (one minute)</p> </li> <li> <p> <code>300</code> (five minutes)</p> </li> <li> <p> <code>3600</code> (one hour)</p> </li> <li> <p> <code>86400</code> (twenty-four hours)</p> </li> </ul> <p>If you don't specify <code>PeriodInSeconds</code>, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.</p>
        max_results: <p>The maximum number of items to return in the response.</p>
        next_token: <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
        period_alignment: <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>

    Raises:
        capo_pi.errors.internal_service_error.InternalServiceError: <p>The request failed due to an unknown error.</p>
        capo_pi.errors.invalid_argument_exception.InvalidArgumentException: <p>One of the arguments provided is invalid for this request.</p>
        capo_pi.errors.not_authorized_exception.NotAuthorizedException: <p>The user is not authorized to perform this request.</p>
        capo_pi.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pi.types.get_resource_metrics_request.GetResourceMetricsRequest]",
    ) -> AsyncOperationResponse[
        "capo_pi.types.get_resource_metrics_response.GetResourceMetricsResponse"
    ]:
        import capo_pi._operations.performance_insightsv20180227.get_resource_metrics

        (
            output,
            http_response,
        ) = await capo_pi._operations.performance_insightsv20180227.get_resource_metrics.async_get_resource_metrics(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetResourceMetrics")
    )
    input_: capo_pi.types.get_resource_metrics_request.GetResourceMetricsRequest = {
        "service_type": service_type,
        "identifier": identifier,
        "metric_queries": metric_queries,
        "start_time": start_time,
        "end_time": end_time,
    }
    if period_in_seconds is not None:
        input_["period_in_seconds"] = period_in_seconds
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if period_alignment is not None:
        input_["period_alignment"] = period_alignment

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output