Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Documentation

data ApplicationDateRangeKpiResponse

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.

Constructors

ApplicationDateRangeKpiResponse'

Fields

• 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 for the Application Metrics resource because the resource returns all results in a single page.

• kpiResult :: BaseKpiResult

  An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

• kpiName :: Text

  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.

• endTime :: ISO8601

  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.

• startTime :: ISO8601

  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.

• applicationId :: Text

  The unique identifier for the application that the metric applies to.

Instances

FromJSON ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

parseJSON :: Value -> Parser ApplicationDateRangeKpiResponse

parseJSONList :: Value -> Parser [ApplicationDateRangeKpiResponse]

Generic ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Associated Types

type Rep ApplicationDateRangeKpiResponse :: Type -> Type

Methods

from :: ApplicationDateRangeKpiResponse -> Rep ApplicationDateRangeKpiResponse x

to :: Rep ApplicationDateRangeKpiResponse x -> ApplicationDateRangeKpiResponse

Read ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

readsPrec :: Int -> ReadS ApplicationDateRangeKpiResponse

readList :: ReadS [ApplicationDateRangeKpiResponse]

readPrec :: ReadPrec ApplicationDateRangeKpiResponse

readListPrec :: ReadPrec [ApplicationDateRangeKpiResponse]

Show ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

showsPrec :: Int -> ApplicationDateRangeKpiResponse -> ShowS

show :: ApplicationDateRangeKpiResponse -> String

showList :: [ApplicationDateRangeKpiResponse] -> ShowS

NFData ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

rnf :: ApplicationDateRangeKpiResponse -> ()

Eq ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

(==) :: ApplicationDateRangeKpiResponse -> ApplicationDateRangeKpiResponse -> Bool

(/=) :: ApplicationDateRangeKpiResponse -> ApplicationDateRangeKpiResponse -> Bool

Hashable ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

Methods

hashWithSalt :: Int -> ApplicationDateRangeKpiResponse -> Int

hash :: ApplicationDateRangeKpiResponse -> Int

type Rep ApplicationDateRangeKpiResponse

Defined in Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse

type Rep ApplicationDateRangeKpiResponse = D1 ('MetaData "ApplicationDateRangeKpiResponse" "Amazonka.Pinpoint.Types.ApplicationDateRangeKpiResponse" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "ApplicationDateRangeKpiResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kpiResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BaseKpiResult) :*: S1 ('MetaSel ('Just "kpiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newApplicationDateRangeKpiResponse

Arguments

:: BaseKpiResult

$sel:kpiResult:ApplicationDateRangeKpiResponse'

-> Text

$sel:kpiName:ApplicationDateRangeKpiResponse'

-> UTCTime

$sel:endTime:ApplicationDateRangeKpiResponse'

-> UTCTime

$sel:startTime:ApplicationDateRangeKpiResponse'

-> Text

$sel:applicationId:ApplicationDateRangeKpiResponse'

-> 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)

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

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

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

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

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

The unique identifier for the application that the metric applies to.