Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.GetBucketMetricData

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data GetBucketMetricData = GetBucketMetricData' {
- bucketName :: Text
- metricName :: BucketMetricName
- startTime :: POSIX
- endTime :: POSIX
- period :: Natural
- statistics :: [MetricStatistic]
- unit :: MetricUnit
}
newGetBucketMetricData :: Text -> BucketMetricName -> UTCTime -> UTCTime -> Natural -> MetricUnit -> GetBucketMetricData
getBucketMetricData_bucketName :: Lens' GetBucketMetricData Text
getBucketMetricData_metricName :: Lens' GetBucketMetricData BucketMetricName
getBucketMetricData_startTime :: Lens' GetBucketMetricData UTCTime
getBucketMetricData_endTime :: Lens' GetBucketMetricData UTCTime
getBucketMetricData_period :: Lens' GetBucketMetricData Natural
getBucketMetricData_statistics :: Lens' GetBucketMetricData [MetricStatistic]
getBucketMetricData_unit :: Lens' GetBucketMetricData MetricUnit
data GetBucketMetricDataResponse = GetBucketMetricDataResponse' {
- metricData :: Maybe [MetricDatapoint]
- metricName :: Maybe BucketMetricName
- httpStatus :: Int
}
newGetBucketMetricDataResponse :: Int -> GetBucketMetricDataResponse
getBucketMetricDataResponse_metricData :: Lens' GetBucketMetricDataResponse (Maybe [MetricDatapoint])
getBucketMetricDataResponse_metricName :: Lens' GetBucketMetricDataResponse (Maybe BucketMetricName)
getBucketMetricDataResponse_httpStatus :: Lens' GetBucketMetricDataResponse Int

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

ToJSON GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods toJSON :: GetBucketMetricData -> Value # toEncoding :: GetBucketMetricData -> Encoding # toJSONList :: [GetBucketMetricData] -> Value # toEncodingList :: [GetBucketMetricData] -> Encoding #
ToHeaders GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods toHeaders :: GetBucketMetricData -> [Header] #
ToPath GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods toPath :: GetBucketMetricData -> ByteString #
ToQuery GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods toQuery :: GetBucketMetricData -> QueryString #
AWSRequest GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Associated Types type AWSResponse GetBucketMetricData # Methods request :: (Service -> Service) -> GetBucketMetricData -> Request GetBucketMetricData # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBucketMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketMetricData))) #
Generic GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Associated Types type Rep GetBucketMetricData :: Type -> Type # Methods from :: GetBucketMetricData -> Rep GetBucketMetricData x # to :: Rep GetBucketMetricData x -> GetBucketMetricData #
Read GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods readsPrec :: Int -> ReadS GetBucketMetricData # readList :: ReadS [GetBucketMetricData] # readPrec :: ReadPrec GetBucketMetricData # readListPrec :: ReadPrec [GetBucketMetricData] #
Show GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods showsPrec :: Int -> GetBucketMetricData -> ShowS # show :: GetBucketMetricData -> String # showList :: [GetBucketMetricData] -> ShowS #
NFData GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods rnf :: GetBucketMetricData -> () #
Eq GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods (==) :: GetBucketMetricData -> GetBucketMetricData -> Bool # (/=) :: GetBucketMetricData -> GetBucketMetricData -> Bool #
Hashable GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods hashWithSalt :: Int -> GetBucketMetricData -> Int # hash :: GetBucketMetricData -> Int #
type AWSResponse GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData type AWSResponse GetBucketMetricData = GetBucketMetricDataResponse
type Rep GetBucketMetricData Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData type Rep GetBucketMetricData = D1 ('MetaData "GetBucketMetricData" "Amazonka.Lightsail.GetBucketMetricData" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetBucketMetricData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketMetricName) :: 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 "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MetricStatistic]) :: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricUnit)))))

newGetBucketMetricData Source #

Arguments

:: Text	`$sel:bucketName:GetBucketMetricData'`
-> BucketMetricName	`GetBucketMetricData`
-> UTCTime	`$sel:startTime:GetBucketMetricData'`
-> UTCTime	`$sel:endTime:GetBucketMetricData'`
-> Natural	`GetBucketMetricData`
-> MetricUnit	`GetBucketMetricData`
-> GetBucketMetricData

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.

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.

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.

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 metricData :: Maybe [MetricDatapoint] An array of objects that describe the metric data returned. metricName :: Maybe BucketMetricName The name of the metric returned. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Associated Types type Rep GetBucketMetricDataResponse :: Type -> Type # Methods from :: GetBucketMetricDataResponse -> Rep GetBucketMetricDataResponse x # to :: Rep GetBucketMetricDataResponse x -> GetBucketMetricDataResponse #
Read GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods readsPrec :: Int -> ReadS GetBucketMetricDataResponse # readList :: ReadS [GetBucketMetricDataResponse] # readPrec :: ReadPrec GetBucketMetricDataResponse # readListPrec :: ReadPrec [GetBucketMetricDataResponse] #
Show GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods showsPrec :: Int -> GetBucketMetricDataResponse -> ShowS # show :: GetBucketMetricDataResponse -> String # showList :: [GetBucketMetricDataResponse] -> ShowS #
NFData GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods rnf :: GetBucketMetricDataResponse -> () #
Eq GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData Methods (==) :: GetBucketMetricDataResponse -> GetBucketMetricDataResponse -> Bool # (/=) :: GetBucketMetricDataResponse -> GetBucketMetricDataResponse -> Bool #
type Rep GetBucketMetricDataResponse Source #
Instance details Defined in Amazonka.Lightsail.GetBucketMetricData type Rep GetBucketMetricDataResponse = D1 ('MetaData "GetBucketMetricDataResponse" "Amazonka.Lightsail.GetBucketMetricData" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "GetBucketMetricDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatapoint])) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketMetricName)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBucketMetricDataResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBucketMetricDataResponse'`
-> GetBucketMetricDataResponse

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:metricData:GetBucketMetricDataResponse', getBucketMetricDataResponse_metricData - An array of objects that describe the metric data returned.

GetBucketMetricData, getBucketMetricDataResponse_metricName - The name of the metric 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.

getBucketMetricDataResponse_metricName :: Lens' GetBucketMetricDataResponse (Maybe BucketMetricName) Source #

The name of the metric returned.

getBucketMetricDataResponse_httpStatus :: Lens' GetBucketMetricDataResponse Int Source #

The response's http status code.