Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetCostEstimate

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

Request Syntax


{
   "endTime": number,
   "resourceName": "string",
   "startTime": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

endTime

The cost estimate end time.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Type: Timestamp

Required: Yes

resourceName

The resource name.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

startTime

The cost estimate start time.

Constraints:

Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Type: Timestamp

Required: Yes

Response Syntax


{
   "resourcesBudgetEstimate": [ 
      { 
         "costEstimates": [ 
            { 
               "resultsByTime": [ 
                  { 
                     "currency": "string",
                     "pricingUnit": "string",
                     "timePeriod": { 
                        "end": number,
                        "start": number
                     },
                     "unit": number,
                     "usageCost": number
                  }
               ],
               "usageType": "string"
            }
         ],
         "endTime": number,
         "resourceName": "string",
         "resourceType": "string",
         "startTime": 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.

resourcesBudgetEstimate

Returns the estimate's forecasted cost or usage.

Type: Array of ResourceBudgetEstimate objects

Errors

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

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400