Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetBucketMetricData

Returns the data points of a specific metric for an Amazon Lightsail bucket.

Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

Request Syntax


{
   "bucketName": "string",
   "endTime": number,
   "metricName": "string",
   "period": number,
   "startTime": number,
   "statistics": [ "string" ],
   "unit": "string"
}

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.

bucketName

The name of the bucket for which to get metric data.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 54.

Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$

Required: Yes

endTime

The timestamp indicating the latest data to be returned.

Type: Timestamp

Required: Yes

metricName

The metric for which you want to return information.

Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

Note

These bucket metrics are reported once per day.

BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket.

Statistics: The most useful statistic is Maximum.

Unit: The published unit is Bytes.
NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket.

Statistics: The most useful statistic is Average.

Unit: The published unit is Count.

Type: String

Valid Values: BucketSizeBytes | NumberOfObjects

Required: Yes

period

The granularity, in seconds, of the returned data points.

Note

Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 86400.

Required: Yes

startTime

The timestamp indicating the earliest data to be returned.

Type: Timestamp

Required: Yes

statistics

The statistic for the metric.

The following statistics are available:

Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric.
Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
SampleCount - The count, or number, of data points used for the statistical calculation.

Type: Array of strings

Valid Values: Minimum | Maximum | Sum | Average | SampleCount

Required: Yes

unit

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Type: String

Required: Yes

Response Syntax


{
   "metricData": [ 
      { 
         "average": number,
         "maximum": number,
         "minimum": number,
         "sampleCount": number,
         "sum": number,
         "timestamp": number,
         "unit": "string"
      }
   ],
   "metricName": "string"
}

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.

metricData

An array of objects that describe the metric data returned.

Type: Array of MetricDatapoint objects

metricName

The name of the metric returned.

Type: String

Valid Values: BucketSizeBytes | NumberOfObjects

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