libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetDistributionMetricData

Description

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.

Synopsis

Creating a Request

data GetDistributionMetricData Source #

See: newGetDistributionMetricData smart constructor.

Constructors

GetDistributionMetricData' 

Fields

  • distributionName :: Text

    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 :: DistributionMetricName

    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 :: POSIX

    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 :: POSIX

    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 :: Natural

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

  • unit :: MetricUnit

    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 :: [MetricStatistic]

    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.

Instances

Instances details
Eq GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

(==) :: GetDistributionMetricData -> GetDistributionMetricData -> Bool #

(/=) :: GetDistributionMetricData -> GetDistributionMetricData -> Bool #

Read GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

readsPrec :: Int -> ReadS GetDistributionMetricData #

readList :: ReadS [GetDistributionMetricData] #

readPrec :: ReadPrec GetDistributionMetricData #

readListPrec :: ReadPrec [GetDistributionMetricData] #

Show GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

showsPrec :: Int -> GetDistributionMetricData -> ShowS #

show :: GetDistributionMetricData -> String #

showList :: [GetDistributionMetricData] -> ShowS #

Generic GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Associated Types

type Rep GetDistributionMetricData :: Type -> Type #

Methods

from :: GetDistributionMetricData -> Rep GetDistributionMetricData x #

to :: Rep GetDistributionMetricData x -> GetDistributionMetricData #

NFData GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

rnf :: GetDistributionMetricData -> () #

Hashable GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

hashWithSalt :: Int -> GetDistributionMetricData -> Int #

hash :: GetDistributionMetricData -> Int #

ToJSON GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

toJSON :: GetDistributionMetricData -> Value #

toEncoding :: GetDistributionMetricData -> Encoding #

toJSONList :: [GetDistributionMetricData] -> Value #

toEncodingList :: [GetDistributionMetricData] -> Encoding #

AWSRequest GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Associated Types

type AWSResponse GetDistributionMetricData #

Methods

request :: GetDistributionMetricData -> Request GetDistributionMetricData #

response :: MonadResource m => Logger -> Service -> Proxy GetDistributionMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDistributionMetricData))) #

ToHeaders GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

toHeaders :: GetDistributionMetricData -> [Header] #

ToPath GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

toPath :: GetDistributionMetricData -> ByteString #

ToQuery GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

toQuery :: GetDistributionMetricData -> QueryString #

type Rep GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

type Rep GetDistributionMetricData = D1 ('MetaData "GetDistributionMetricData" "Amazonka.Lightsail.GetDistributionMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDistributionMetricData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "distributionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistributionMetricName) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :*: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :*: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricUnit) :*: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricStatistic])))))
type AWSResponse GetDistributionMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

type AWSResponse GetDistributionMetricData = GetDistributionMetricDataResponse

newGetDistributionMetricData Source #

Arguments

:: Text

$sel:distributionName:GetDistributionMetricData'

-> DistributionMetricName

$sel:metricName:GetDistributionMetricData'

-> UTCTime

$sel:startTime:GetDistributionMetricData'

-> UTCTime

$sel:endTime:GetDistributionMetricData'

-> Natural

$sel:period:GetDistributionMetricData'

-> MetricUnit

$sel:unit:GetDistributionMetricData'

-> GetDistributionMetricData 

Create a value of GetDistributionMetricData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:distributionName:GetDistributionMetricData', getDistributionMetricData_distributionName - 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.

$sel:metricName:GetDistributionMetricData', getDistributionMetricData_metricName - 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.

$sel:startTime:GetDistributionMetricData', getDistributionMetricData_startTime - 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.

$sel:endTime:GetDistributionMetricData', getDistributionMetricData_endTime - 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.

$sel:period:GetDistributionMetricData', getDistributionMetricData_period - The granularity, in seconds, for the metric data points that will be returned.

$sel:unit:GetDistributionMetricData', getDistributionMetricData_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.

$sel:statistics:GetDistributionMetricData', getDistributionMetricData_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 - 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.

Request Lenses

getDistributionMetricData_distributionName :: Lens' GetDistributionMetricData Text Source #

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.

getDistributionMetricData_metricName :: Lens' GetDistributionMetricData DistributionMetricName Source #

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.

getDistributionMetricData_startTime :: Lens' GetDistributionMetricData UTCTime Source #

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.

getDistributionMetricData_endTime :: Lens' GetDistributionMetricData UTCTime Source #

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.

getDistributionMetricData_period :: Lens' GetDistributionMetricData Natural Source #

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

getDistributionMetricData_unit :: Lens' GetDistributionMetricData MetricUnit Source #

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.

getDistributionMetricData_statistics :: Lens' GetDistributionMetricData [MetricStatistic] Source #

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.

Destructuring the Response

data GetDistributionMetricDataResponse Source #

See: newGetDistributionMetricDataResponse smart constructor.

Constructors

GetDistributionMetricDataResponse' 

Fields

Instances

Instances details
Eq GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

(==) :: GetDistributionMetricDataResponse -> GetDistributionMetricDataResponse -> Bool #

(/=) :: GetDistributionMetricDataResponse -> GetDistributionMetricDataResponse -> Bool #

Read GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

readsPrec :: Int -> ReadS GetDistributionMetricDataResponse #

readList :: ReadS [GetDistributionMetricDataResponse] #

readPrec :: ReadPrec GetDistributionMetricDataResponse #

readListPrec :: ReadPrec [GetDistributionMetricDataResponse] #

Show GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

showsPrec :: Int -> GetDistributionMetricDataResponse -> ShowS #

show :: GetDistributionMetricDataResponse -> String #

showList :: [GetDistributionMetricDataResponse] -> ShowS #

Generic GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Associated Types

type Rep GetDistributionMetricDataResponse :: Type -> Type #

Methods

from :: GetDistributionMetricDataResponse -> Rep GetDistributionMetricDataResponse x #

to :: Rep GetDistributionMetricDataResponse x -> GetDistributionMetricDataResponse #

NFData GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

Methods

rnf :: GetDistributionMetricDataResponse -> () #

type Rep GetDistributionMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetDistributionMetricData

type Rep GetDistributionMetricDataResponse = D1 ('MetaData "GetDistributionMetricDataResponse" "Amazonka.Lightsail.GetDistributionMetricData" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetDistributionMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DistributionMetricName)) :*: (S1 ('MetaSel ('Just "metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatapoint])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDistributionMetricDataResponse Source #

Arguments

:: Int

$sel:httpStatus:GetDistributionMetricDataResponse'

-> GetDistributionMetricDataResponse 

Create a value of GetDistributionMetricDataResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricName:GetDistributionMetricData', getDistributionMetricDataResponse_metricName - The name of the metric returned.

$sel:metricData:GetDistributionMetricDataResponse', getDistributionMetricDataResponse_metricData - An array of objects that describe the metric data returned.

$sel:httpStatus:GetDistributionMetricDataResponse', getDistributionMetricDataResponse_httpStatus - The response's http status code.

Response Lenses

getDistributionMetricDataResponse_metricName :: Lens' GetDistributionMetricDataResponse (Maybe DistributionMetricName) Source #

The name of the metric returned.

getDistributionMetricDataResponse_metricData :: Lens' GetDistributionMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.

getDistributionMetricDataResponse_httpStatus :: Lens' GetDistributionMetricDataResponse Int Source #

The response's http status code.