Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCostEstimation

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

Request Syntax


GET /cost-estimation?NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

NextToken

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Costs": [ 
      { 
         "Cost": number,
         "Count": number,
         "State": "string",
         "Type": "string",
         "UnitCost": number
      }
   ],
   "NextToken": "string",
   "ResourceCollection": { 
      "CloudFormation": { 
         "StackNames": [ "string" ]
      },
      "Tags": [ 
         { 
            "AppBoundaryKey": "string",
            "TagValues": [ "string" ]
         }
      ]
   },
   "Status": "string",
   "TimeRange": { 
      "EndTime": number,
      "StartTime": number
   },
   "TotalCost": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Costs

An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.

Type: Array of ServiceResourceCost objects

NextToken

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

ResourceCollection

The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.

Type: CostEstimationResourceCollectionFilter object

Status

The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.

Type: String

Valid Values: ONGOING | COMPLETED

TimeRange

The start and end time of the cost estimation.

Type: CostEstimationTimeRange object

TotalCost

The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.

Type: Double

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

InternalServerException

An internal failure in an Amazon service occurred.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource could not be found

HTTP Status Code: 404

ThrottlingException

The request was denied due to a request throttling.

HTTP Status Code: 429

ValidationException

Contains information about data passed in to a field during a request that is not valid.

HTTP Status Code: 400