Lightsail / Client / get_distribution_metric_data

get_distribution_metric_data#

Lightsail.Client.get_distribution_metric_data(**kwargs)#

Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

Request Syntax

response = client.get_distribution_metric_data(
    distributionName='string',
    metricName='Requests'|'BytesDownloaded'|'BytesUploaded'|'TotalErrorRate'|'Http4xxErrorRate'|'Http5xxErrorRate',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    period=123,
    unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
    statistics=[
        'Minimum'|'Maximum'|'Sum'|'Average'|'SampleCount',
    ]
)

Parameters:

distributionName (string) –
[REQUIRED]

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

Use the GetDistributions action to get a list of distribution names that you can specify.
metricName (string) –
[REQUIRED]

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
- Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
- BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
- BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None.
- TotalErrorRate - The percentage of all viewer requests for which the response’s HTTP status code was 4xx or 5xx. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
- 4xxErrorRate - The percentage of all viewer requests for which the response’s HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
- 5xxErrorRate - The percentage of all viewer requests for which the response’s HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable. Statistics: The most useful statistic is Average. Unit: The published unit is Percent.
startTime (datetime) –
[REQUIRED]

The start of the time interval for which to get metric data.

Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format. For example, if you wish 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.
endTime (datetime) –
[REQUIRED]

The end of the time interval for which to get metric data.

Constraints:
- Specified in Coordinated Universal Time (UTC).
- Specified in the Unix time format. For example, if you wish 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.
period (integer) –
[REQUIRED]

The granularity, in seconds, for the metric data points that will be returned.
unit (string) –
[REQUIRED]

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.
statistics (list) –
[REQUIRED]

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 - All values submitted for the matching metric added together. 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.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'metricName': 'Requests'|'BytesDownloaded'|'BytesUploaded'|'TotalErrorRate'|'Http4xxErrorRate'|'Http5xxErrorRate',
    'metricData': [
        {
            'average': 123.0,
            'maximum': 123.0,
            'minimum': 123.0,
            'sampleCount': 123.0,
            'sum': 123.0,
            'timestamp': datetime(2015, 1, 1),
            'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
        },
    ]
}

Response Structure

(dict) –
- metricName (string) –
  
  The name of the metric returned.
- metricData (list) –
  
  An array of objects that describe the metric data returned.
  - (dict) –
    
    Describes the metric data point.
    - average (float) –
      
      The average.
    - maximum (float) –
      
      The maximum.
    - minimum (float) –
      
      The minimum.
    - sampleCount (float) –
      
      The sample count.
    - sum (float) –
      
      The sum.
    - timestamp (datetime) –
      
      The timestamp (e.g., 1479816991.349).
    - unit (string) –
      
      The unit.

Exceptions

Lightsail.Client.exceptions.ServiceException
Lightsail.Client.exceptions.InvalidInputException
Lightsail.Client.exceptions.NotFoundException
Lightsail.Client.exceptions.OperationFailureException
Lightsail.Client.exceptions.AccessDeniedException
Lightsail.Client.exceptions.UnauthenticatedException