| 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.MacieV2.GetUsageStatistics
Description
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
This operation returns paginated results.
Synopsis
- data GetUsageStatistics = GetUsageStatistics' {}
- newGetUsageStatistics :: GetUsageStatistics
- getUsageStatistics_filterBy :: Lens' GetUsageStatistics (Maybe [UsageStatisticsFilter])
- getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Int)
- getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text)
- getUsageStatistics_sortBy :: Lens' GetUsageStatistics (Maybe UsageStatisticsSortBy)
- getUsageStatistics_timeRange :: Lens' GetUsageStatistics (Maybe TimeRange)
- data GetUsageStatisticsResponse = GetUsageStatisticsResponse' {}
- newGetUsageStatisticsResponse :: Int -> GetUsageStatisticsResponse
- getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text)
- getUsageStatisticsResponse_records :: Lens' GetUsageStatisticsResponse (Maybe [UsageRecord])
- getUsageStatisticsResponse_timeRange :: Lens' GetUsageStatisticsResponse (Maybe TimeRange)
- getUsageStatisticsResponse_httpStatus :: Lens' GetUsageStatisticsResponse Int
Creating a Request
data GetUsageStatistics Source #
See: newGetUsageStatistics smart constructor.
Constructors
| GetUsageStatistics' | |
Fields
| |
Instances
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: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.
GetUsageStatistics, getUsageStatistics_nextToken - The nextToken string that specifies which page of results to return in a
paginated response.
$sel:sortBy:GetUsageStatistics', getUsageStatistics_sortBy - The criteria to use to sort the query results.
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.
Request Lenses
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_nextToken :: Lens' GetUsageStatistics (Maybe Text) Source #
The nextToken string that specifies which page of results to return in a paginated response.
getUsageStatistics_sortBy :: Lens' GetUsageStatistics (Maybe UsageStatisticsSortBy) Source #
The criteria to use to sort the query results.
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.
Destructuring the Response
data GetUsageStatisticsResponse Source #
See: newGetUsageStatisticsResponse smart constructor.
Constructors
| GetUsageStatisticsResponse' | |
Fields
| |
Instances
newGetUsageStatisticsResponse Source #
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:
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.
GetUsageStatisticsResponse, getUsageStatisticsResponse_records - An array of objects that contains the results of the query. Each object
contains the data for an account that matches the filter criteria
specified in the request.
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:httpStatus:GetUsageStatisticsResponse', getUsageStatisticsResponse_httpStatus - The response's http status code.
Response Lenses
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_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 matches the filter criteria specified in the request.
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_httpStatus :: Lens' GetUsageStatisticsResponse Int Source #
The response's http status code.