| 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.GuardDuty.GetUsageStatistics
Description
Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources the cost returned will include only the usage so far under 30 days, this may differ from the cost metrics in the console, which projects usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.
Synopsis
- data GetUsageStatistics = GetUsageStatistics' {}
- newGetUsageStatistics :: Text -> UsageStatisticType -> UsageCriteria -> GetUsageStatistics
- getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text)
- getUsageStatistics_unit :: Lens' GetUsageStatistics (Maybe Text)
- getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Natural)
- getUsageStatistics_detectorId :: Lens' GetUsageStatistics Text
- getUsageStatistics_usageStatisticType :: Lens' GetUsageStatistics UsageStatisticType
- getUsageStatistics_usageCriteria :: Lens' GetUsageStatistics UsageCriteria
- data GetUsageStatisticsResponse = GetUsageStatisticsResponse' {}
- newGetUsageStatisticsResponse :: Int -> GetUsageStatisticsResponse
- getUsageStatisticsResponse_usageStatistics :: Lens' GetUsageStatisticsResponse (Maybe UsageStatistics)
- getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text)
- getUsageStatisticsResponse_httpStatus :: Lens' GetUsageStatisticsResponse Int
Creating a Request
data GetUsageStatistics Source #
See: newGetUsageStatistics smart constructor.
Constructors
| GetUsageStatistics' | |
Fields
| |
Instances
newGetUsageStatistics Source #
Arguments
| :: Text | |
| -> UsageStatisticType | |
| -> UsageCriteria | |
| -> GetUsageStatistics |
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:nextToken:GetUsageStatistics', getUsageStatistics_nextToken - A token to use for paginating results that are returned in the response.
Set the value of this parameter to null for the first request to a list
action. For subsequent calls, use the NextToken value returned from the
previous request to continue listing results after the first page.
$sel:unit:GetUsageStatistics', getUsageStatistics_unit - The currency unit you would like to view your usage statistics in.
Current valid values are USD.
$sel:maxResults:GetUsageStatistics', getUsageStatistics_maxResults - The maximum number of results to return in the response.
$sel:detectorId:GetUsageStatistics', getUsageStatistics_detectorId - The ID of the detector that specifies the GuardDuty service whose usage
statistics you want to retrieve.
$sel:usageStatisticType:GetUsageStatistics', getUsageStatistics_usageStatisticType - The type of usage statistics to retrieve.
$sel:usageCriteria:GetUsageStatistics', getUsageStatistics_usageCriteria - Represents the criteria used for querying usage.
Request Lenses
getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text) Source #
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
getUsageStatistics_unit :: Lens' GetUsageStatistics (Maybe Text) Source #
The currency unit you would like to view your usage statistics in. Current valid values are USD.
getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Natural) Source #
The maximum number of results to return in the response.
getUsageStatistics_detectorId :: Lens' GetUsageStatistics Text Source #
The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.
getUsageStatistics_usageStatisticType :: Lens' GetUsageStatistics UsageStatisticType Source #
The type of usage statistics to retrieve.
getUsageStatistics_usageCriteria :: Lens' GetUsageStatistics UsageCriteria Source #
Represents the criteria used for querying usage.
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:
$sel:usageStatistics:GetUsageStatisticsResponse', getUsageStatisticsResponse_usageStatistics - The usage statistics object. If a UsageStatisticType was provided, the
objects representing other types will be null.
$sel:nextToken:GetUsageStatistics', getUsageStatisticsResponse_nextToken - The pagination parameter to be used on the next list operation to
retrieve more items.
$sel:httpStatus:GetUsageStatisticsResponse', getUsageStatisticsResponse_httpStatus - The response's http status code.
Response Lenses
getUsageStatisticsResponse_usageStatistics :: Lens' GetUsageStatisticsResponse (Maybe UsageStatistics) Source #
The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.
getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text) Source #
The pagination parameter to be used on the next list operation to retrieve more items.
getUsageStatisticsResponse_httpStatus :: Lens' GetUsageStatisticsResponse Int Source #
The response's http status code.