Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MacieV2.GetUsageStatistics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

This operation returns paginated results.

Synopsis

data GetUsageStatistics = GetUsageStatistics' {
- timeRange :: Maybe TimeRange
- nextToken :: Maybe Text
- filterBy :: Maybe [UsageStatisticsFilter]
- maxResults :: Maybe Int
- sortBy :: Maybe UsageStatisticsSortBy
}
newGetUsageStatistics :: GetUsageStatistics
getUsageStatistics_timeRange :: Lens' GetUsageStatistics (Maybe TimeRange)
getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text)
getUsageStatistics_filterBy :: Lens' GetUsageStatistics (Maybe [UsageStatisticsFilter])
getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Int)
getUsageStatistics_sortBy :: Lens' GetUsageStatistics (Maybe UsageStatisticsSortBy)
data GetUsageStatisticsResponse = GetUsageStatisticsResponse' {
- timeRange :: Maybe TimeRange
- records :: Maybe [UsageRecord]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetUsageStatisticsResponse :: Int -> GetUsageStatisticsResponse
getUsageStatisticsResponse_timeRange :: Lens' GetUsageStatisticsResponse (Maybe TimeRange)
getUsageStatisticsResponse_records :: Lens' GetUsageStatisticsResponse (Maybe [UsageRecord])
getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text)
getUsageStatisticsResponse_httpStatus :: Lens' GetUsageStatisticsResponse Int

Creating a Request

data GetUsageStatistics Source #

See: newGetUsageStatistics smart constructor.

Constructors

GetUsageStatistics'

Fields

timeRange :: Maybe TimeRange
The inclusive time period to query usage 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, Amazon Macie provides usage data for the preceding 30 days.
nextToken :: Maybe Text
The nextToken string that specifies which page of results to return in a paginated response.
filterBy :: Maybe [UsageStatisticsFilter]
An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
maxResults :: Maybe Int
The maximum number of items to include in each page of the response.
sortBy :: Maybe UsageStatisticsSortBy
The criteria to use to sort the query results.

Instances

Instances details

Eq GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods (==) :: GetUsageStatistics -> GetUsageStatistics -> Bool # (/=) :: GetUsageStatistics -> GetUsageStatistics -> Bool #
Read GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods readsPrec :: Int -> ReadS GetUsageStatistics # readList :: ReadS [GetUsageStatistics] # readPrec :: ReadPrec GetUsageStatistics # readListPrec :: ReadPrec [GetUsageStatistics] #
Show GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods showsPrec :: Int -> GetUsageStatistics -> ShowS # show :: GetUsageStatistics -> String # showList :: [GetUsageStatistics] -> ShowS #
Generic GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Associated Types type Rep GetUsageStatistics :: Type -> Type # Methods from :: GetUsageStatistics -> Rep GetUsageStatistics x # to :: Rep GetUsageStatistics x -> GetUsageStatistics #
NFData GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods rnf :: GetUsageStatistics -> () #
Hashable GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods hashWithSalt :: Int -> GetUsageStatistics -> Int # hash :: GetUsageStatistics -> Int #
ToJSON GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods toJSON :: GetUsageStatistics -> Value # toEncoding :: GetUsageStatistics -> Encoding # toJSONList :: [GetUsageStatistics] -> Value # toEncodingList :: [GetUsageStatistics] -> Encoding #
AWSPager GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods page :: GetUsageStatistics -> AWSResponse GetUsageStatistics -> Maybe GetUsageStatistics #
AWSRequest GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Associated Types type AWSResponse GetUsageStatistics # Methods request :: GetUsageStatistics -> Request GetUsageStatistics # response :: MonadResource m => Logger -> Service -> Proxy GetUsageStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsageStatistics))) #
ToHeaders GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods toHeaders :: GetUsageStatistics -> [Header] #
ToPath GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods toPath :: GetUsageStatistics -> ByteString #
ToQuery GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods toQuery :: GetUsageStatistics -> QueryString #
type Rep GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics type Rep GetUsageStatistics = D1 ('MetaData "GetUsageStatistics" "Amazonka.MacieV2.GetUsageStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetUsageStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filterBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsageStatisticsFilter])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UsageStatisticsSortBy))))))
type AWSResponse GetUsageStatistics Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics type AWSResponse GetUsageStatistics = GetUsageStatisticsResponse

newGetUsageStatistics :: GetUsageStatistics Source #

Create a value of GetUsageStatistics 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:GetUsageStatistics', getUsageStatistics_timeRange - The inclusive time period to query usage 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, Amazon Macie provides usage data for the preceding 30 days.

$sel:nextToken:GetUsageStatistics', getUsageStatistics_nextToken - The nextToken string that specifies which page of results to return in a paginated response.

$sel:filterBy:GetUsageStatistics', getUsageStatistics_filterBy - An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

$sel:maxResults:GetUsageStatistics', getUsageStatistics_maxResults - The maximum number of items to include in each page of the response.

$sel:sortBy:GetUsageStatistics', getUsageStatistics_sortBy - The criteria to use to sort the query results.

Request Lenses

getUsageStatistics_timeRange :: Lens' GetUsageStatistics (Maybe TimeRange) Source #

The inclusive time period to query usage 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, Amazon Macie provides usage data for the preceding 30 days.

getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

getUsageStatistics_filterBy :: Lens' GetUsageStatistics (Maybe [UsageStatisticsFilter]) Source #

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Int) Source #

