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.Pinpoint.GetJourneyExecutionMetrics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

Synopsis

Creating a Request

data GetJourneyExecutionMetrics Source #

See: newGetJourneyExecutionMetrics smart constructor.

Constructors

GetJourneyExecutionMetrics'

Fields

nextToken :: Maybe Text
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
pageSize :: Maybe Text
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
applicationId :: Text
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
journeyId :: Text
The unique identifier for the journey.

Instances

Instances details

Eq GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods (==) :: GetJourneyExecutionMetrics -> GetJourneyExecutionMetrics -> Bool # (/=) :: GetJourneyExecutionMetrics -> GetJourneyExecutionMetrics -> Bool #
Read GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods readsPrec :: Int -> ReadS GetJourneyExecutionMetrics # readList :: ReadS [GetJourneyExecutionMetrics] # readPrec :: ReadPrec GetJourneyExecutionMetrics # readListPrec :: ReadPrec [GetJourneyExecutionMetrics] #
Show GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods showsPrec :: Int -> GetJourneyExecutionMetrics -> ShowS # show :: GetJourneyExecutionMetrics -> String # showList :: [GetJourneyExecutionMetrics] -> ShowS #
Generic GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Associated Types type Rep GetJourneyExecutionMetrics :: Type -> Type # Methods from :: GetJourneyExecutionMetrics -> Rep GetJourneyExecutionMetrics x # to :: Rep GetJourneyExecutionMetrics x -> GetJourneyExecutionMetrics #
NFData GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods rnf :: GetJourneyExecutionMetrics -> () #
Hashable GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods hashWithSalt :: Int -> GetJourneyExecutionMetrics -> Int # hash :: GetJourneyExecutionMetrics -> Int #
AWSRequest GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Associated Types type AWSResponse GetJourneyExecutionMetrics # Methods request :: GetJourneyExecutionMetrics -> Request GetJourneyExecutionMetrics # response :: MonadResource m => Logger -> Service -> Proxy GetJourneyExecutionMetrics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJourneyExecutionMetrics))) #
ToHeaders GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods toHeaders :: GetJourneyExecutionMetrics -> [Header] #
ToPath GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods toPath :: GetJourneyExecutionMetrics -> ByteString #
ToQuery GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods toQuery :: GetJourneyExecutionMetrics -> QueryString #
type Rep GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics type Rep GetJourneyExecutionMetrics = D1 ('MetaData "GetJourneyExecutionMetrics" "Amazonka.Pinpoint.GetJourneyExecutionMetrics" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetJourneyExecutionMetrics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetJourneyExecutionMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics type AWSResponse GetJourneyExecutionMetrics = GetJourneyExecutionMetricsResponse

newGetJourneyExecutionMetrics Source #

Arguments

:: Text	`$sel:applicationId:GetJourneyExecutionMetrics'`
-> Text	`$sel:journeyId:GetJourneyExecutionMetrics'`
-> GetJourneyExecutionMetrics

Create a value of GetJourneyExecutionMetrics 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:GetJourneyExecutionMetrics', getJourneyExecutionMetrics_nextToken - The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:pageSize:GetJourneyExecutionMetrics', getJourneyExecutionMetrics_pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:applicationId:GetJourneyExecutionMetrics', getJourneyExecutionMetrics_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

$sel:journeyId:GetJourneyExecutionMetrics', getJourneyExecutionMetrics_journeyId - The unique identifier for the journey.

Request Lenses

getJourneyExecutionMetrics_nextToken :: Lens' GetJourneyExecutionMetrics (Maybe Text) Source #

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionMetrics_pageSize :: Lens' GetJourneyExecutionMetrics (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getJourneyExecutionMetrics_applicationId :: Lens' GetJourneyExecutionMetrics Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

getJourneyExecutionMetrics_journeyId :: Lens' GetJourneyExecutionMetrics Text Source #

The unique identifier for the journey.

Destructuring the Response

data GetJourneyExecutionMetricsResponse Source #

See: newGetJourneyExecutionMetricsResponse smart constructor.

Constructors

GetJourneyExecutionMetricsResponse'
Fields httpStatus :: Int The response's http status code. journeyExecutionMetricsResponse :: JourneyExecutionMetricsResponse

Instances

Instances details

Eq GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods (==) :: GetJourneyExecutionMetricsResponse -> GetJourneyExecutionMetricsResponse -> Bool # (/=) :: GetJourneyExecutionMetricsResponse -> GetJourneyExecutionMetricsResponse -> Bool #
Read GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods readsPrec :: Int -> ReadS GetJourneyExecutionMetricsResponse # readList :: ReadS [GetJourneyExecutionMetricsResponse] # readPrec :: ReadPrec GetJourneyExecutionMetricsResponse # readListPrec :: ReadPrec [GetJourneyExecutionMetricsResponse] #
Show GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods showsPrec :: Int -> GetJourneyExecutionMetricsResponse -> ShowS # show :: GetJourneyExecutionMetricsResponse -> String # showList :: [GetJourneyExecutionMetricsResponse] -> ShowS #
Generic GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Associated Types type Rep GetJourneyExecutionMetricsResponse :: Type -> Type # Methods from :: GetJourneyExecutionMetricsResponse -> Rep GetJourneyExecutionMetricsResponse x # to :: Rep GetJourneyExecutionMetricsResponse x -> GetJourneyExecutionMetricsResponse #
NFData GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics Methods rnf :: GetJourneyExecutionMetricsResponse -> () #
type Rep GetJourneyExecutionMetricsResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics type Rep GetJourneyExecutionMetricsResponse = D1 ('MetaData "GetJourneyExecutionMetricsResponse" "Amazonka.Pinpoint.GetJourneyExecutionMetrics" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetJourneyExecutionMetricsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "journeyExecutionMetricsResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JourneyExecutionMetricsResponse)))

newGetJourneyExecutionMetricsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetJourneyExecutionMetricsResponse'`
-> JourneyExecutionMetricsResponse	`$sel:journeyExecutionMetricsResponse:GetJourneyExecutionMetricsResponse'`
-> GetJourneyExecutionMetricsResponse

Create a value of GetJourneyExecutionMetricsResponse 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:httpStatus:GetJourneyExecutionMetricsResponse', getJourneyExecutionMetricsResponse_httpStatus - The response's http status code.

$sel:journeyExecutionMetricsResponse:GetJourneyExecutionMetricsResponse', getJourneyExecutionMetricsResponse_journeyExecutionMetricsResponse - Undocumented member.

Response Lenses

getJourneyExecutionMetricsResponse_httpStatus :: Lens' GetJourneyExecutionMetricsResponse Int Source #

The response's http status code.

getJourneyExecutionMetricsResponse_journeyExecutionMetricsResponse :: Lens' GetJourneyExecutionMetricsResponse JourneyExecutionMetricsResponse Source #

Undocumented member.