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 |
Synopsis
- data ApplicationDateRangeKpiResponse = ApplicationDateRangeKpiResponse' {}
- newApplicationDateRangeKpiResponse :: BaseKpiResult -> Text -> UTCTime -> UTCTime -> Text -> ApplicationDateRangeKpiResponse
- applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (Maybe Text)
- applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult
- applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text
- applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime
- applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime
- applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text
Documentation
data ApplicationDateRangeKpiResponse Source #
Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.
See: newApplicationDateRangeKpiResponse
smart constructor.
ApplicationDateRangeKpiResponse' | |
|
Instances
newApplicationDateRangeKpiResponse Source #
:: BaseKpiResult | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> Text | |
-> ApplicationDateRangeKpiResponse |
Create a value of ApplicationDateRangeKpiResponse
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:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_nextToken
- The string to use in a subsequent request to get the next page of
results in a paginated response. This value is null for the Application
Metrics resource because the resource returns all results in a single
page.
$sel:kpiResult:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_kpiResult
- An array of objects that contains the results of the query. Each object
contains the value for the metric and metadata about that value.
$sel:kpiName:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_kpiName
- The name of the metric, also referred to as a /key performance indicator
(KPI)/, that the data was retrieved for. This value describes the
associated metric and consists of two or more terms, which are comprised
of lowercase alphanumeric characters, separated by a hyphen. For a list
of possible values, see the
Amazon Pinpoint Developer Guide.
$sel:endTime:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_endTime
- The last date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:startTime:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_startTime
- The first date and time of the date range that was used to filter the
query results, in extended ISO 8601 format. The date range is inclusive.
$sel:applicationId:ApplicationDateRangeKpiResponse'
, applicationDateRangeKpiResponse_applicationId
- The unique identifier for the application that the metric applies to.
applicationDateRangeKpiResponse_nextToken :: Lens' ApplicationDateRangeKpiResponse (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 for the Application Metrics resource because the resource returns all results in a single page.
applicationDateRangeKpiResponse_kpiResult :: Lens' ApplicationDateRangeKpiResponse BaseKpiResult Source #
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
applicationDateRangeKpiResponse_kpiName :: Lens' ApplicationDateRangeKpiResponse Text Source #
The name of the metric, also referred to as a /key performance indicator (KPI)/, that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
applicationDateRangeKpiResponse_endTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
applicationDateRangeKpiResponse_startTime :: Lens' ApplicationDateRangeKpiResponse UTCTime Source #
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
applicationDateRangeKpiResponse_applicationId :: Lens' ApplicationDateRangeKpiResponse Text Source #
The unique identifier for the application that the metric applies to.