Skip to content

get_ecs_service_recommendation_projected_metrics 

get_ecs_service_recommendation_projected_metrics(
    service_arn: ServiceArn,
    stat: MetricStatistic,
    period: Period,
    start_time: Timestamp,
    end_time: Timestamp,
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
) -> GetECSServiceRecommendationProjectedMetricsResponse

Returns the projected metrics of Amazon ECS service recommendations.

Parameters:

  • service_arn (ServiceArn) –

    The ARN that identifies the Amazon ECS service.

    The following is the format of the ARN:

    arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name

  • stat (MetricStatistic) –

    The statistic of the projected metrics.

  • period (Period) –

    The granularity, in seconds, of the projected metrics data points.

  • start_time (Timestamp) –

    The timestamp of the first projected metrics data point to return.

  • end_time (Timestamp) –

    The timestamp of the last projected metrics data point to return.

Raises:

Source code in docs_src/capo_compute_optimizer/_services/compute_optimizer.py 
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
def get_ecs_service_recommendation_projected_metrics(
    self,
    service_arn: "capo_compute_optimizer.types.service_arn.ServiceArn",
    stat: "capo_compute_optimizer.types.metric_statistic.MetricStatistic",
    period: "capo_compute_optimizer.types.period.Period",
    start_time: "capo_compute_optimizer.types.timestamp.Timestamp",
    end_time: "capo_compute_optimizer.types.timestamp.Timestamp",
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
) -> "capo_compute_optimizer.types.get_ecs_service_recommendation_projected_metrics_response.GetECSServiceRecommendationProjectedMetricsResponse":
    """<p> Returns the projected metrics of Amazon ECS service recommendations. </p>

    Args:
        service_arn: <p> The ARN that identifies the Amazon ECS service. </p> <p> The following is the format of the ARN: </p> <p> <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code> </p>
        stat: <p> The statistic of the projected metrics. </p>
        period: <p> The granularity, in seconds, of the projected metrics data points. </p>
        start_time: <p> The timestamp of the first projected metrics data point to return. </p>
        end_time: <p> The timestamp of the last projected metrics data point to return. </p>

    Raises:
        capo_compute_optimizer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_compute_optimizer.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Try your call again.</p>
        capo_compute_optimizer.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value supplied for the input parameter is out of range or not valid.</p>
        capo_compute_optimizer.errors.missing_authentication_token.MissingAuthenticationToken: <p>The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.</p>
        capo_compute_optimizer.errors.opt_in_required_exception.OptInRequiredException: <p>The account is not opted in to Compute Optimizer.</p>
        capo_compute_optimizer.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_compute_optimizer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the server.</p>
        capo_compute_optimizer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_compute_optimizer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_compute_optimizer.types.get_ecs_service_recommendation_projected_metrics_request.GetECSServiceRecommendationProjectedMetricsRequest]",
    ) -> OperationResponse[
        "capo_compute_optimizer.types.get_ecs_service_recommendation_projected_metrics_response.GetECSServiceRecommendationProjectedMetricsResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.get_ecs_service_recommendation_projected_metrics

        output, http_response = (
            capo_compute_optimizer._operations.compute_optimizer_service.get_ecs_service_recommendation_projected_metrics.get_ecs_service_recommendation_projected_metrics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetECSServiceRecommendationProjectedMetrics"),
    )
    input_: capo_compute_optimizer.types.get_ecs_service_recommendation_projected_metrics_request.GetECSServiceRecommendationProjectedMetricsRequest = {
        "service_arn": service_arn,
        "stat": stat,
        "period": period,
        "start_time": start_time,
        "end_time": end_time,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output