Amazonka.Pinpoint.GetJourneyExecutionMetrics

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

Creating a Request

data GetJourneyExecutionMetrics

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

ToHeaders GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

toHeaders :: GetJourneyExecutionMetrics -> [Header]

ToPath GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

toPath :: GetJourneyExecutionMetrics -> ByteString

ToQuery GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

toQuery :: GetJourneyExecutionMetrics -> QueryString

AWSRequest GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Associated Types

type AWSResponse GetJourneyExecutionMetrics

Methods

request :: (Service -> Service) -> GetJourneyExecutionMetrics -> Request GetJourneyExecutionMetrics

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetJourneyExecutionMetrics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetJourneyExecutionMetrics)))

Generic GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Associated Types

type Rep GetJourneyExecutionMetrics :: Type -> Type

Methods

from :: GetJourneyExecutionMetrics -> Rep GetJourneyExecutionMetrics x

to :: Rep GetJourneyExecutionMetrics x -> GetJourneyExecutionMetrics

Read GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

readsPrec :: Int -> ReadS GetJourneyExecutionMetrics

readList :: ReadS [GetJourneyExecutionMetrics]

readPrec :: ReadPrec GetJourneyExecutionMetrics

readListPrec :: ReadPrec [GetJourneyExecutionMetrics]

Show GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

showsPrec :: Int -> GetJourneyExecutionMetrics -> ShowS

show :: GetJourneyExecutionMetrics -> String

showList :: [GetJourneyExecutionMetrics] -> ShowS

NFData GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

rnf :: GetJourneyExecutionMetrics -> ()

Eq GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

(==) :: GetJourneyExecutionMetrics -> GetJourneyExecutionMetrics -> Bool

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

Hashable GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

hashWithSalt :: Int -> GetJourneyExecutionMetrics -> Int

hash :: GetJourneyExecutionMetrics -> Int

type AWSResponse GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

type AWSResponse GetJourneyExecutionMetrics = GetJourneyExecutionMetricsResponse

type Rep GetJourneyExecutionMetrics

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

type Rep GetJourneyExecutionMetrics = D1 ('MetaData "GetJourneyExecutionMetrics" "Amazonka.Pinpoint.GetJourneyExecutionMetrics" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" '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))))

newGetJourneyExecutionMetrics

Arguments

:: Text

GetJourneyExecutionMetrics

-> Text

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:

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.

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

GetJourneyExecutionMetrics, getJourneyExecutionMetrics_journeyId - The unique identifier for the journey.

Request Lenses

getJourneyExecutionMetrics_nextToken :: Lens' GetJourneyExecutionMetrics (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.

getJourneyExecutionMetrics_pageSize :: Lens' GetJourneyExecutionMetrics (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.

getJourneyExecutionMetrics_applicationId :: Lens' GetJourneyExecutionMetrics Text

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

getJourneyExecutionMetrics_journeyId :: Lens' GetJourneyExecutionMetrics Text

The unique identifier for the journey.

Destructuring the Response

data GetJourneyExecutionMetricsResponse

See: newGetJourneyExecutionMetricsResponse smart constructor.

Constructors

GetJourneyExecutionMetricsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• journeyExecutionMetricsResponse :: JourneyExecutionMetricsResponse

Instances

Generic GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Associated Types

type Rep GetJourneyExecutionMetricsResponse :: Type -> Type

Methods

from :: GetJourneyExecutionMetricsResponse -> Rep GetJourneyExecutionMetricsResponse x

to :: Rep GetJourneyExecutionMetricsResponse x -> GetJourneyExecutionMetricsResponse

Read GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

readsPrec :: Int -> ReadS GetJourneyExecutionMetricsResponse

readList :: ReadS [GetJourneyExecutionMetricsResponse]

readPrec :: ReadPrec GetJourneyExecutionMetricsResponse

readListPrec :: ReadPrec [GetJourneyExecutionMetricsResponse]

Show GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

showsPrec :: Int -> GetJourneyExecutionMetricsResponse -> ShowS

show :: GetJourneyExecutionMetricsResponse -> String

showList :: [GetJourneyExecutionMetricsResponse] -> ShowS

NFData GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

rnf :: GetJourneyExecutionMetricsResponse -> ()

Eq GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

Methods

(==) :: GetJourneyExecutionMetricsResponse -> GetJourneyExecutionMetricsResponse -> Bool

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

type Rep GetJourneyExecutionMetricsResponse

Defined in Amazonka.Pinpoint.GetJourneyExecutionMetrics

type Rep GetJourneyExecutionMetricsResponse = D1 ('MetaData "GetJourneyExecutionMetricsResponse" "Amazonka.Pinpoint.GetJourneyExecutionMetrics" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" '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

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

The response's http status code.

getJourneyExecutionMetricsResponse_journeyExecutionMetricsResponse :: Lens' GetJourneyExecutionMetricsResponse JourneyExecutionMetricsResponse

Undocumented member.