libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
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.MacieV2.GetUsageTotals

Description

Retrieves (queries) aggregated usage data for an account.

Synopsis

Creating a Request

data GetUsageTotals Source #

See: newGetUsageTotals smart constructor.

Constructors

GetUsageTotals' 

Fields

  • timeRange :: Maybe Text

    The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

Instances

Instances details
Eq GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Read GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Show GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Generic GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Associated Types

type Rep GetUsageTotals :: Type -> Type #

NFData GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Methods

rnf :: GetUsageTotals -> () #

Hashable GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

AWSRequest GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Associated Types

type AWSResponse GetUsageTotals #

ToHeaders GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

ToPath GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

ToQuery GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

type Rep GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

type Rep GetUsageTotals = D1 ('MetaData "GetUsageTotals" "Amazonka.MacieV2.GetUsageTotals" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetUsageTotals'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse GetUsageTotals Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

newGetUsageTotals :: GetUsageTotals Source #

Create a value of GetUsageTotals 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:timeRange:GetUsageTotals', getUsageTotals_timeRange - The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

Request Lenses

getUsageTotals_timeRange :: Lens' GetUsageTotals (Maybe Text) Source #

The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

Destructuring the Response

data GetUsageTotalsResponse Source #

See: newGetUsageTotalsResponse smart constructor.

Constructors

GetUsageTotalsResponse' 

Fields

  • timeRange :: Maybe TimeRange

    The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

  • usageTotals :: Maybe [UsageTotal]

    An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Read GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Show GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Generic GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Associated Types

type Rep GetUsageTotalsResponse :: Type -> Type #

NFData GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

Methods

rnf :: GetUsageTotalsResponse -> () #

type Rep GetUsageTotalsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetUsageTotals

type Rep GetUsageTotalsResponse = D1 ('MetaData "GetUsageTotalsResponse" "Amazonka.MacieV2.GetUsageTotals" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetUsageTotalsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :*: (S1 ('MetaSel ('Just "usageTotals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsageTotal])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUsageTotalsResponse Source #

Create a value of GetUsageTotalsResponse 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:timeRange:GetUsageTotals', getUsageTotalsResponse_timeRange - The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

$sel:usageTotals:GetUsageTotalsResponse', getUsageTotalsResponse_usageTotals - An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

$sel:httpStatus:GetUsageTotalsResponse', getUsageTotalsResponse_httpStatus - The response's http status code.

Response Lenses

getUsageTotalsResponse_timeRange :: Lens' GetUsageTotalsResponse (Maybe TimeRange) Source #

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

getUsageTotalsResponse_usageTotals :: Lens' GetUsageTotalsResponse (Maybe [UsageTotal]) Source #

An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.