Class: Aws::Lightsail::Types::GetDistributionMetricDataRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lightsail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#distribution_name ⇒ String

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.

Returns:

  • (String) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

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].

[1]: www.epochconverter.com/

Returns:

  • (Time) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

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`.

Returns:

  • (String) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The granularity, in seconds, for the metric data points that will be returned.

Returns:

  • (Integer) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

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].

[1]: www.epochconverter.com/

Returns:

  • (Time) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

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.

Returns:

  • (String) 


7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
 
# File 'lib/aws-sdk-lightsail/types.rb', line 7719

class GetDistributionMetricDataRequest < Struct.new(
  :distribution_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :unit,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end