The maximum number of items to include in each page of the response.

getUsageStatistics_sortBy :: Lens' GetUsageStatistics (Maybe UsageStatisticsSortBy) Source #

The criteria to use to sort the query results.

Destructuring the Response

data GetUsageStatisticsResponse Source #

See: newGetUsageStatisticsResponse smart constructor.

Constructors

GetUsageStatisticsResponse'

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.
records :: Maybe [UsageRecord]
An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.
nextToken :: Maybe Text
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods (==) :: GetUsageStatisticsResponse -> GetUsageStatisticsResponse -> Bool # (/=) :: GetUsageStatisticsResponse -> GetUsageStatisticsResponse -> Bool #
Read GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods readsPrec :: Int -> ReadS GetUsageStatisticsResponse # readList :: ReadS [GetUsageStatisticsResponse] # readPrec :: ReadPrec GetUsageStatisticsResponse # readListPrec :: ReadPrec [GetUsageStatisticsResponse] #
Show GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods showsPrec :: Int -> GetUsageStatisticsResponse -> ShowS # show :: GetUsageStatisticsResponse -> String # showList :: [GetUsageStatisticsResponse] -> ShowS #
Generic GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Associated Types type Rep GetUsageStatisticsResponse :: Type -> Type # Methods from :: GetUsageStatisticsResponse -> Rep GetUsageStatisticsResponse x # to :: Rep GetUsageStatisticsResponse x -> GetUsageStatisticsResponse #
NFData GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics Methods rnf :: GetUsageStatisticsResponse -> () #
type Rep GetUsageStatisticsResponse Source #
Instance details Defined in Amazonka.MacieV2.GetUsageStatistics type Rep GetUsageStatisticsResponse = D1 ('MetaData "GetUsageStatisticsResponse" "Amazonka.MacieV2.GetUsageStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetUsageStatisticsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :: S1 ('MetaSel ('Just "records") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsageRecord]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUsageStatisticsResponse Source #

Arguments

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

Create a value of GetUsageStatisticsResponse 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:GetUsageStatistics', getUsageStatisticsResponse_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:records:GetUsageStatisticsResponse', getUsageStatisticsResponse_records - An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.

$sel:nextToken:GetUsageStatistics', getUsageStatisticsResponse_nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

$sel:httpStatus:GetUsageStatisticsResponse', getUsageStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getUsageStatisticsResponse_timeRange :: Lens' GetUsageStatisticsResponse (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.

getUsageStatisticsResponse_records :: Lens' GetUsageStatisticsResponse (Maybe [UsageRecord]) Source #

An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.

getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

getUsageStatisticsResponse_httpStatus :: Lens' GetUsageStatisticsResponse Int Source #

The response's http status code.