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

Description

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.

Synopsis

Creating a Request

data GetBucketMetricData Source #

See: newGetBucketMetricData smart constructor.

Constructors

GetBucketMetricData' 

Fields

  • bucketName :: Text

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

  • metricName :: BucketMetricName

    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.

    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.

  • startTime :: POSIX

    The timestamp indicating the earliest data to be returned.

  • endTime :: POSIX

    The timestamp indicating the latest data to be returned.

  • period :: Natural

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

    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.

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

Instances

Instances details
Eq GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Read GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Show GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Generic GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Associated Types

type Rep GetBucketMetricData :: Type -> Type #

NFData GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Methods

rnf :: GetBucketMetricData -> () #

Hashable GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

ToJSON GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

AWSRequest GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Associated Types

type AWSResponse GetBucketMetricData #

ToHeaders GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

ToPath GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

ToQuery GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

type Rep GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

type AWSResponse GetBucketMetricData Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

newGetBucketMetricData Source #

Create a value of GetBucketMetricData 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:bucketName:GetBucketMetricData', getBucketMetricData_bucketName - The name of the bucket for which to get metric data.

$sel:metricName:GetBucketMetricData', getBucketMetricData_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.

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.

$sel:startTime:GetBucketMetricData', getBucketMetricData_startTime - The timestamp indicating the earliest data to be returned.

$sel:endTime:GetBucketMetricData', getBucketMetricData_endTime - The timestamp indicating the latest data to be returned.

$sel:period:GetBucketMetricData', getBucketMetricData_period - The granularity, in seconds, of the returned data points.

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.

$sel:statistics:GetBucketMetricData', getBucketMetricData_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.

$sel:unit:GetBucketMetricData', getBucketMetricData_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.

Request Lenses

getBucketMetricData_bucketName :: Lens' GetBucketMetricData Text Source #

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

getBucketMetricData_metricName :: Lens' GetBucketMetricData BucketMetricName Source #

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.

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.

getBucketMetricData_startTime :: Lens' GetBucketMetricData UTCTime Source #

The timestamp indicating the earliest data to be returned.

getBucketMetricData_endTime :: Lens' GetBucketMetricData UTCTime Source #

The timestamp indicating the latest data to be returned.

getBucketMetricData_period :: Lens' GetBucketMetricData Natural Source #

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

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.

getBucketMetricData_statistics :: Lens' GetBucketMetricData [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 - 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.

getBucketMetricData_unit :: Lens' GetBucketMetricData 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.

Destructuring the Response

data GetBucketMetricDataResponse Source #

See: newGetBucketMetricDataResponse smart constructor.

Constructors

GetBucketMetricDataResponse' 

Fields

Instances

Instances details
Eq GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Read GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Show GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Generic GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

Associated Types

type Rep GetBucketMetricDataResponse :: Type -> Type #

NFData GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

type Rep GetBucketMetricDataResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetBucketMetricData

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

newGetBucketMetricDataResponse Source #

Create a value of GetBucketMetricDataResponse 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:GetBucketMetricData', getBucketMetricDataResponse_metricName - The name of the metric returned.

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

$sel:httpStatus:GetBucketMetricDataResponse', getBucketMetricDataResponse_httpStatus - The response's http status code.

Response Lenses

getBucketMetricDataResponse_metricData :: Lens' GetBucketMetricDataResponse (Maybe [MetricDatapoint]) Source #

An array of objects that describe the metric data returned.