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

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 activity.

Synopsis

Creating a Request

data GetJourneyExecutionActivityMetrics Source #

See: newGetJourneyExecutionActivityMetrics smart constructor.

Constructors

GetJourneyExecutionActivityMetrics'

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.
journeyActivityId :: Text
The unique identifier for the journey activity.
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

ToHeaders GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods toHeaders :: GetJourneyExecutionActivityMetrics -> [Header] #
ToPath GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods toPath :: GetJourneyExecutionActivityMetrics -> ByteString #
ToQuery GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods toQuery :: GetJourneyExecutionActivityMetrics -> QueryString #
AWSRequest GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Associated Types type AWSResponse GetJourneyExecutionActivityMetrics # Methods request :: (Service -> Service) -> GetJourneyExecutionActivityMetrics -> Request GetJourneyExecutionActivityMetrics # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetJourneyExecutionActivityMetrics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJourneyExecutionActivityMetrics))) #
Generic GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Associated Types type Rep GetJourneyExecutionActivityMetrics :: Type -> Type # Methods from :: GetJourneyExecutionActivityMetrics -> Rep GetJourneyExecutionActivityMetrics x # to :: Rep GetJourneyExecutionActivityMetrics x -> GetJourneyExecutionActivityMetrics #
Read GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods readsPrec :: Int -> ReadS GetJourneyExecutionActivityMetrics # readList :: ReadS [GetJourneyExecutionActivityMetrics] # readPrec :: ReadPrec GetJourneyExecutionActivityMetrics # readListPrec :: ReadPrec [GetJourneyExecutionActivityMetrics] #
Show GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods showsPrec :: Int -> GetJourneyExecutionActivityMetrics -> ShowS # show :: GetJourneyExecutionActivityMetrics -> String # showList :: [GetJourneyExecutionActivityMetrics] -> ShowS #
NFData GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods rnf :: GetJourneyExecutionActivityMetrics -> () #
Eq GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods (==) :: GetJourneyExecutionActivityMetrics -> GetJourneyExecutionActivityMetrics -> Bool # (/=) :: GetJourneyExecutionActivityMetrics -> GetJourneyExecutionActivityMetrics -> Bool #
Hashable GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics Methods hashWithSalt :: Int -> GetJourneyExecutionActivityMetrics -> Int # hash :: GetJourneyExecutionActivityMetrics -> Int #
type AWSResponse GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics type AWSResponse GetJourneyExecutionActivityMetrics = GetJourneyExecutionActivityMetricsResponse
type Rep GetJourneyExecutionActivityMetrics Source #
Instance details Defined in Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics type Rep GetJourneyExecutionActivityMetrics = D1 ('MetaData "GetJourneyExecutionActivityMetrics" "Amazonka.Pinpoint.GetJourneyExecutionActivityMetrics" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "GetJourneyExecutionActivityMetrics'" '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 "journeyActivityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "journeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetJourneyExecutionActivityMetrics Source #

Arguments

:: Text	`GetJourneyExecutionActivityMetrics`
-> Text	`GetJourneyExecutionActivityMetrics`
-> Text	`GetJourneyExecutionActivityMetrics`
-> GetJourneyExecutionActivityMetrics

Create a value of GetJourneyExecutionActivityMetrics 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:

GetJourneyExecutionActivityMetrics, getJourneyExecutionActivityMetrics_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:GetJourneyExecutionActivityMetrics', getJourneyExecutionActivityMetrics_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.

GetJourneyExecutionActivityMetrics, getJourneyExecutionActivityMetrics_journeyActivityId - The unique identifier for the journey activity.

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

GetJourneyExecutionActivityMetrics, getJourneyExecutionActivityMetrics_journeyId - The unique identifier for the journey.

Request Lenses

getJourneyExecutionActivityMetrics_nextToken :: Lens' GetJourneyExecutionActivityMetrics (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.

getJourneyExecutionActivityMetrics_pageSize :: Lens' GetJourneyExecutionActivityMetrics (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.

getJourneyExecutionActivityMetrics_journeyActivityId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

The unique identifier for the journey activity.

getJourneyExecutionActivityMetrics_applicationId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

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

getJourneyExecutionActivityMetrics_journeyId :: Lens' GetJourneyExecutionActivityMetrics Text Source #

The unique identifier for the journey.

Destructuring the Response

data GetJourneyExecutionActivityMetricsResponse Source #

See: newGetJourneyExecutionActivityMetricsResponse smart constructor.

Constructors

GetJourneyExecutionActivityMetricsResponse'
Fields httpStatus :: Int The response's http status code. journeyExecutionActivityMetricsResponse :: JourneyExecutionActivityMetricsResponse

Instances

Instances details

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

newGetJourneyExecutionActivityMetricsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetJourneyExecutionActivityMetricsResponse'`
-> JourneyExecutionActivityMetricsResponse	`$sel:journeyExecutionActivityMetricsResponse:GetJourneyExecutionActivityMetricsResponse'`
-> GetJourneyExecutionActivityMetricsResponse

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

$sel:journeyExecutionActivityMetricsResponse:GetJourneyExecutionActivityMetricsResponse', getJourneyExecutionActivityMetricsResponse_journeyExecutionActivityMetricsResponse - Undocumented member.

Response Lenses

getJourneyExecutionActivityMetricsResponse_httpStatus :: Lens' GetJourneyExecutionActivityMetricsResponse Int Source #

The response's http status code.

getJourneyExecutionActivityMetricsResponse_journeyExecutionActivityMetricsResponse :: Lens' GetJourneyExecutionActivityMetricsResponse JourneyExecutionActivityMetricsResponse Source #

Undocumented member.